1.67.5 Get methods

graphical <-absolute_position: [device] -> point

Returns a point object indicating the position of the top-left corner of the graphical in the coordinate system of the argument device (or window).

The position relative to the screen may be found using graphical<-display_position. See also graphical<-position and graphical<-area.

Defaults: When device is omited, returns the absolute position relative to the top-most device. If the graphical is displayed, this is the window in which the graphical is displayed.

Diagnostics: Fails silently if device is specified and graphical is not displayed on this device.

See also

- graphical<-position
- graphical<-display_position
- graphical<-absolute_y
- graphical<-absolute_x

graphical <-absolute_x: [device] -> int

X coordinate of graphical in coordinate system of device. See graphical<-absolute_position.

See also

graphical<-absolute_position

graphical <-absolute_y: [device] -> int

Y coordinate of graphical in coordinate system of device. See graphical<-absolute_position.

See also

graphical<-absolute_position

graphical <-alignment: -> name

Dialog_item integration. See graphical->alignment and dialog_item->alignment for details.

graphical <-all_recognisers: create=[bool] -> chain

Inherits description from: object<-all_attributes

graphical <-auto_label_align: -> bool

graphical <-auto_value_align: -> bool

graphical <-reference: -> point

graphical <-auto_align: -> bool

graphical->auto_align is for the integration with class dialog_item. It associates an object->attribute auto_align with the specified value. graphical<-auto_align returns the value of this attribute if present. Otherwise @on if one of the attributes graphical<-above, graphical<-below, graphical<-left, graphical<-right exists and @off otherwise.

graphical <-bottom_side: -> int

Y-coordinate of the bottom-side of the graphical in the coordinate system of its device. With positive height, this is graphical<-y + graphical<-height. With negative height, this is graphical<-y.

See also

- graphical<-top_side
- graphical<-right_side
- graphical<-left_side

graphical <-center: -> point

@see graphical<-center_y @see graphical<-center_x

graphical <-center_x: -> int

@see graphical<-center

graphical <-center_y: -> int

@see graphical<-center

graphical <-common_device: with=graphical -> device

Graphical devices may be used to create complex diagrams by combining simple and other complex diagrams (see class device). This method locates the most local device that displays both the receiver and the argument graphical.

graphical<-common_device is used internally to determine the device on which to draw connections between graphicals that are not displayed on the same device.

Diagnostics: Fails (silently) if no such device can be found. Note that this method always succeeds if both graphicals are displayed in the same window and always fails if they are displayed in different windows.

See also

- class connection
- class device

graphical <-connected: to=[graphical], link=[link], to_kind=[name], from_kind=[name] -> connection

Find specified connection object. See graphical->connected for details. If there are multiple connections matching the search the first one is returned. See also graphical<-connections.

This method may be redefined to hook the behaviour of graphical->layout.

graphical <-connections: to=[graphical], link=[link], from_kind=[name], to_kind=[name] -> chain

Compute a new chain with all connections of graphical. The arguments are:

to:	Graphical at other side
link:	Link that must be in the connection
from_kind:	Name of the handle at the from-side
to_kind:	Name of the handle at the to-side.

Fails if there are no connections.

Defaults: Omitted or default arguments imply any value is legal.

See also

- graphical<-network
- graphical->connected

graphical <-contained_in: -> device|node

Device this graphical is displayed on when not @nil. If the device is a tree object, it will return the associated node using graphical<-node.

Diagnostics: Fails if graphical<-device equals @nil.

See also

- tree<-contains
- graphical<-node

graphical <-convert: object -> graphical

General object are converted into graphicals by invoking graphical<-image on the object. This simplifies manipulation of non-graphical objects that manipulate a graphical (such as class node).

See also

node-image

graphical <-corner: -> point

New point defined as:

point(<-x + <-width, <-y + <-height)

See also

- graphical->corner
- graphical<-corner_y

graphical <-corner_x: -> int

X-coordinate of the corner, defined as

<-x + <-width.

See also

graphical<-corner_y

graphical <-corner_y: -> int

Y-coordinate of the corner, defined as

<-y + <-height

See also

- graphical<-corner
- graphical<-corner_x

graphical <-display: -> display

Display on which the graphical is displayed. Useful when using multiple displays (see class display).

Diagnostics: Fails (silently) if the graphical is not displayed (indirectly) on a window.

See also

graphical<-window

graphical <-display_colour: -> colour|pixmap

Return the colour in which the graphical is actually displayed. If the variable graphical<-colour equals @default, this is the graphical<-display_colour of the graphical's device. Otherwise it is the value of the graphical<-colour variable.

