A widget used for drawing with OpenGL. More...
#include <gtkmm/glarea.h>
Inheritance diagram for Gtk::GLArea:
Public Member Functions | |
| GLArea (GLArea && src) noexcept | |
| GLArea & | operator= (GLArea && src) noexcept |
| GLArea (const GLArea &)=delete | |
| GLArea & | operator= (const GLArea &)=delete |
| ~GLArea () noexcept override | |
| GtkGLArea * | gobj () |
| Provides access to the underlying C GObject. More... | |
| const GtkGLArea * | gobj () const |
| Provides access to the underlying C GObject. More... | |
| GLArea () | |
| Glib::RefPtr< Gdk::GLContext > | get_context () |
| Retrieves the Gdk::GLContext used by area. More... | |
| Glib::RefPtr< const Gdk::GLContext > | get_context () const |
| Retrieves the Gdk::GLContext used by area. More... | |
| void | make_current () |
| Ensures that the Gdk::GLContext used by area is associated with the Gtk::GLArea. More... | |
| void | queue_render () |
| Marks the currently rendered data (if any) as invalid, and queues a redraw of the widget, ensuring that the Gtk::GLArea::signal_render() signal is emitted during the draw. More... | |
| void | attach_buffers () |
| Ensures that the area framebuffer object is made the current draw and read target, and that all the required buffers for the area are created and bound to the frambuffer. More... | |
| bool | has_error () const |
| Check if any error is currently set on this area. More... | |
| void | throw_if_error () const |
| Will throw the correct Glib::Error subclass if any is currently set on this area. More... | |
| void | set_error (const Glib::Error & error) |
| Sets an error on the area which will be shown instead of GL rendering. More... | |
| void | unset_error () |
| Clears any previous set error on this area made with set_error(). More... | |
| bool | get_has_alpha () const |
| Returns whether the area has an alpha component. More... | |
| void | set_has_alpha (bool has_alpha=true) |
If has_alpha is true the buffer allocated by the widget will have an alpha channel component, and when rendering to the window the result will be composited over whatever is below the widget. More... | |
| bool | get_has_depth_buffer () const |
| Returns whether the area has a depth buffer. More... | |
| void | set_has_depth_buffer (bool has_depth_buffer=true) |
If has_depth_buffer is true the widget will allocate and enable a depth buffer for the target framebuffer. More... | |
| bool | get_has_stencil_buffer () const |
| Returns whether the area has a stencil buffer. More... | |
| void | set_has_stencil_buffer (bool has_stencil_buffer=true) |
If has_stencil_buffer is true the widget will allocate and enable a stencil buffer for the target framebuffer. More... | |
| bool | get_auto_render () const |
| Returns whether the area is in auto render mode or not. More... | |
| void | set_auto_render (bool auto_render=true) |
If auto_render is true the Gtk::GLArea::signal_render() signal will be emitted every time the widget draws. More... | |
| void | get_required_version (int & major, int & minor) const |
| Retrieves the required version of OpenGL set using gtk_gl_area_set_required_version(). More... | |
| void | set_required_version (int major, int minor) |
| Sets the required version of OpenGL to be used when creating the context for the widget. More... | |
| bool | get_use_es () const |
| Retrieves the value set by gtk_gl_area_set_use_es(). More... | |
| void | set_use_es (bool use_es=true) |
| Sets whether the area should create an OpenGL or an OpenGL ES context. More... | |
| Glib::PropertyProxy< bool > | property_auto_render () |
If set to true the Gtk::GLArea::signal_render() signal will be emitted every time the widget draws. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_auto_render () const |
If set to true the Gtk::GLArea::signal_render() signal will be emitted every time the widget draws. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::GLContext > > | property_context () const |
| The Gdk::GLContext used by the Gtk::GLArea widget. More... | |
| Glib::PropertyProxy< bool > | property_has_alpha () |
If set to true the buffer allocated by the widget will have an alpha channel component, and when rendering to the window the result will be composited over whatever is below the widget. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_has_alpha () const |
If set to true the buffer allocated by the widget will have an alpha channel component, and when rendering to the window the result will be composited over whatever is below the widget. More... | |
| Glib::PropertyProxy< bool > | property_has_depth_buffer () |
If set to true the widget will allocate and enable a depth buffer for the target framebuffer. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_has_depth_buffer () const |
If set to true the widget will allocate and enable a depth buffer for the target framebuffer. More... | |
| Glib::PropertyProxy< bool > | property_has_stencil_buffer () |
If set to true the widget will allocate and enable a stencil buffer for the target framebuffer. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_has_stencil_buffer () const |
If set to true the widget will allocate and enable a stencil buffer for the target framebuffer. More... | |
| Glib::PropertyProxy< bool > | property_use_es () |
If set to true the widget will try to create a Gdk::GLContext using OpenGL ES instead of OpenGL. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_use_es () const |
If set to true the widget will try to create a Gdk::GLContext using OpenGL ES instead of OpenGL. More... | |
| Glib::SignalProxy< Glib::RefPtr< Gdk::GLContext > > | signal_create_context () |
| Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::GLContext > & > | signal_render () |
| Glib::SignalProxy< void, int, int > | signal_resize () |
 Public Member Functions inherited from Gtk::Widget | |
