atkmm 2.36.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. | |
const AtkComponent * | gobj () const |
Provides access to the underlying C GObject. | |
bool | contains (int x, int y, CoordType coord_type) const |
Checks whether the specified point is within the extent of the component. | |
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. | |
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. | |
Layer | get_layer () const |
Gets the layer of the component. | |
int | get_mdi_zorder () const |
Gets the zorder of the component. | |
bool | grab_focus () |
Grabs focus for this component. | |
bool | set_extents (int x, int y, int width, int height, CoordType coord_type) |
Sets the extents of component. | |
bool | set_position (int x, int y, CoordType coord_type) |
Sets the position of component. | |
bool | set_size (int width, int height) |
Set the size of the component in terms of width and height. | |
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. | |
Protected Member Functions | |
Component () | |
You should derive from this class to use it. | |
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 Layer | get_layer_vfunc () const |
virtual int | get_mdi_zorder_vfunc () const |
virtual bool | grab_focus_vfunc () |
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 Symbols | |
(Note that these are not member symbols.) | |
Glib::RefPtr< Atk::Component > | wrap (AtkComponent * object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
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 |
|
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.
If the extent can not be obtained (e.g. a non-embedded plug or missing support), all of x, y, width, height are set to -1.
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 |
|
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 |
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 position of component.
Contrary to atk_component_scroll_to, this does not trigger any scrolling, this just moves component in its parent.
x | X coordinate. |
y | Y coordinate. |
coord_type | Specifies whether the coordinates are relative to the screen or to the component's 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. |