If the graphical is displayed, this will always return a colour. Otherwise this method fails if neither the graphical, nor its device specify the colour.

See also

- window->colour
- graphical->colour

graphical <-display_position: -> point

Determines the position of the top-left corner of the graphical relative to the display. Sometimes use to determine the position of a new (prompter) window. Note that the position of the current event, relative to the display may be found using

get(@event, position, @display, Point)

See event<-position and @event. See also graphical<-position and graphical<-absolute_position.

Diagnostics: Fails if graphical is not related to a window

Bugs: Yields incorrect results if the window is not actually displayed on the screen.

See also

graphical<-absolute_position

graphical <-distance: graphical -> int

Invokes area<-distance using the areas of both graphicals.

Bugs: Silently assumes that both graphicals are displayed on the same device.

See also

- graphical<-distance_y
- graphical<-distance_x
- area<-distance

graphical <-distance_x: graphical -> int

Yields an integer representing the distance between the graphicals in X-direction. Yields 0 if both areas overlap in X-direction.

See also

- area<-distance_x
- graphical<-distance_y
- graphical<-distance

graphical <-distance_y: graphical -> int

@see graphical<-distance_x @see graphical<-distance

graphical <-frame: -> frame

Frame on which the graphical is displayed.

Frames are commonly used to represent a tool of an application (or an entire application). This method provides an easy way to find the application object from some deep-down part of it.

Diagnostics: Fails silently if the graphical is not displayed.

See also

- graphical<-window
- frame<-frame

graphical <-handle: name -> handle

Returns handle object with specified name. First scans‘graphical -handles’followed by graphical<-handles of the graphical's class. The first matching handle is returned.

Diagnostics: Fails silently when there is no matching handle.

See also

- graphical<-handle_position
- graphical<-handles
- graphical->handle

graphical <-handle_position: name=name, device=[device] -> point

Determine position of the named handle in the coordinate system of the given device. The default device is the graphicals graphical<-device.

Defaults: When no device is specified, the coordinate system of the graphical's device is used.

Diagnostics: Fails if there is no such handle or the graphical is not displayed on the given device.

See also

- handle<-y
- handle<-x
- graphical<-handle

graphical <-handles: near=[point], kind=[name], distance=[int] -> chain

New chain with all handles (both from -handles as from class<-handles that are within distance pixels from the given point and have the given kind. Fails if no handles match the criterion.

See also

graphical<-handle

graphical <-height: -> int

Height in pixels. Note that for some graphicals this value may be negative, indication the top-side is above rather than below the y-position.

graphical <-is_displayed: [device] -> bool

Tests whether graphical is actually displayed, assuming device is displayed.

Defaults: When device is @default, succeeds if graphical and all deviced above it have graphical<-displayed: @on.

See also

graphical-displayed

graphical <-left_side: -> int

@see graphical<-bottom_side

graphical <-network: link=[link], from_kind=[name], to_kind=[name] -> chain

Computes a new chain, holding the receiving graphical and all graphicals that can be reached from it by following the specified types of connections:

link

When specified, follow only connections of this link

from , to

When specified, follow only links that are connected to the named handles

This method is save on cyclic graphs. See also graphical->layout.

See also

- graphical->layout
- graphical<-connections

graphical <-node: -> node

Return the node object that has node<-image equal to this graphical if the graphical is controlled by a node of a tree object. See also graphical<-contained_in.

Diagnostics: Fails silently when the node cannot be found.

Bugs: Only works if the node is attached to a tree and actually displayed. It checks whether the graphical's device is a tree and then uses‘node graphical<-find_node’to find the node object belonging to this graphical.

See also

- graphical<-contained_in
- node<-find_node
- tree->event
- node-image
- class node

graphical <-orientation: -> {north_west,south_west,north_east,south_east}

Inherits description from: graphical->orientation

See also

graphical->orientation

graphical <-position: -> point

@see graphical<-absolute_position

graphical <-right_side: -> int

@see graphical<-bottom_side

graphical <-size: -> size

New size object created from graphical<-height and graphical<-width of the graphical's area. Either or both of graphical<-width and graphical<-height may be negative. See graphical<->orientation.

See also

graphical->orientation

graphical <-top_side: -> int

@see graphical<-bottom_side

graphical <-window: -> window

Window on which the graphical is displayed. Yields itself if graphical is a window.

Diagnostics: Fails silently when graphical is not displayed on a window.

See also

- graphical<-display
- graphical<-frame