| Widget (Widget && src) noexcept | |
| Widget & | operator= (Widget && src) noexcept |
| Widget (const Widget &)=delete | |
| Widget & | operator= (const Widget &)=delete |
| ~Widget () noexcept override | |
| Destroys the widget. More... | |
| GtkWidget * | gobj () |
| Provides access to the underlying C GObject. More... | |
| const GtkWidget * | gobj () const |
| Provides access to the underlying C GObject. More... | |
| void | show () |
| Flags a widget to be displayed. More... | |
| void | show_now () |
| Shows a widget. More... | |
| void | hide () |
| Reverses the effects of show(), causing the widget to be hidden (invisible to the user). More... | |
| void | show_all () |
| Recursively shows a widget, and any child widgets (if the widget is a container). More... | |
| void | queue_draw () |
| Equivalent to calling queue_draw_area() for the entire area of a widget. More... | |
| void | queue_draw_area (int x, int y, int width, int height) |
| Convenience function that calls queue_draw_region() on the region created from the given coordinates. More... | |
| void | queue_draw_region (const ::Cairo::RefPtr< const ::Cairo::Region > & region) |
| Invalidates the area of widget defined by region by calling gdk_window_invalidate_region() on the widget’s window and all its child windows. More... | |
| void | queue_resize () |
| This function is only for use in widget implementations. More... | |
| void | queue_allocate () |
| This function is only for use in widget implementations. More... | |
| void | size_allocate (const Allocation & allocation) |
| This function is only used by Gtk::Container subclasses, to assign a size and position to their child widgets. More... | |
| void | size_allocate (const Allocation & allocation, int baseline) |
| This function is only used by Gtk::Container subclasses, to assign a size, position and (optionally) baseline to their child widgets. More... | |
| SizeRequestMode | get_request_mode () const |
| Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More... | |
| void | get_preferred_width (int & minimum_width, int & natural_width) const |
| Retrieves a widget’s initial minimum and natural width. More... | |
| void | get_preferred_height_for_width (int width, int & minimum_height, int & natural_height) const |
| Retrieves a widget’s minimum and natural height if it would be given the specified width. More... | |
| void | get_preferred_height_for_width (int width, int & minimum_height, int & natural_height, int & minimum_baseline, int & natural_baseline) const |
| Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given the specified width, or the default height if width is -1. More... | |
| void | get_preferred_height (int & minimum_height, int & natural_height) const |
| Retrieves a widget’s initial minimum and natural height. More... | |
| void | get_preferred_width_for_height (int height, int & minimum_width, int & natural_width) const |
| Retrieves a widget’s minimum and natural width if it would be given the specified height. More... | |
| void | get_preferred_size (Requisition & minimum_size, Requisition & natural_size) const |
| Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. More... | |
| void | add_accelerator (const Glib::ustring & accel_signal, const Glib::RefPtr< AccelGroup > & accel_group, guint accel_key, Gdk::ModifierType accel_mods, AccelFlags accel_flags) |
| Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated. More... | |
| bool | remove_accelerator (const Glib::RefPtr< AccelGroup > & accel_group, guint accel_key, Gdk::ModifierType accel_mods) |
| Removes an accelerator from widget, previously installed with add_accelerator(). More... | |
| void | set_accel_path (const Glib::ustring & accel_path, const Glib::RefPtr< AccelGroup > & accel_group) |
| Given an accelerator group, accel_group, and an accelerator path, accel_path, sets up an accelerator in accel_group so whenever the key binding that is defined for accel_path is pressed, widget will be activated. More... | |
| bool | mnemonic_activate (bool group_cycling) |
| Emits the Gtk::Widget::signal_mnemonic_activate() signal. More... | |
| bool | event (GdkEvent * gdk_event) |
| Rarely-used function. More... | |
| int | send_expose (GdkEvent * gdk_event) |
| Very rarely-used function. More... | |
| bool | send_focus_change (GdkEvent * gdk_event) |
| Sends the focus change gdk_event to widget. More... | |
| bool | activate () |
| For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More... | |
| void | reparent (Widget & new_parent) |
| Moves a widget from one Gtk::Container to another, handling reference count issues to avoid destroying the widget. More... | |
| bool | intersect (const Gdk::Rectangle & area) const |
| bool | intersect (const Gdk::Rectangle & area, Gdk::Rectangle & intersection) const |
Computes the intersection of a widget’s area and area, storing the intersection in intersection, and returns true if there was an intersection. More... | |
| ::Cairo::RefPtr< ::Cairo::Region > | region_intersect (const ::Cairo::RefPtr< ::Cairo::Region > & region) const |
| Computes the intersection of a widget’s area and region, returning the intersection. More... | |
| void | freeze_child_notify () |
| Stops emission of Gtk::Widget::signal_child_notify() signals on widget. More... | |
| void | child_notify (const Glib::ustring & child_property) |
| Emits a Gtk::Widget::signal_child_notify() signal for the [child property][child-properties] child_property on widget. More... | |
| void | thaw_child_notify () |
| Reverts the effect of a previous call to freeze_child_notify(). More... | |
| void | set_can_focus (bool can_focus=true) |
| Specifies whether widget can own the input focus. More... | |
| bool | get_can_focus () const |
| Determines whether widget can own the input focus. More... | |
| bool | has_focus () const |
| Determines if the widget has the global input focus. More... | |
| bool | is_focus () const |
| Determines if the widget is the focus widget within its toplevel. More... | |
| bool | has_visible_focus () const |
| Determines if the widget should show a visible indication that it has the global input focus. More... | |
| void | grab_focus () |
| Causes widget to have the keyboard focus for the Gtk::Window it's inside. More... | |
| void | set_focus_on_click (bool focus_on_click=true) |
| Sets whether the widget should grab focus when it is clicked with the mouse. More... | |
| bool | get_focus_on_click () const |
| Returns whether the widget should grab focus when it is clicked with the mouse. More... | |
| void | set_can_default (bool can_default=true) |
| Specifies whether widget can be a default widget. More... | |
| bool | get_can_default () const |
| Determines whether widget can be a default widget. More... | |
| bool | has_default () const |
| Determines whether widget is the current default widget within its toplevel. More... | |
| void | grab_default () |
| Causes widget to become the default widget. More... | |
| void | set_receives_default (bool receives_default=true) |
| Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More... | |
| bool | get_receives_default () const |
| Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More... | |
| bool | has_grab () const |
| Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse). More... | |
| bool | device_is_shadowed (const Glib::RefPtr< const Gdk::Device > & device) |
Returns true if device has been shadowed by a GTK+ device grab on another widget, so it would stop sending events to widget. More... | |
| void | add_modal_grab () |
| Block events to everything else than this widget and its children. More... | |
| void | remove_modal_grab () |
| Remove the modal grab of the widget in case it was previously grabbed. More... | |
| void | set_name (const Glib::ustring & name) |
| Widgets can be named, which allows you to refer to them from a CSS file. More... | |
| void | unset_name () |
| Glib::ustring | get_name () const |
| Retrieves the name of a widget. More... | |
| void | set_state (StateType state) |
| This function is for use in widget implementations. More... | |
| StateType | get_state () const |
| Returns the widget’s state. More... | |
| void | set_state_flags (StateFlags flags, bool clear=true) |
| This function is for use in widget implementations. More... | |
| void | unset_state_flags (StateFlags flags) |
| This function is for use in widget implementations. More... | |
| StateFlags | get_state_flags () const |
| Returns the widget state as a flag set. More... | |
| void | set_sensitive (bool sensitive=true) |
| Sets the sensitivity of a widget. More... | |
| bool | get_sensitive () const |
| Returns the widget’s sensitivity (in the sense of returning the value that has been set using set_sensitive()). More... | |
| bool | is_sensitive () const |
| Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive. More... | |
| void | set_visible (bool visible=true) |
| Sets the visibility state of widget. More... | |
| bool | get_visible () const |
| Determines whether the widget is visible. More... | |
| bool | is_visible () const |
| Determines whether the widget and all its parents are marked as visible. More... | |
| bool | get_has_window () const |
| Determines whether widget has a Gdk::Window of its own. More... | |
| bool | get_is_toplevel () const |
| Determines whether widget is a toplevel widget. More... | |
| bool | get_is_drawable () const |
| Determines whether widget can be drawn to. More... | |
| bool | get_realized () const |
| Determines whether widget is realized. More... | |
| bool | get_mapped () const |
| Whether the widget is mapped. More... | |
| void | set_app_paintable (bool app_paintable=true) |
| Sets whether the application intends to draw on the widget in an Gtk::Widget::signal_draw() handler. More... | |
| bool | get_app_paintable () const |
| Determines whether the application intends to draw on the widget in an Gtk::Widget::signal_draw() handler. More... | |
| void | set_double_buffered (bool double_buffered=true) |
| Widgets are double buffered by default; you can use this function to turn off the buffering. More... | |
| bool | get_double_buffered () const |
| Determines whether the widget is double buffered. More... | |
| void | set_redraw_on_allocate (bool redraw_on_allocate=true) |
| Sets whether the entire widget is queued for drawing when its size allocation changes. More... | |
| void | set_child_visible (bool visible=true) |
| Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with show(). More... | |
| bool | get_child_visible () const |
| Gets the value set with set_child_visible(). More... | |
| Glib::RefPtr< Gdk::Window > | get_window () |
Returns the widget’s window if it is realized, nullptr otherwise. More... | |
| Glib::RefPtr< const Gdk::Window > | get_window () const |
Returns the widget’s window if it is realized, nullptr otherwise. More... | |
| void | register_window (const Glib::RefPtr< Gdk::Window > & window) |
| Registers a Gdk::Window with the widget and sets it up so that the widget receives events for it. More... | |
| void | unregister_window (const Glib::RefPtr< Gdk::Window > & window) |
| Unregisters a Gdk::Window from the widget that was previously set up with register_window(). More... | |
| int | get_allocated_width () const |
| Returns the width that has currently been allocated to widget. More... | |
| int | get_allocated_height () const |
| Returns the height that has currently been allocated to widget. More... | |
| int | get_allocated_baseline () const |
| Returns the baseline that has currently been allocated to widget. More... | |
| void | get_allocated_size (Allocation & allocation, int & baseline) const |
| Retrieves the widget’s allocated size. More... | |
| Allocation | get_allocation () const |
| Retrieves the widget's location. More... | |
| void | set_allocation (const Allocation & allocation) |
| Sets the widget’s allocation. More... | |
| void | set_clip (const Allocation & clip) |
| Sets the widget’s clip. More... | |
| Allocation | get_clip () const |
| Retrieves the widget’s clip area. More... | |
| Container * | get_parent () |
| Returns the parent container of widget. More... | |
| const Container * | get_parent () const |
| Returns the parent container of widget. More... | |
| Glib::RefPtr< Gdk::Window > | get_parent_window () |
Gets widget’s parent window, or nullptr if it does not have one. More... | |
| Glib::RefPtr< const Gdk::Window > | get_parent_window () const |
Gets widget’s parent window, or nullptr if it does not have one. More... | |
| void | set_parent_window (const Glib::RefPtr< const Gdk::Window > & parent_window) |
| Sets a non default parent window for widget. More... | |
| bool | child_focus (DirectionType direction) |
| This function is used by custom widget implementations; if you're writing an app, you’d use grab_focus() to move the focus to a particular widget, and Gtk::Container::set_focus_chain() to change the focus tab order. More... | |
| bool | keynav_failed (DirectionType direction) |
| This function should be called whenever keyboard navigation within a single widget hits a boundary. More... | |
| void | error_bell () |
| Notifies the user about an input-related error on this widget. More... | |
| void | set_size_request (int width=-1, int height=-1) |
| Sets the minimum size of a widget; that is, the widget’s size request will be at least width by height. More... | |
| void | get_size_request (int & width, int & height) const |
| Gets the size request that was explicitly set for the widget using set_size_request(). More... | |
| void | set_events (Gdk::EventMask events) |
| Sets the event mask (see Gdk::EventMask) for a widget. More... | |
| void | add_events (Gdk::EventMask events) |
| Adds the events in the bitfield events to the event mask for widget. More... | |
| void | set_device_events (const Glib::RefPtr< const Gdk::Device > & device, Gdk::EventMask events) |
| Sets the device event mask (see Gdk::EventMask) for a widget. More... | |
| void | add_device_events (const Glib::RefPtr< const Gdk::Device > & device, Gdk::EventMask events) |
| Adds the device events in the bitfield events to the event mask for widget. More... | |
| void | set_opacity (double opacity) |
| Request the widget to be rendered partially transparent, with opacity 0 being fully transparent and 1 fully opaque. More... | |
| double | get_opacity () const |
| Fetches the requested opacity for this widget. More... | |
| void | set_device_enabled (const Glib::RefPtr< Gdk::Device > & device, bool enabled=true) |
| Enables or disables a Gdk::Device to interact with widget and all its children. More... | |
| bool | get_device_enabled (const Glib::RefPtr< const Gdk::Device > & device) const |
| Returns whether device can interact with widget and its children. More... | |
| Container * | get_toplevel () |
| This function returns the topmost widget in the container hierarchy widget is a part of. More... | |
| const Container * | get_toplevel () const |
| This function returns the topmost widget in the container hierarchy widget is a part of. More... | |
| Widget * | get_ancestor (GType widget_type) |
| Gets the first ancestor of widget with type widget_type. More... | |
| const Widget * | get_ancestor (GType widget_type) const |
| Gets the first ancestor of widget with type widget_type. More... | |
| Glib::RefPtr< Gdk::Visual > | get_visual () |
| Gets the visual that will be used to render widget. More... | |
| Glib::RefPtr< Gdk::Screen > | get_screen () |
| Get the Gdk::Screen from the toplevel window associated with this widget. More... | |
| Glib::RefPtr< const Gdk::Screen > | get_screen () const |
| Get the Gdk::Screen from the toplevel window associated with this widget. More... | |
| bool | has_screen () const |
| Checks whether there is a Gdk::Screen is associated with this widget. More... | |
| int | get_scale_factor () const |
| Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. More... | |
| Glib::RefPtr< Gdk::Display > | get_display () |
| Get the Gdk::Display for the toplevel window associated with this widget. More... | |
| Glib::RefPtr< const Gdk::Display > | get_display () const |
| Get the Gdk::Display for the toplevel window associated with this widget. More... | |
| Glib::RefPtr< Gdk::Window > | get_root_window () |
| Get the root window where this widget is located. More... | |
| Glib::RefPtr< const Gdk::Window > | get_root_window () const |
| Get the root window where this widget is located. More... | |
| Glib::RefPtr< Settings > | get_settings () |
| Gets the settings object holding the settings used for this widget. More... | |
| Glib::RefPtr< Clipboard > | get_clipboard (const Glib::ustring & selection) |
| Returns the clipboard object for the given selection to be used with widget. More... | |
| Glib::RefPtr< const Clipboard > | get_clipboard (const Glib::ustring & selection) const |
| Returns the clipboard object for the given selection to be used with widget. More... | |
| bool | get_hexpand () const |
| Gets whether the widget would like any available extra horizontal space. More... | |
| void | set_hexpand (bool expand=true) |
| Sets whether the widget would like any available extra horizontal space. More... | |
| bool | get_hexpand_set () const |
| Gets whether set_hexpand() has been used to explicitly set the expand flag on this widget. More... | |
| void | set_hexpand_set (bool set=true) |
| Sets whether the hexpand flag (see get_hexpand()) will be used. More... | |
| bool | get_vexpand () const |
| Gets whether the widget would like any available extra vertical space. More... | |
| void | set_vexpand (bool expand=true) |
| Sets whether the widget would like any available extra vertical space. More... | |
| bool | get_vexpand_set () const |
| Gets whether set_vexpand() has been used to explicitly set the expand flag on this widget. More... | |
| void | set_vexpand_set (bool set=true) |
| Sets whether the vexpand flag (see get_vexpand()) will be used. More... | |
| void | queue_compute_expand () |
| Mark widget as needing to recompute its expand flags. More... | |
| bool | compute_expand (Orientation orientation) |
| Computes whether a container should give this widget extra space when possible. More... | |
| bool | get_support_multidevice () const |
Returns true if widget is multiple pointer aware. More... | |
| void | set_support_multidevice (bool support_multidevice=true) |
| Enables or disables multiple pointer awareness. More... | |
| Glib::RefPtr< Atk::Object > | get_accessible () |
| Returns the accessible object that describes the widget to an assistive technology. More... | |
| Glib::RefPtr< const Atk::Object > | get_accessible () const |
| Returns the accessible object that describes the widget to an assistive technology. More... | |
| Align | get_halign () const |
| Gets the value of the Gtk::Widget::property_halign() property. More... | |
| void | set_halign (Align align) |
| Sets the horizontal alignment of widget. More... | |
| Align | get_valign () const |
| Gets the value of the Gtk::Widget::property_valign() property. More... | |
| Align | get_valign_with_baseline () const |
| Gets the value of the Gtk::Widget::property_valign() property, including Gtk::ALIGN_BASELINE. More... | |
| void | set_valign (Align align) |
| Sets the vertical alignment of widget. More... | |
| int | get_margin_left () const |
| Gets the value of the Gtk::Widget::property_margin_left() property. More... | |
| void | set_margin_left (int margin) |
| Sets the left margin of widget. More... | |
| int | get_margin_right () const |
| Gets the value of the Gtk::Widget::property_margin_right() property. More... | |
| void | set_margin_right (int margin) |
| Sets the right margin of widget. More... | |
| int | get_margin_start () const |
| Gets the value of the Gtk::Widget::property_margin_start() property. More... | |
| void | set_margin_start (int margin) |
| Sets the start margin of widget. More... | |
| int | get_margin_end () const |
| Gets the value of the Gtk::Widget::property_margin_end() property. More... | |
| void | set_margin_end (int margin) |
| Sets the end margin of widget. More... | |
| int | get_margin_top () const |
| Gets the value of the Gtk::Widget::property_margin_top() property. More... | |
| void | set_margin_top (int margin) |
| Sets the top margin of widget. More... | |
| int | get_margin_bottom () const |
| Gets the value of the Gtk::Widget::property_margin_bottom() property. More... | |
| void | set_margin_bottom (int margin) |
| Sets the bottom margin of widget. More... | |
| Gdk::EventMask | get_events () const |
| Returns the event mask (see Gdk::EventMask) for the widget. More... | |
| Gdk::EventMask | get_device_events (const Glib::RefPtr< const Gdk::Device > & device) const |
| Returns the events mask for the widget corresponding to an specific device. More... | |
| void | get_pointer (int & x, int & y) const |
| Obtains the location of the mouse pointer in widget coordinates. More... | |
| bool | is_ancestor (Widget & ancestor) const |
| Determines whether widget is somewhere inside ancestor, possibly with intermediate containers. More... | |
| bool | translate_coordinates (Widget & dest_widget, int src_x, int src_y, int & dest_x, int & dest_y) |
| Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More... | |
| void | override_color (const Gdk::RGBA & color, StateFlags state=STATE_FLAG_NORMAL) |
| Sets the color to use for a widget. More... | |
| void | unset_color (StateFlags state=STATE_FLAG_NORMAL) |
| Undoes the effect of previous calls to override_color(). More... | |
| void | override_background_color (const Gdk::RGBA & color, StateFlags state=STATE_FLAG_NORMAL) |
| Sets the background color to use for a widget. More... | |
| void | unset_background_color (StateFlags state=STATE_FLAG_NORMAL) |
| Undoes the effect of previous calls to override_background_color(). More... | |
| void | override_font (const Pango::FontDescription & font_desc) |
| Sets the font to use for a widget. More... | |
| void | unset_font () |
| Undoes the effect of previous calls to override_font(). More... | |
| void | override_symbolic_color (const Glib::ustring & name, const Gdk::RGBA & color) |
| Sets a symbolic color for a widget. More... | |
| void | unset_symbolic_color (const Glib::ustring & name) |
| Undoes the effect of previous calls to override_symbolic_color(). More... | |
| void | override_cursor (const Gdk::RGBA & cursor, const Gdk::RGBA & secondary_cursor) |
| Sets the cursor color to use in a widget, overriding the cursor-color and secondary-cursor-color style properties. More... | |
| void | unset_cursor () |
| Undoes the effect of previous calls to override_cursor(). More... | |
| void | reset_style () |
| Updates the style context of widget and all descendants by updating its widget path. More... | |
| template<class PropertyType > | |
| void | get_style_property (const Glib::ustring & the_property_name, PropertyType & value) const |
| Gets the value of a style property of widget. More... | |
| Glib::RefPtr< Pango::Context > | create_pango_context () |
| Creates a new Pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget. More... | |
| Glib::RefPtr< Pango::Context > | get_pango_context () |
| Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget. More... | |
| void | set_font_options (const ::Cairo::FontOptions & options) |
| Sets the #cairo_font_options_t used for Pango rendering in this widget. More... | |
| void | unset_font_options () |
| Undoes the effect of previous calls to set_font_options(). More... | |
| ::Cairo::FontOptions | get_font_options () const |
| Returns the #cairo_font_options_t used for Pango rendering. More... | |
| Glib::RefPtr< Pango::Layout > | create_pango_layout (const Glib::ustring & text) |
| Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. More... | |
| Glib::RefPtr< Gdk::Pixbuf > | render_icon_pixbuf (const StockID & stock_id, IconSize size) |
| A convenience function that uses the theme engine and style settings for widget to look up stock_id and render it to a pixbuf. More... | |
| void | set_composite_name (const Glib::ustring & name) |
| Sets a widgets composite name. More... | |
| void | unset_composite_name () |
| Glib::ustring | get_composite_name () const |
| Obtains the composite name of a widget. More... | |
| void | set_direction (TextDirection dir) |
| Sets the reading direction on a particular widget. More... | |
| TextDirection | get_direction () const |
| Gets the reading direction for a particular widget. More... | |
| void | shape_combine_region (const ::Cairo::RefPtr< const ::Cairo::Region > & region) |
| Sets a shape for this widget’s GDK window. More... | |
| void | input_shape_combine_region (const ::Cairo::RefPtr< const ::Cairo::Region > & region) |
| Sets an input shape for this widget’s GDK window. More... | |
| WidgetPath | get_path () const |
| Returns the Gtk::WidgetPath representing widget, if the widget is not connected to a toplevel widget, a partial path will be created. More... | |
| std::vector< Widget * > | list_mnemonic_labels () |
| Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More... | |
| std::vector< const Widget * > | list_mnemonic_labels () const |
| Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More... | |
| void | add_mnemonic_label (Widget & label) |
| Adds a widget to the list of mnemonic labels for this widget. More... | |
| void | remove_mnemonic_label (Widget & label) |
| Removes a widget from the list of mnemonic labels for this widget. More... | |
| void | drag_get_data (const Glib::RefPtr< Gdk::DragContext > & context, const Glib::ustring & target, guint32 time) |
| void | drag_highlight () |
| void | drag_unhighlight () |
| void | drag_dest_set (DestDefaults flags=DestDefaults(0), Gdk::DragAction actions=Gdk::DragAction(0)) |
| void | drag_dest_set (const std::vector< TargetEntry > & targets, DestDefaults flags=DEST_DEFAULT_ALL, Gdk::DragAction actions=Gdk::ACTION_COPY) |
| void | drag_dest_set_proxy (const Glib::RefPtr< Gdk::Window > & proxy_window, Gdk::DragProtocol protocol, bool use_coordinates) |
| Sets this widget as a proxy for drops to another window. More... | |
| void | drag_dest_unset () |
| Clears information about a drop destination set with gtk_drag_dest_set(). More... | |
| Glib::ustring | drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext > & context, const Glib::RefPtr< TargetList > & target_list) const |
| Looks for a match between context->targets and the dest_target_list, returning the first matching target, otherwise returning GDK_NONE. More... | |
| Glib::ustring | drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext > & context) const |
| Glib::RefPtr< TargetList > | drag_dest_get_target_list () |
| Returns the list of targets this widget can accept from drag-and-drop. More... | |
| Glib::RefPtr< const TargetList > | drag_dest_get_target_list () const |
| Returns the list of targets this widget can accept from drag-and-drop. More... | |
| void | drag_dest_set_target_list (const Glib::RefPtr< TargetList > & target_list) |
| Sets the target types that this widget can accept from drag-and-drop. More... | |
| void | drag_dest_add_text_targets () |
| Add the text targets supported by Gtk::SelectionData to the target list of the drag destination. More... | |
| void | drag_dest_add_image_targets () |
| Add the image targets supported by Gtk::SelectionData to the target list of the drag destination. More... | |
| void | drag_dest_add_uri_targets () |
| Add the URI targets supported by Gtk::SelectionData to the target list of the drag destination. More... | |
| void | drag_source_set (const std::vector< TargetEntry > & targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY) |
| void | drag_source_unset () |
| Undoes the effects of gtk_drag_source_set(). More... | |
| void | drag_source_set_icon (const Glib::RefPtr< Gdk::Pixbuf > & pixbuf) |
| Sets the icon that will be used for drags from a particular widget from a Gdk::Pixbuf. More... | |
| void | drag_source_set_icon (const StockID & stock_id) |
| Sets the icon that will be used for drags from a particular source to a stock icon. More... | |
| void | drag_source_set_icon (const Glib::ustring & icon_name) |
| Sets the icon that will be used for drags from a particular source to a themed icon. More... | |
| void | drag_source_add_text_targets () |
| Add the text targets supported by Gtk::SelectionData to the target list of the drag source. More... | |
| void | drag_source_add_uri_targets () |
| Add the URI targets supported by Gtk::SelectionData to the target list of the drag source. More... | |
| void | drag_source_add_image_targets () |
| Add the writable image targets supported by Gtk::SelectionData to the target list of the drag source. More... | |
| Glib::RefPtr< Gdk::DragContext > | drag_begin (const Glib::RefPtr< TargetList > & targets, Gdk::DragAction actions, int button, GdkEvent * gdk_event) |
| Glib::RefPtr< Gdk::DragContext > | drag_begin (const Glib::RefPtr< TargetList > & targets, Gdk::DragAction actions, int button, GdkEvent * gdk_event, int x, int y) |
| bool | drag_check_threshold (int start_x, int start_y, int current_x, int current_y) |
| void | drag_set_as_icon (const Glib::RefPtr< Gdk::DragContext > & context, int hot_x, int hot_y) |
| void | queue_resize_no_redraw () |
| This function works like queue_resize(), except that the widget is not invalidated. More... | |
| Glib::RefPtr< Gdk::FrameClock > | get_frame_clock () |
| Obtains the frame clock for a widget. More... | |
| Glib::RefPtr< const Gdk::FrameClock > | get_frame_clock () const |
| Obtains the frame clock for a widget. More... | |
| bool | get_no_show_all () const |
| Returns the current value of the Gtk::Widget::property_no_show_all() property, which determines whether calls to show_all() will affect this widget. More... | |
| void | set_no_show_all (bool no_show_all=true) |
| Sets the Gtk::Widget::property_no_show_all() property, which determines whether calls to show_all() will affect this widget. More... | |
| void | set_parent (Widget & parent) |
| This function is useful only when implementing subclasses of Gtk::Container. More... | |
| void | unparent () |
| This function is only for use in widget implementations. More... | |
| void | map () |
| This function is only for use in widget implementations. More... | |
| void | unmap () |
| This function is only for use in widget implementations. More... | |
| void | draw_insertion_cursor (const ::Cairo::RefPtr< ::Cairo::Context > & cr, const Gdk::Rectangle & location, bool is_primary, TextDirection direction, bool draw_arrow=true) |
| Draws a text caret on cr at location. More... | |
| void | set_tooltip_window (Window & custom_window) |
| Replaces the default window used for displaying tooltips with custom_window. More... | |
| Window * | get_tooltip_window () |
| Returns the Gtk::Window of the current tooltip. More... | |
| void | trigger_tooltip_query () |
| Triggers a tooltip query on the display where the toplevel of widget is located. More... | |
| void | set_tooltip_text (const Glib::ustring & text) |
| Sets text as the contents of the tooltip. More... | |
| Glib::ustring | get_tooltip_text () const |
| Gets the contents of the tooltip for widget. More... | |
| void | set_tooltip_markup (const Glib::ustring & markup) |
| Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. More... | |
| Glib::ustring | get_tooltip_markup () const |
| Gets the contents of the tooltip for widget. More... | |
| void | set_has_tooltip (bool has_tooltip=TRUE) |
| Sets the has-tooltip property on widget to has_tooltip. More... | |
| bool | get_has_tooltip () const |
| Returns the current value of the has-tooltip property. More... | |
| int | get_width () const |
| int | get_height () const |
| bool | is_composited () const |
| Whether widget can rely on having its alpha channel drawn correctly. More... | |
| bool | in_destruction () const |
| Returns whether the widget is currently being destroyed. More... | |
| Glib::RefPtr< StyleContext > | get_style_context () |
| Returns the style context associated to widget. More... | |
| Glib::RefPtr< Gtk::StyleContext > | get_style_context () const |
| Returns the style context associated to widget. More... | |
| Gdk::ModifierType | get_modifier_mask (Gdk::ModifierIntent intent) |
| Returns the modifier mask the widget’s windowing system backend uses for a particular purpose. More... | |
| guint | add_tick_callback (const SlotTick & slot) |
| Queues an animation frame update and adds a callback to be called before each frame. More... | |
| void | remove_tick_callback (guint id) |
| Removes a tick callback previously registered with add_tick_callback(). More... | |
| void | insert_action_group (const Glib::ustring & name, const Glib::RefPtr< Gio::ActionGroup > & group) |
| Inserts group into widget. More... | |
| void | remove_action_group (const Glib::ustring & name) |
| Removes a group from the widget. More... | |
| Glib::RefPtr< Gio::ActionGroup > | get_action_group (const Glib::ustring & prefix) |
| Retrieves the Gio::ActionGroup that was registered using prefix. More... | |
| Glib::RefPtr< const Gio::ActionGroup > | get_action_group (const Glib::ustring & prefix) const |
| Retrieves the Gio::ActionGroup that was registered using prefix. More... | |
| std::vector< Glib::ustring > | list_action_prefixes () const |
Retrieves a nullptr-terminated array of strings containing the prefixes of Gio::ActionGroup's available to widget. More... | |
| void | set_font_map (const Glib::RefPtr< Pango::FontMap > & font_map) |
| Sets the font map to use for Pango rendering. More... | |
| Glib::RefPtr< Pango::FontMap > | get_font_map () |
| Gets the font map that has been set with set_font_map(). More... | |
| Glib::RefPtr< const Pango::FontMap > | get_font_map () const |
| Gets the font map that has been set with set_font_map(). More... | |
| Glib::SignalProxy< void > | signal_show () |
| Glib::SignalProxy< void > | signal_hide () |
| Glib::SignalProxy< void > | signal_map () |
| Emitted on mapping of a widget to the screen. More... | |
| Glib::SignalProxy< void > | signal_unmap () |
| Glib::SignalProxy< void > | signal_realize () |
| Emitted on realization of a widget. More... | |
| Glib::SignalProxy< void > | signal_unrealize () |
| Glib::SignalProxy< void, Allocation & > | signal_size_allocate () |
| Glib::SignalProxy< void, Gtk::StateType > | signal_state_changed () |
| Glib::SignalProxy< void, Gtk::StateFlags > | signal_state_flags_changed () |
| Glib::SignalProxy< void, Widget * > | signal_parent_changed () |
| Informs objects that their parent changed. More... | |
| Glib::SignalProxy< void, Widget * > | signal_hierarchy_changed () |
| Glib::SignalProxy< void > | signal_style_updated () |
| Glib::SignalProxy< void, TextDirection > | signal_direction_changed () |
| Glib::SignalProxy< void, bool > | signal_grab_notify () |
| Glib::SignalProxy< void, GParamSpec * > | signal_child_notify () |
| Glib::SignalProxyDetailedAnyType< void, GParamSpec * > | signal_child_notify (const Glib::ustring & child_property_name) |
| Glib::SignalProxy< bool, bool > | signal_mnemonic_activate () |
| Glib::SignalProxy< void > | signal_grab_focus () |
| Glib::SignalProxy< bool, DirectionType > | signal_focus () |
| Glib::SignalProxy< bool, GdkEvent * > | signal_event () |
| Glib::SignalProxy< void, GdkEvent * > | signal_event_after () |
| Glib::SignalProxy< bool, GdkEventButton * > | signal_button_press_event () |
| Event triggered by user pressing button. More... | |
| Glib::SignalProxy< bool, GdkEventButton * > | signal_button_release_event () |
| Event triggered by user releasing button. More... | |
| Glib::SignalProxy< bool, GdkEventScroll * > | signal_scroll_event () |
| Glib::SignalProxy< bool, GdkEventMotion * > | signal_motion_notify_event () |
| Event triggered by user moving pointer. More... | |
| Glib::SignalProxy< bool, GdkEventAny * > | signal_delete_event () |
| Glib::SignalProxy< bool, const ::Cairo::RefPtr< ::Cairo::Context > & > | signal_draw () |
| Glib::SignalProxy< bool, GdkEventKey * > | signal_key_press_event () |
| Event triggered by a key press will widget has focus. More... | |
| Glib::SignalProxy< bool, GdkEventKey * > | signal_key_release_event () |
| Event triggered by a key release will widget has focus. More... | |
| Glib::SignalProxy< bool, GdkEventCrossing * > | signal_enter_notify_event () |
| Event triggered by pointer entering widget area. More... | |
| Glib::SignalProxy< bool, GdkEventCrossing * > | signal_leave_notify_event () |
| Event triggered by pointer leaving widget area. More... | |
| Glib::SignalProxy< bool, GdkEventConfigure * > | signal_configure_event () |
| Event triggered by a window resizing. More... | |
| Glib::SignalProxy< bool, GdkEventFocus * > | signal_focus_in_event () |
| Glib::SignalProxy< bool, GdkEventFocus * > | signal_focus_out_event () |
| Glib::SignalProxy< bool, GdkEventAny * > | signal_map_event () |
| Glib::SignalProxy< bool, GdkEventAny * > | signal_unmap_event () |
| Glib::SignalProxy< bool, GdkEventProperty * > | signal_property_notify_event () |
| Glib::SignalProxy< bool, GdkEventSelection * > | signal_selection_clear_event () |
| Glib::SignalProxy< bool, GdkEventSelection * > | signal_selection_request_event () |
| Glib::SignalProxy< bool, GdkEventSelection * > | signal_selection_notify_event () |
| Glib::SignalProxy< bool, GdkEventProximity * > | signal_proximity_in_event () |
| Glib::SignalProxy< bool, GdkEventProximity * > | signal_proximity_out_event () |
| Glib::SignalProxy< bool, GdkEventVisibility * > | signal_visibility_notify_event () |
| Glib::SignalProxy< bool, GdkEventWindowState * > | signal_window_state_event () |
| Glib::SignalProxy< void, SelectionData &, guint, guint > | signal_selection_get () |
| Glib::SignalProxy< void, const SelectionData &, guint > | signal_selection_received () |
| Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext > & > | signal_drag_begin () |
| Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext > & > | signal_drag_end () |
| Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext > &, SelectionData &, guint, guint > | signal_drag_data_get () |
| Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext > & > | signal_drag_data_delete () |
| Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext > &, DragResult > | signal_drag_failed () |
| Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext > &, guint > | signal_drag_leave () |
| Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext > &, int, int, guint > | signal_drag_motion () |
| Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::DragContext > &, int, int, guint > | signal_drag_drop () |
| Glib::SignalProxy< void, const Glib::RefPtr< Gdk::DragContext > &, int, int, const SelectionData &, guint, guint > | signal_drag_data_received () |
| Glib::SignalProxy< void, const Glib::RefPtr< Gdk::Screen > & > | signal_screen_changed () |
| Glib::SignalProxy< void > | signal_composited_changed () |
| Glib::SignalProxy< bool > | signal_popup_menu () |
| Glib::SignalProxy< bool, int, int, bool, const Glib::RefPtr< Tooltip > & > | signal_query_tooltip () |
| Glib::SignalProxy< bool, GdkEventGrabBroken * > | signal_grab_broken_event () |
| Glib::SignalProxy< bool, GdkEventExpose * > | signal_damage_event () |
| Glib::SignalProxy< bool, GdkEventTouch * > | signal_touch_event () |
| Glib::PropertyProxy< Glib::ustring > | property_name () |
| The name of the widget. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const |
| The name of the widget. More... | |
| Glib::PropertyProxy< Container * > | property_parent () |
| The parent widget of this widget. More... | |
| Glib::PropertyProxy_ReadOnly< Container * > | property_parent () const |
| The parent widget of this widget. More... | |
| Glib::PropertyProxy< int > | property_width_request () |
| Override for width request of the widget, or -1 if natural request should be used. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_width_request () const |
| Override for width request of the widget, or -1 if natural request should be used. More... | |
| Glib::PropertyProxy< int > | property_height_request () |
| Override for height request of the widget, or -1 if natural request should be used. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_height_request () const |
| Override for height request of the widget, or -1 if natural request should be used. More... | |
| Glib::PropertyProxy< bool > | property_visible () |
| Whether the widget is visible. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_visible () const |
| Whether the widget is visible. More... | |
| Glib::PropertyProxy< bool > | property_sensitive () |
| Whether the widget responds to input. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_sensitive () const |
| Whether the widget responds to input. More... | |
| Glib::PropertyProxy< bool > | property_app_paintable () |
| Whether the application will paint directly on the widget. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_app_paintable () const |
| Whether the application will paint directly on the widget. More... | |
| Glib::PropertyProxy< bool > | property_can_focus () |
| Whether the widget can accept the input focus. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_can_focus () const |
| Whether the widget can accept the input focus. More... | |
| Glib::PropertyProxy< bool > | property_has_focus () |
| Whether the widget has the input focus. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_has_focus () const |
| Whether the widget has the input focus. More... | |
| Glib::PropertyProxy< bool > | property_is_focus () |
| Whether the widget is the focus widget within the toplevel. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_is_focus () const |
| Whether the widget is the focus widget within the toplevel. More... | |
| Glib::PropertyProxy< bool > | property_focus_on_click () |
| Whether the widget should grab focus when it is clicked with the mouse. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_focus_on_click () const |
| Whether the widget should grab focus when it is clicked with the mouse. More... | |
| Glib::PropertyProxy< bool > | property_can_default () |
| Whether the widget can be the default widget. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_can_default () const |
| Whether the widget can be the default widget. More... | |
| Glib::PropertyProxy< bool > | property_has_default () |
| Whether the widget is the default widget. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_has_default () const |
| Whether the widget is the default widget. More... | |
| Glib::PropertyProxy< bool > | property_receives_default () |
If true, the widget will receive the default action when it is focused. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_receives_default () const |
If true, the widget will receive the default action when it is focused. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_composite_child () const |
| Whether the widget is part of a composite widget. More... | |
| Glib::PropertyProxy< Glib::RefPtr< Style > > | property_style () |
| The style of the widget, which contains information about how it will look (colors, etc). More... | |
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Style > > | property_style () const |
| The style of the widget, which contains information about how it will look (colors, etc). More... | |
| Glib::PropertyProxy< Gdk::EventMask > | property_events () |
| The event mask that decides what kind of GdkEvents this widget gets. More... | |
| Glib::PropertyProxy_ReadOnly< Gdk::EventMask > | property_events () const |
| The event mask that decides what kind of GdkEvents this widget gets. More... | |
| Glib::PropertyProxy< bool > | property_has_tooltip () |
| Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_has_tooltip () const |
| Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More... | |
| Glib::PropertyProxy< Glib::ustring > | property_tooltip_markup () |
| Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_markup () const |
| Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More... | |
| Glib::PropertyProxy< Glib::ustring > | property_tooltip_text () |
| Sets the text of tooltip to be the given string. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_text () const |
| Sets the text of tooltip to be the given string. More... | |
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Window > > | property_window () const |
The widget's window if it is realized, nullptr otherwise. More... | |
| Glib::PropertyProxy< bool > | property_no_show_all () |
| Whether Gtk::Widget::show_all() should not affect this widget. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_no_show_all () const |
| Whether Gtk::Widget::show_all() should not affect this widget. More... | |
| Glib::PropertyProxy< bool > | property_double_buffered () |
| Whether the widget is double buffered. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_double_buffered () const |
| Whether the widget is double buffered. More... | |
| Glib::PropertyProxy< Align > | property_halign () |
| How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
| Glib::PropertyProxy_ReadOnly< Align > | property_halign () const |
| How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
| Glib::PropertyProxy< Align > | property_valign () |
| How to distribute vertical space if widget gets extra space, see Gtk::Align. More... | |
| Glib::PropertyProxy_ReadOnly< Align > | property_valign () const |
| How to distribute vertical space if widget gets extra space, see Gtk::Align. More... | |
| Glib::PropertyProxy< int > | property_margin_left () |
| Margin on left side of widget. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_margin_left () const |
| Margin on left side of widget. More... | |
| Glib::PropertyProxy< int > | property_margin_right () |
| Margin on right side of widget. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_margin_right () const |
| Margin on right side of widget. More... | |
| Glib::PropertyProxy< int > | property_margin_start () |
| Margin on start of widget, horizontally. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_margin_start () const |
| Margin on start of widget, horizontally. More... | |
| Glib::PropertyProxy< int > | property_margin_end () |
| Margin on end of widget, horizontally. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_margin_end () const |
| Margin on end of widget, horizontally. More... | |
| Glib::PropertyProxy< int > | property_margin_top () |
| Margin on top side of widget. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_margin_top () const |
| Margin on top side of widget. More... | |
| Glib::PropertyProxy< int > | property_margin_bottom () |
| Margin on bottom side of widget. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_margin_bottom () const |
| Margin on bottom side of widget. More... | |
| Glib::PropertyProxy< int > | property_margin () |
| Sets all four sides' margin at once. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_margin () const |
| Sets all four sides' margin at once. More... | |
| Glib::PropertyProxy< bool > | property_hexpand () |
| Whether to expand horizontally. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_hexpand () const |
| Whether to expand horizontally. More... | |
| Glib::PropertyProxy< bool > | property_hexpand_set () |
| Whether to use the Gtk::Widget::property_hexpand() property. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_hexpand_set () const |
| Whether to use the Gtk::Widget::property_hexpand() property. More... | |
| Glib::PropertyProxy< bool > | property_vexpand () |
| Whether to expand vertically. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_vexpand () const |
| Whether to expand vertically. More... | |
| Glib::PropertyProxy< bool > | property_vexpand_set () |
| Whether to use the Gtk::Widget::property_vexpand() property. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_vexpand_set () const |
| Whether to use the Gtk::Widget::property_vexpand() property. More... | |
| Glib::PropertyProxy< bool > | property_expand () |
| Whether to expand in both directions. More... | |
| Glib::PropertyProxy_ReadOnly< bool > | property_expand () const |
| Whether to expand in both directions. More... | |
| Glib::PropertyProxy< double > | property_opacity () |
| The requested opacity of the widget. More... | |
| Glib::PropertyProxy_ReadOnly< double > | property_opacity () const |
| The requested opacity of the widget. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_scale_factor () const |
| The scale factor of the widget. More... | |
| Public Member Functions inherited from Gtk::Object | |
| Object (Object && src) noexcept | |
| Object & | operator= (Object && src) noexcept |
| ~Object () noexcept override | |
| GObject * | gobj () |
| Provides access to the underlying C GObject. More... | |
| const GObject * | gobj () const |
| Provides access to the underlying C GObject. More... | |
| Public Member Functions inherited from Gtk::Buildable | |
| Buildable (Buildable && src) noexcept | |
| Buildable & | operator= (Buildable && src) noexcept |
| ~Buildable () noexcept override | |
| GtkBuildable * | gobj () |
| Provides access to the underlying C GObject. More... | |
| const GtkBuildable * | gobj () const |
| Provides access to the underlying C GObject. More... | |
| void | set_name (const Glib::ustring & name) |
| Sets the name of the buildable object. More... | |
| Glib::ustring | get_name () const |
| Gets the name of the buildable object. More... | |
Static Public Member Functions | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More... | |
| Static Public Member Functions inherited from Gtk::Widget | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More... | |
| static Widget * | get_current_modal_grab () |
| Retrieve the widget which is currently grabbing all events. More... | |
| static void | push_composite_child () |
| Makes all newly-created widgets as composite children until the corresponding pop_composite_child() call. More... | |
| static void | pop_composite_child () |
| Cancels the effect of a previous call to push_composite_child(). More... | |
| static void | set_default_direction (TextDirection dir) |
| Sets the default reading direction for widgets where the direction has not been explicitly set by set_direction(). More... | |
| static TextDirection | get_default_direction () |
| Obtains the current default reading direction. More... | |
| static Widget * | drag_get_source_widget (const Glib::RefPtr< Gdk::DragContext > & context) |
| Static Public Member Functions inherited from Gtk::Buildable | |
| 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 | |
| virtual Glib::RefPtr< Gdk::GLContext > | on_create_context () |
| This is a default handler for the signal signal_create_context(). More... | |
| virtual bool | on_render (const Glib::RefPtr< Gdk::GLContext > & context) |
| This is a default handler for the signal signal_render(). More... | |
| virtual void | on_resize (int width, int height) |
| This is a default handler for the signal signal_resize(). More... | |
| Protected Member Functions inherited from Gtk::Widget | |
| virtual void | on_show () |
| This is a default handler for the signal signal_show(). More... | |
| virtual void | on_hide () |
| This is a default handler for the signal signal_hide(). More... | |
| virtual void | on_map () |
| This is a default handler for the signal signal_map(). More... | |
| virtual void | on_unmap () |
| This is a default handler for the signal signal_unmap(). More... | |
| virtual void | on_realize () |
| This is a default handler for the signal signal_realize(). More... | |
| virtual void | on_unrealize () |
| This is a default handler for the signal signal_unrealize(). More... | |
| virtual void | on_size_allocate (Allocation & allocation) |
| This is a default handler for the signal signal_size_allocate(). More... | |
| virtual void | on_state_changed (Gtk::StateType previous_state) |
| This is a default handler for the signal signal_state_changed(). More... | |
| virtual void | on_parent_changed (Widget * previous_parent) |
| This is a default handler for the signal signal_parent_changed(). More... | |
| virtual void | on_hierarchy_changed (Widget * previous_toplevel) |
| This is a default handler for the signal signal_hierarchy_changed(). More... | |
| virtual void | on_style_updated () |
| This is a default handler for the signal signal_style_updated(). More... | |
| virtual void | on_direction_changed (TextDirection direction) |
| This is a default handler for the signal signal_direction_changed(). More... | |
| virtual void | on_grab_notify (bool was_grabbed) |
| This is a default handler for the signal signal_grab_notify(). More... | |
| virtual void | on_child_notify (GParamSpec * pspec) |
| This is a default handler for the signal signal_child_notify(). More... | |
| virtual bool | on_mnemonic_activate (bool group_cycling) |
| This is a default handler for the signal signal_mnemonic_activate(). More... | |
| virtual void | on_grab_focus () |
| This is a default handler for the signal signal_grab_focus(). More... | |
| virtual bool | on_focus (DirectionType direction) |
| This is a default handler for the signal signal_focus(). More... | |
| virtual bool | on_event (GdkEvent * gdk_event) |
| This is a default handler for the signal signal_event(). More... | |
| virtual bool | on_button_press_event (GdkEventButton * button_event) |
| This is a default handler for the signal signal_button_press_event(). More... | |
| virtual bool | on_button_release_event (GdkEventButton * release_event) |
| This is a default handler for the signal signal_button_release_event(). More... | |
| virtual bool | on_scroll_event (GdkEventScroll * scroll_event) |
| This is a default handler for the signal signal_scroll_event(). More... | |
| virtual bool | on_motion_notify_event (GdkEventMotion * motion_event) |
| This is a default handler for the signal signal_motion_notify_event(). More... | |
| virtual bool | on_delete_event (GdkEventAny * any_event) |
| This is a default handler for the signal signal_delete_event(). More... | |
| virtual bool | on_draw (const ::Cairo::RefPtr< ::Cairo::Context > & cr) |
| This is a default handler for the signal signal_draw(). More... | |
| virtual bool | on_key_press_event (GdkEventKey * key_event) |
| This is a default handler for the signal signal_key_press_event(). More... | |
| virtual bool | on_key_release_event (GdkEventKey * key_event) |
| This is a default handler for the signal signal_key_release_event(). More... | |
| virtual bool | on_enter_notify_event (GdkEventCrossing * crossing_event) |
| This is a default handler for the signal signal_enter_notify_event(). More... | |
| virtual bool | on_leave_notify_event (GdkEventCrossing * crossing_event) |
| This is a default handler for the signal signal_leave_notify_event(). More... | |
| virtual bool | on_configure_event (GdkEventConfigure * configure_event) |
| This is a default handler for the signal signal_configure_event(). More... | |
| virtual bool | on_focus_in_event (GdkEventFocus * focus_event) |
| This is a default handler for the signal signal_focus_in_event(). More... | |
| virtual bool | on_focus_out_event (GdkEventFocus * gdk_event) |
| This is a default handler for the signal signal_focus_out_event(). More... | |
| virtual bool | on_map_event (GdkEventAny * any_event) |
| This is a default handler for the signal signal_map_event(). More... | |
| virtual bool | on_unmap_event (GdkEventAny * any_event) |
| This is a default handler for the signal signal_unmap_event(). More... | |
| virtual bool | on_property_notify_event (GdkEventProperty * property_event) |
| This is a default handler for the signal signal_property_notify_event(). More... | |
| virtual bool | on_selection_clear_event (GdkEventSelection * selection_event) |
| This is a default handler for the signal signal_selection_clear_event(). More... | |
| virtual bool | on_selection_request_event (GdkEventSelection * selection_event) |
| This is a default handler for the signal signal_selection_request_event(). More... | |
| virtual bool | on_selection_notify_event (GdkEventSelection * selection_event) |
| This is a default handler for the signal signal_selection_notify_event(). More... | |
| virtual bool | on_proximity_in_event (GdkEventProximity * proximity_event) |
| This is a default handler for the signal signal_proximity_in_event(). More... | |
| virtual bool | on_proximity_out_event (GdkEventProximity * proximity_event) |
| This is a default handler for the signal signal_proximity_out_event(). More... | |
| virtual bool | on_visibility_notify_event (GdkEventVisibility * visibility_event) |
| This is a default handler for the signal signal_visibility_notify_event(). More... | |
| virtual bool | on_window_state_event (GdkEventWindowState * window_state_event) |
| This is a default handler for the signal signal_window_state_event(). More... | |
| virtual void | on_selection_get (SelectionData & selection_data, guint info, guint time) |
| This is a default handler for the signal signal_selection_get(). More... | |
| virtual void | on_selection_received (const SelectionData & selection_data, guint time) |
| This is a default handler for the signal signal_selection_received(). More... | |
| virtual void | on_drag_begin (const Glib::RefPtr< Gdk::DragContext > & context) |
| This is a default handler for the signal signal_drag_begin(). More... | |
| virtual void | on_drag_end (const Glib::RefPtr< Gdk::DragContext > & context) |
| This is a default handler for the signal signal_drag_end(). More... | |
| virtual void | on_drag_data_get (const Glib::RefPtr< Gdk::DragContext > & context, SelectionData & selection_data, guint info, guint time) |
| This is a default handler for the signal signal_drag_data_get(). More... | |
| virtual void | on_drag_data_delete (const Glib::RefPtr< Gdk::DragContext > & context) |
| This is a default handler for the signal signal_drag_data_delete(). More... | |
| virtual void | on_drag_leave (const Glib::RefPtr< Gdk::DragContext > & context, guint time) |
| This is a default handler for the signal signal_drag_leave(). More... | |
| virtual bool | on_drag_motion (const Glib::RefPtr< Gdk::DragContext > & context, int x, int y, guint time) |
| This is a default handler for the signal signal_drag_motion(). More... | |
| virtual bool | on_drag_drop (const Glib::RefPtr< Gdk::DragContext > & context, int x, int y, guint time) |
| This is a default handler for the signal signal_drag_drop(). More... | |
| virtual void | on_drag_data_received (const Glib::RefPtr< Gdk::DragContext > & context, int x, int y, const SelectionData & selection_data, guint info, guint time) |
| This is a default handler for the signal signal_drag_data_received(). More... | |
| virtual void | on_screen_changed (const Glib::RefPtr< Gdk::Screen > & previous_screen) |
| This is a default handler for the signal signal_screen_changed(). More... | |
| virtual void | dispatch_child_properties_changed_vfunc (guint p1, GParamSpec ** p2) |
| virtual void | show_all_vfunc () |
| virtual Glib::RefPtr< Atk::Object > | get_accessible_vfunc () |
| virtual SizeRequestMode | get_request_mode_vfunc () const |
| virtual void | get_preferred_width_vfunc (int & minimum_width, int & natural_width) const |
| virtual void | get_preferred_height_for_width_vfunc (int width, int & minimum_height, int & natural_height) const |
| virtual void | get_preferred_height_vfunc (int & minimum_height, int & natural_height) const |
| virtual void | get_preferred_width_for_height_vfunc (int height, int & minimum_width, int & natural_width) const |
| Widget () | |
| void | realize () |
| Creates the GDK (windowing system) resources associated with a widget. More... | |
| void | unrealize () |
| This function is only useful in widget implementations. More... | |
| void | draw (const ::Cairo::RefPtr< ::Cairo::Context > & cr) |
| Draws widget to cr. More... | |
| void | set_mapped (bool mapped=true) |
| Marks the widget as being mapped. More... | |
| void | set_realized (bool realized=true) |
| Marks the widget as being realized. More... | |
| void | set_has_window (bool has_window=true) |
| Specifies whether widget has a Gdk::Window of its own. More... | |
| void | set_window (const Glib::RefPtr< Gdk::Window > & window) |
| Sets a widget's window. More... | |
| void | transform_cairo_context_to_window (const ::Cairo::RefPtr< ::Cairo::Context > & cr, const Glib::RefPtr< const Gdk::Window > & window) |
| Transforms the given cairo context cr from widget-relative coordinates to window-relative coordinates. More... | |
| Requisition | get_requisition () const |
| Retrieves the widget's requisition. More... | |
| void | get_style_property_value (const Glib::ustring & the_property_name, Glib::ValueBase & value) const |
| Gets the value of a style property of widget. More... | |
| void | realize_if_needed () |
| Protected Member Functions inherited from Gtk::Buildable | |
| Buildable () | |
| You should derive from this class to use it. More... | |
Related Functions | |
(Note that these are not member functions.) | |
| Gtk::GLArea * | wrap (GtkGLArea * object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
| Related Functions inherited from Gtk::Widget | |
| Gtk::Widget * | wrap (GtkWidget * object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
| Related Functions inherited from Gtk::Buildable | |
| Glib::RefPtr< Gtk::Buildable > | wrap (GtkBuildable * object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
| Public Types inherited from Gtk::Widget | |
| using | SlotTick = sigc::slot< bool(const Glib::RefPtr< Gdk::FrameClock > &)> |
| Callback type for adding a function to update animations. More... | |
| Static Protected Member Functions inherited from Gtk::Widget | |
| static bool | should_draw_window (const ::Cairo::RefPtr< const ::Cairo::Context > & cr, const Glib::RefPtr< const Gdk::Window > & window) |
| This function is supposed to be called in Gtk::Widget::signal_draw() implementations for widgets that support multiple windows. More... | |
Detailed Description
A widget used for drawing with OpenGL.
Constructor & Destructor Documentation
◆ GLArea() [1/3]
|
noexcept |
◆ GLArea() [2/3]
|
delete |
◆ ~GLArea()
|
overridenoexcept |
◆ GLArea() [3/3]
| Gtk::GLArea::GLArea | ( | ) |
Member Function Documentation
◆ attach_buffers()
| void Gtk::GLArea::attach_buffers | ( | ) |
Ensures that the area framebuffer object is made the current draw and read target, and that all the required buffers for the area are created and bound to the frambuffer.
This function is automatically called before emitting the Gtk::GLArea::signal_render() signal, and doesn't normally need to be called by application code.
◆ get_auto_render()
| bool Gtk::GLArea::get_auto_render | ( | ) | const |
Returns whether the area is in auto render mode or not.
- Returns
trueif the area is auto rendering,falseotherwise.
◆ get_context() [1/2]
| Glib::RefPtr< Gdk::GLContext > Gtk::GLArea::get_context | ( | ) |
◆ get_context() [2/2]
| Glib::RefPtr< const Gdk::GLContext > Gtk::GLArea::get_context | ( | ) | const |
◆ get_has_alpha()
| bool Gtk::GLArea::get_has_alpha | ( | ) | const |
Returns whether the area has an alpha component.
- Returns
trueif the area has an alpha component,falseotherwise.
◆ get_has_depth_buffer()
| bool Gtk::GLArea::get_has_depth_buffer | ( | ) | const |
Returns whether the area has a depth buffer.
- Returns
trueif the area has a depth buffer,falseotherwise.
◆ get_has_stencil_buffer()
| bool Gtk::GLArea::get_has_stencil_buffer | ( | ) | const |
Returns whether the area has a stencil buffer.
- Returns
trueif the area has a stencil buffer,falseotherwise.
◆ get_required_version()
| void Gtk::GLArea::get_required_version | ( | int & | major, |
| int & | minor | ||
| ) | const |
Retrieves the required version of OpenGL set using gtk_gl_area_set_required_version().
- Parameters
-
major Return location for the required major version. minor Return location for the required minor version.
◆ get_type()
|
static |
Get the GType for this class, for use with the underlying GObject type system.
◆ get_use_es()
| bool Gtk::GLArea::get_use_es | ( | ) | const |
Retrieves the value set by gtk_gl_area_set_use_es().
- Returns
trueif the Gtk::GLArea should create an OpenGL ES context andfalseotherwise.
◆ gobj() [1/2]
|
inline |
Provides access to the underlying C GObject.
◆ gobj() [2/2]
|
inline |
Provides access to the underlying C GObject.
◆ has_error()
| bool Gtk::GLArea::has_error | ( | ) | const |
Check if any error is currently set on this area.
The error may be obtained by using throw_if_error() and set using set_error().
- Returns
- true if an error is currently set.
◆ make_current()
| void Gtk::GLArea::make_current | ( | ) |
Ensures that the Gdk::GLContext used by area is associated with the Gtk::GLArea.
This function is automatically called before emitting the Gtk::GLArea::signal_render() signal, and doesn't normally need to be called by application code.
◆ on_create_context()
|
protectedvirtual |
This is a default handler for the signal signal_create_context().
◆ on_render()
|
protectedvirtual |
This is a default handler for the signal signal_render().
◆ on_resize()
|
protectedvirtual |
This is a default handler for the signal signal_resize().
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ property_auto_render() [1/2]
| Glib::PropertyProxy< bool > Gtk::GLArea::property_auto_render | ( | ) |
If set to true the Gtk::GLArea::signal_render() signal will be emitted every time the widget draws.
This is the default and is useful if drawing the widget is faster.
If set to false the data from previous rendering is kept around and will be used for drawing the widget the next time, unless the window is resized. In order to force a rendering gtk_gl_area_queue_render() must be called. This mode is useful when the scene changes seldomly, but takes a long time to redraw.
Default value: true
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
◆ property_auto_render() [2/2]
| Glib::PropertyProxy_ReadOnly< bool > Gtk::GLArea::property_auto_render | ( | ) | const |
If set to true the Gtk::GLArea::signal_render() signal will be emitted every time the widget draws.
This is the default and is useful if drawing the widget is faster.
If set to false the data from previous rendering is kept around and will be used for drawing the widget the next time, unless the window is resized. In order to force a rendering gtk_gl_area_queue_render() must be called. This mode is useful when the scene changes seldomly, but takes a long time to redraw.
Default value: true
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ property_context()
| Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::GLContext > > Gtk::GLArea::property_context | ( | ) | const |
The Gdk::GLContext used by the Gtk::GLArea widget.
The Gtk::GLArea widget is responsible for creating the Gdk::GLContext instance. If you need to render with other kinds of buffers (stencil, depth, etc), use render buffers.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ property_has_alpha() [1/2]
| Glib::PropertyProxy< bool > Gtk::GLArea::property_has_alpha | ( | ) |
If set to true the buffer allocated by the widget will have an alpha channel component, and when rendering to the window the result will be composited over whatever is below the widget.
If set to false there will be no alpha channel, and the buffer will fully replace anything below the widget.
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
◆ property_has_alpha() [2/2]
| Glib::PropertyProxy_ReadOnly< bool > Gtk::GLArea::property_has_alpha | ( | ) | const |
If set to true the buffer allocated by the widget will have an alpha channel component, and when rendering to the window the result will be composited over whatever is below the widget.
If set to false there will be no alpha channel, and the buffer will fully replace anything below the widget.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ property_has_depth_buffer() [1/2]
| Glib::PropertyProxy< bool > Gtk::GLArea::property_has_depth_buffer | ( | ) |
If set to true the widget will allocate and enable a depth buffer for the target framebuffer.
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
◆ property_has_depth_buffer() [2/2]
| Glib::PropertyProxy_ReadOnly< bool > Gtk::GLArea::property_has_depth_buffer | ( | ) | const |
If set to true the widget will allocate and enable a depth buffer for the target framebuffer.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ property_has_stencil_buffer() [1/2]
| Glib::PropertyProxy< bool > Gtk::GLArea::property_has_stencil_buffer | ( | ) |
If set to true the widget will allocate and enable a stencil buffer for the target framebuffer.
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
◆ property_has_stencil_buffer() [2/2]
| Glib::PropertyProxy_ReadOnly< bool > Gtk::GLArea::property_has_stencil_buffer | ( | ) | const |
If set to true the widget will allocate and enable a stencil buffer for the target framebuffer.
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ property_use_es() [1/2]
| Glib::PropertyProxy< bool > Gtk::GLArea::property_use_es | ( | ) |
If set to true the widget will try to create a Gdk::GLContext using OpenGL ES instead of OpenGL.
See also: gdk_gl_context_set_use_es()
Default value: false
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
◆ property_use_es() [2/2]
| Glib::PropertyProxy_ReadOnly< bool > Gtk::GLArea::property_use_es | ( | ) | const |
If set to true the widget will try to create a Gdk::GLContext using OpenGL ES instead of OpenGL.
See also: gdk_gl_context_set_use_es()
Default value: false
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
◆ queue_render()
| void Gtk::GLArea::queue_render | ( | ) |
Marks the currently rendered data (if any) as invalid, and queues a redraw of the widget, ensuring that the Gtk::GLArea::signal_render() signal is emitted during the draw.
This is only needed when the gtk_gl_area_set_auto_render() has been called with a false value. The default behaviour is to emit Gtk::GLArea::signal_render() on each draw.
◆ set_auto_render()
| void Gtk::GLArea::set_auto_render | ( | bool | auto_render = true | ) |
If auto_render is true the Gtk::GLArea::signal_render() signal will be emitted every time the widget draws.
This is the default and is useful if drawing the widget is faster.
If auto_render is false the data from previous rendering is kept around and will be used for drawing the widget the next time, unless the window is resized. In order to force a rendering gtk_gl_area_queue_render() must be called. This mode is useful when the scene changes seldomly, but takes a long time to redraw.
- Parameters
-
auto_render A boolean.
◆ set_error()
| void Gtk::GLArea::set_error | ( | const Glib::Error & | error | ) |
Sets an error on the area which will be shown instead of GL rendering.
This is useful in the signal_create_context() handler if GL context creation fails.
- Parameters
-
error The error to set on the area.
◆ set_has_alpha()
| void Gtk::GLArea::set_has_alpha | ( | bool | has_alpha = true | ) |
If has_alpha is true the buffer allocated by the widget will have an alpha channel component, and when rendering to the window the result will be composited over whatever is below the widget.
If has_alpha is false there will be no alpha channel, and the buffer will fully replace anything below the widget.
- Parameters
-
has_alpha trueto add an alpha component.
◆ set_has_depth_buffer()
| void Gtk::GLArea::set_has_depth_buffer | ( | bool | has_depth_buffer = true | ) |
If has_depth_buffer is true the widget will allocate and enable a depth buffer for the target framebuffer.
Otherwise there will be none.
- Parameters
-
has_depth_buffer trueto add a depth buffer.
◆ set_has_stencil_buffer()
| void Gtk::GLArea::set_has_stencil_buffer | ( | bool | has_stencil_buffer = true | ) |
If has_stencil_buffer is true the widget will allocate and enable a stencil buffer for the target framebuffer.
Otherwise there will be none.
- Parameters
-
has_stencil_buffer trueto add a stencil buffer.
◆ set_required_version()
| void Gtk::GLArea::set_required_version | ( | int | major, |
| int | minor | ||
| ) |
Sets the required version of OpenGL to be used when creating the context for the widget.
This function must be called before the area has been realized.
- Parameters
-
major The major version. minor The minor version.
◆ set_use_es()
| void Gtk::GLArea::set_use_es | ( | bool | use_es = true | ) |
Sets whether the area should create an OpenGL or an OpenGL ES context.
You should check the capabilities of the Gdk::GLContext before drawing with either API.
- Parameters
-
use_es Whether to use OpenGL or OpenGL ES.
◆ signal_create_context()
| Glib::SignalProxy< Glib::RefPtr< Gdk::GLContext > > Gtk::GLArea::signal_create_context | ( | ) |
- Slot Prototype:
Glib::RefPtr<Gdk::GLContext> on_my_create_context()
Flags: Run Last
The signal_create_context() signal is emitted when the widget is being realized, and allows you to override how the GL context is created. This is useful when you want to reuse an existing GL context, or if you want to try creating different kinds of GL options.
If context creation fails then the signal handler can use gtk_gl_area_set_error() to register a more detailed error of how the construction failed.
- Returns
- A newly created Gdk::GLContext; the Gtk::GLArea widget will take ownership of the returned value.
◆ signal_render()
| Glib::SignalProxy< bool, const Glib::RefPtr< Gdk::GLContext > & > Gtk::GLArea::signal_render | ( | ) |
- Slot Prototype:
bool on_my_render(const Glib::RefPtr<Gdk::GLContext>& context)
Flags: Run Last
The signal_render() signal is emitted every time the contents of the Gtk::GLArea should be redrawn.
The context is bound to the area prior to emitting this function, and the buffers are painted to the window once the emission terminates.
- Parameters
-
context The Gdk::GLContext used by area.
- Returns
trueto stop other handlers from being invoked for the event.falseto propagate the event further.
◆ signal_resize()
| Glib::SignalProxy< void, int, int > Gtk::GLArea::signal_resize | ( | ) |
- Slot Prototype:
void on_my_resize(int width, int height)
Flags: Run Last
The signal_resize() signal is emitted once when the widget is realized, and then each time the widget is changed while realized. This is useful in order to keep GL state up to date with the widget size, like for instance camera properties which may depend on the width/height ratio.
The GL context for the area is guaranteed to be current when this signal is emitted.
The default handler sets up the GL viewport.
- Parameters
-
width The width of the viewport. height The height of the viewport.
◆ throw_if_error()
| void Gtk::GLArea::throw_if_error | ( | ) | const |
Will throw the correct Glib::Error subclass if any is currently set on this area.
- Exceptions
-
Throws any currently set error (e.g. Gdk::GLError).
◆ unset_error()
| void Gtk::GLArea::unset_error | ( | ) |
Clears any previous set error on this area made with set_error().
Friends And Related Function Documentation
◆ wrap()
|
related |
A Glib::wrap() method for this object.
- Parameters
-
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.
- Returns
- A C++ instance that wraps this C instance.
