Libraries:Gtk:Atk:Component
Types
T
ParentT
Constants
InterfaceInfo : Std.Object.T
Nil : T
Functions
GetType() : Gtk.GObject.Type.T
Methods
:AddFocusHandler(self @ T, handler @ Std.Function.T) : Std.Integer.SmallT
Add the specified handler to the set of functions to be called when this object receives focus events (in or out). If the handler is already added it is not added again
component | The T to attach the handler to |
handler | The AtkFocusHandler to be attached to component |
Returns | a handler id which can be used in atk_component_remove_focus_handler or zero if the handler was already added. |
:AddFocusHandler(_ @ ParentT, _ @ Std.Function.T)
:BoundsChanged(_ @ ParentT, _ @ Gtk.Atk.Rectangle.T)
:Contains(self @ T, x @ Std.Integer.SmallT, y @ Std.Integer.SmallT, coord_type @ Gtk.Atk.CoordType.T) : Std.Symbol.T
Checks whether the specified point is within the extent of the component.
component | the T |
x | x coordinate |
y | y coordinate |
coord_type | specifies whether the coordinates are relative to the screen or to the components top level window |
Returns | TRUE or FALSE indicating whether the specified point is within the extent of the component or not |
:Contains(_ @ ParentT, _ @ Std.Integer.SmallT, _ @ Std.Integer.SmallT, _ @ Gtk.Atk.CoordType.T)
:GetAlpha(self @ T) : Std.Real.T
Returns the alpha value (i.e. the opacity) for this component, on a scale from 0 (fully transparent) to 1.0 (fully opaque).
component | an T |
Returns | An alpha value from 0 to 1.0, inclusive. |
:GetAlpha(_ @ ParentT)
:GetExtents(self @ T, x @ Std.Object.T, y @ Std.Object.T, width @ Std.Object.T, height @ Std.Object.T, coord_type @ Gtk.Atk.CoordType.T) : Std.Object.T
Gets the rectangle which gives the extent of the component.
component | an T |
x | address of gint to put x coordinate |
y | address of gint to put y coordinate |
width | address of gint to put width |
height | address of gint to put height |
coord_type | specifies whether the coordinates are relative to the screen or to the components top level window |
:GetExtents(_ @ ParentT, _ @ Std.Object.T, _ @ Std.Object.T, _ @ Std.Object.T, _ @ Std.Object.T, _ @ Gtk.Atk.CoordType.T)
:GetLayer(self @ T) : Gtk.Atk.Layer.T
Gets the layer of the component.
component | an T |
Returns | an Gtk.Atk.Layer.T which is the layer of the component |
:GetLayer(_ @ ParentT)
:GetMdiZorder(self @ T) : Std.Integer.SmallT
Gets the zorder of the component. The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.
component | an T |
Returns | a gint which is the zorder of the component, i.e. the depth at which the component is shown in relation to other components in the same container. |
:GetMdiZorder(_ @ ParentT)
:GetPosition(self @ T, x @ Std.Object.T, y @ Std.Object.T, coord_type @ Gtk.Atk.CoordType.T) : Std.Object.T
Gets the position of component in the form of a point specifying component's top-left corner.
component | an T |
x | address of gint to put x coordinate position |
y | address of gint to put y coordinate position |
coord_type | specifies whether the coordinates are relative to the screen or to the components top level window |
:GetPosition(_ @ ParentT, _ @ Std.Object.T, _ @ Std.Object.T, _ @ Gtk.Atk.CoordType.T)
:GetSize(self @ T, width @ Std.Object.T, height @ Std.Object.T) : Std.Object.T
Gets the size of the component in terms of width and height.
component | an T |
width | address of gint to put width of component |
height | address of gint to put height of component |
:GetSize(_ @ ParentT, _ @ Std.Object.T, _ @ Std.Object.T)
:GrabFocus(self @ T) : Std.Symbol.T
:GrabFocus(_ @ ParentT)
:RefAccessibleAtPoint(self @ T, x @ Std.Integer.SmallT, y @ Std.Integer.SmallT, coord_type @ Gtk.Atk.CoordType.T) : Gtk.Atk.Object.T
Gets a reference to the accessible child, if one exists, at the coordinate point specified by x and y.
component | the T |
x | x coordinate |
y | y coordinate |
coord_type | specifies whether the coordinates are relative to the screen or to the components top level window |
Returns | a reference to the accessible child, if one exists. [transfer full] |
:RefAccessibleAtPoint(_ @ ParentT, _ @ Std.Integer.SmallT, _ @ Std.Integer.SmallT, _ @ Gtk.Atk.CoordType.T)
:RemoveFocusHandler(self @ T, handler_id @ Std.Integer.SmallT) : Std.Object.T
Remove the handler specified by handler_id from the list of functions to be executed when this object receives focus events (in or out).
component | the T to remove the focus handler from |
handler_id | the handler id of the focus handler to be removed from component |
:RemoveFocusHandler(_ @ ParentT, _ @ Std.Integer.SmallT)
:SetExtents(self @ T, x @ Std.Integer.SmallT, y @ Std.Integer.SmallT, width @ Std.Integer.SmallT, height @ Std.Integer.SmallT, coord_type @ Gtk.Atk.CoordType.T) : Std.Symbol.T
Sets the extents of component.
component | an T |
x | x coordinate |
y | y coordinate |
width | width to set for component |
height | height to set for component |
coord_type | specifies whether the coordinates are relative to the screen or to the components top level window |
Returns | TRUE or FALSE whether the extents were set or not |
:SetExtents(_ @ ParentT, _ @ Std.Integer.SmallT, _ @ Std.Integer.SmallT, _ @ Std.Integer.SmallT, _ @ Std.Integer.SmallT, _ @ Gtk.Atk.CoordType.T)
:SetPosition(self @ T, x @ Std.Integer.SmallT, y @ Std.Integer.SmallT, coord_type @ Gtk.Atk.CoordType.T) : Std.Symbol.T
Sets the postition of component.
component | an T |
x | x coordinate |
y | y coordinate |
coord_type | specifies whether the coordinates are relative to the screen or to the components top level window |
Returns | TRUE or FALSE whether or not the position was set or not |
:SetPosition(_ @ ParentT, _ @ Std.Integer.SmallT, _ @ Std.Integer.SmallT, _ @ Gtk.Atk.CoordType.T)
:SetSize(self @ T, width @ Std.Integer.SmallT, height @ Std.Integer.SmallT) : Std.Symbol.T
Set the size of the component in terms of width and height.
component | an T |
width | width to set for component |
height | height to set for component |
Returns | TRUE or FALSE whether the size was set or not |
T should be implemented by most if not all UI elements with an actual on-screen presence, i.e. components which can be said to have a screen-coordinate bounding box. Virtually all widgets will need to have T implementations provided for their corresponding Gtk.Atk.Object.T class. In short, only UI elements which are *not* GUI elements will omit this ATK interface.
A possible exception might be textual information with a transparent background, in which case text glyph bounding box information is provided by Gtk.Atk.Text.T.