atkmm 2.28.3
|
The ATK interface provided by UI components which occupy a physical area on the screen. More...
#include <atkmm/component.h>
Public Member Functions | |
Component (Component && src) noexcept | |
Component & | operator= (Component && src) noexcept |
~Component () noexcept override | |
AtkComponent * | gobj () |
Provides access to the underlying C GObject. More... | |
const AtkComponent * | gobj () const |
Provides access to the underlying C GObject. More... | |
guint | add_focus_handler (AtkFocusHandler handler) |
Add the specified handler to the set of functions to be called when this object receives focus events (in or out). More... | |
bool | contains (int x, int y, CoordType coord_type) const |
Checks whether the specified point is within the extent of the component. More... | |
Glib::RefPtr< Atk::Object > | get_accessible_at_point (int x, int y, CoordType coord_type) |
Gets a reference to the accessible child, if one exists, at the coordinate point specified by x and y. More... | |
void | get_extents (int & x, int & y, int & width, int & height, CoordType coord_type) const |
Gets the rectangle which gives the extent of the component. More... | |
void | get_position (int & x, int & y, CoordType coord_type) const |
Gets the position of component in the form of a point specifying component's top-left corner. More... | |
void | get_size (int & width, int & height) const |
Gets the size of the component in terms of width and height. More... | |
Layer | get_layer () const |
Gets the layer of the component. More... | |
int | get_mdi_zorder () const |
Gets the zorder of the component. More... | |
bool | grab_focus () |
Grabs focus for this component. More... | |
void | remove_focus_handler (guint handler_id) |
Remove the handler specified by handler_id from the list of functions to be executed when this object receives focus events (in or out). More... | |
bool | set_extents (int x, int y, int width, int height, CoordType coord_type) |
Sets the extents of component. More... | |
bool | set_position (int x, int y, CoordType coord_type) |
Sets the postition of component. More... | |
bool | set_size (int width, int height) |
Set the size of the component in terms of width and height. More... | |
Static Public Member Functions | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
Protected Member Functions | |
Component () | |
You should derive from this class to use it. More... | |
virtual guint | add_focus_handler_vfunc (AtkFocusHandler handler) |
virtual bool | contains_vfunc (int x, int y, CoordType coord_type) const |
virtual Glib::RefPtr< Atk::Object > | get_accessible_at_point_vfunc (int x, int y, CoordType coord_type) |
virtual void | get_extents_vfunc (int & x, int & y, int & width, int & height, CoordType coord_type) const |
virtual void | get_position_vfunc (int & x, int & y, CoordType coord_type) const |
virtual void | get_size_vfunc (int & width, int & height) const |
virtual Layer | get_layer_vfunc () const |
virtual int | get_mdi_zorder_vfunc () const |
virtual bool | grab_focus_vfunc () |
virtual void | remove_focus_handler_vfunc (guint handler_id) |
virtual bool | set_extents_vfunc (int x, int y, int width, int height, CoordType coord_type) |
virtual bool | set_position_vfunc (int x, int y, CoordType coord_type) |
virtual bool | set_size_vfunc (int width, int height) |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Atk::Component > | wrap (AtkComponent * object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
The ATK interface provided by UI components which occupy a physical area on the screen.
This 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 Atk::Component implementations provided for their corresponding Atk::Object 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 Atk::Text.
|
protected |
You should derive from this class to use it.
|
noexcept |
|
overridenoexcept |
guint Atk::Component::add_focus_handler | ( | AtkFocusHandler | handler | ) |
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
Deprecated: 2.9.4: If you need to track when an object gains or lose the focus, use the Atk::Object::signal_state_change() "focused" notification instead.
handler | The Atk::FocusHandler to be attached to component. |
|
protectedvirtual |
|
static |
bool Atk::Component::contains | ( | int | x, |
int | y, | ||
CoordType | coord_type | ||
) | const |
Checks whether the specified point is within the extent of the component.
Toolkit implementor note: ATK provides a default implementation for this virtual method. In general there are little reason to re-implement it.
x | X coordinate. |
y | Y coordinate. |
coord_type | Specifies whether the coordinates are relative to the screen or to the components top level window. |
true
or false
indicating whether the specified point is within the extent of the component or not.
|
protectedvirtual |
Glib::RefPtr< Atk::Object > Atk::Component::get_accessible_at_point | ( | int | x, |
int | y, | ||
CoordType | coord_type | ||
) |
Gets a reference to the accessible child, if one exists, at the coordinate point specified by x and y.
x | X coordinate. |
y | Y coordinate. |
coord_type | Specifies whether the coordinates are relative to the screen or to the components top level window. |
|
protectedvirtual |
void Atk::Component::get_extents | ( | int & | x, |
int & | y, | ||
int & | width, | ||
int & | height, | ||
CoordType | coord_type | ||
) | const |
Gets the rectangle which gives the extent of the component.
x | Address of int to put x coordinate. |
y | Address of int to put y coordinate. |
width | Address of int to put width. |
height | Address of int to put height. |
coord_type | Specifies whether the coordinates are relative to the screen or to the components top level window. |
|
protectedvirtual |
Layer Atk::Component::get_layer | ( | ) | const |
Gets the layer of the component.
|
protectedvirtual |
int Atk::Component::get_mdi_zorder | ( | ) | const |
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.
int
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.
|
protectedvirtual |
void Atk::Component::get_position | ( | int & | x, |
int & | y, | ||
CoordType | coord_type | ||
) | const |
Gets the position of component in the form of a point specifying component's top-left corner.
Deprecated: Since 2.12. Use get_extents() instead.
x | Address of int to put x coordinate position. |
y | Address of int to put y coordinate position. |
coord_type | Specifies whether the coordinates are relative to the screen or to the components top level window. |
|
protectedvirtual |
void Atk::Component::get_size | ( | int & | width, |
int & | height | ||
) | const |
Gets the size of the component in terms of width and height.
Deprecated: Since 2.12. Use get_extents() instead.
width | Address of int to put width of component. |
height | Address of int to put height of component. |
|
protectedvirtual |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
bool Atk::Component::grab_focus | ( | ) |
Grabs focus for this component.
true
if successful, false
otherwise.
|
protectedvirtual |
void Atk::Component::remove_focus_handler | ( | guint | handler_id | ) |
Remove the handler specified by handler_id from the list of functions to be executed when this object receives focus events (in or out).
Deprecated: 2.9.4: If you need to track when an object gains or lose the focus, use the Atk::Object::signal_state_change() "focused" notification instead.
handler_id | The handler id of the focus handler to be removed from component. |
|
protectedvirtual |
bool Atk::Component::set_extents | ( | int | x, |
int | y, | ||
int | width, | ||
int | height, | ||
CoordType | coord_type | ||
) |
Sets the extents of component.
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. |
true
or false
whether the extents were set or not.
|
protectedvirtual |
bool Atk::Component::set_position | ( | int | x, |
int | y, | ||
CoordType | coord_type | ||
) |
Sets the postition of component.
x | X coordinate. |
y | Y coordinate. |
coord_type | Specifies whether the coordinates are relative to the screen or to the components top level window. |
true
or false
whether or not the position was set or not.
|
protectedvirtual |
bool Atk::Component::set_size | ( | int | width, |
int | height | ||
) |
Set the size of the component in terms of width and height.
width | Width to set for component. |
height | Height to set for component. |
true
or false
whether the size was set or not.
|
protectedvirtual |
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |