gtkmm  4.8.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::Dialog Class Reference

Create popup windows. More...

#include <gtkmm/dialog.h>

Inheritance diagram for Gtk::Dialog:
Inheritance graph
[legend]

Public Member Functions

 Dialog (Dialog && src) noexcept
 
Dialogoperator= (Dialog && src) noexcept
 
 Dialog (const Dialog &)=delete
 
Dialogoperator= (const Dialog &)=delete
 
 ~Dialog () noexcept override
 
GtkDialog * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkDialog * gobj () const
 Provides access to the underlying C GObject. More...
 
 Dialog ()
 
 Dialog (const Glib::ustring & title, bool modal=false, bool use_header_bar=false)
 
 Dialog (const Glib::ustring & title, Gtk::Window & parent, bool modal=false, bool use_header_bar=false)
 
void add_action_widget (Widget & child, int response_id)
 Adds an activatable widget to the action area of a Gtk::Dialog. More...
 
Buttonadd_button (const Glib::ustring & button_text, int response_id)
 Adds a button with the given text. More...
 
void set_response_sensitive (int response_id, bool setting=true)
 A convenient way to sensitize/desensitize dialog buttons. More...
 
void set_default_response (int response_id)
 Sets the default widget for the dialog based on the response ID. More...
 
Widgetget_widget_for_response (int response_id)
 Gets the widget button that uses the given response ID in the action area of a dialog. More...
 
const Widgetget_widget_for_response (int response_id) const
 Gets the widget button that uses the given response ID in the action area of a dialog. More...
 
int get_response_for_widget (const Gtk::Widget & widget) const
 Gets the response id of a widget in the action area of a dialog. More...
 
void response (int response_id)
 Emits the signal_response() signal with the given response ID. More...
 
Boxget_content_area ()
 Returns the content area of dialog. More...
 
const Boxget_content_area () const
 Returns the content area of dialog. More...
 
HeaderBarget_header_bar ()
 Returns the header bar of dialog. More...
 
const HeaderBarget_header_bar () const
 Returns the header bar of dialog. More...
 
Glib::SignalProxy< void(int)> signal_response ()
 
Glib::PropertyProxy_ReadOnly< bool > property_use_header_bar () const
 true if the dialog uses a headerbar for action buttons instead of the action-area. More...
 
- Public Member Functions inherited from Gtk::Window
 Window (const Window &)=delete
 
Windowoperator= (const Window &)=delete
 
 ~Window () noexcept override
 
GtkWindow * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkWindow * gobj () const
 Provides access to the underlying C GObject. More...
 
 Window (Window && src) noexcept
 
Windowoperator= (Window && src) noexcept
 
 Window ()
 
Glib::PropertyProxy< Glib::ustring > property_title ()
 The title of the window. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_title () const
 The title of the window. More...
 
Glib::PropertyProxy_WriteOnly< Glib::ustring > property_startup_id ()
 A write-only property for setting window's startup notification identifier. More...
 
Glib::PropertyProxy< bool > property_resizable ()
 If true, users can resize the window. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_resizable () const
 If true, users can resize the window. More...
 
Glib::PropertyProxy< bool > property_modal ()
 If true, the window is modal. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_modal () const
 If true, the window is modal. More...
 
Glib::PropertyProxy< int > property_default_width ()
 The default width of the window. More...
 
Glib::PropertyProxy_ReadOnly< int > property_default_width () const
 The default width of the window. More...
 
Glib::PropertyProxy< int > property_default_height ()
 The default height of the window. More...
 
Glib::PropertyProxy_ReadOnly< int > property_default_height () const
 The default height of the window. More...
 
Glib::PropertyProxy< bool > property_destroy_with_parent ()
 If this window should be destroyed when the parent is destroyed. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_destroy_with_parent () const
 If this window should be destroyed when the parent is destroyed. More...
 
Glib::PropertyProxy< bool > property_hide_on_close ()
 If this window should be hidden when the users clicks the close button. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_hide_on_close () const
 If this window should be hidden when the users clicks the close button. More...
 
Glib::PropertyProxy< bool > property_mnemonics_visible ()
 Whether mnemonics are currently visible in this window. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_mnemonics_visible () const
 Whether mnemonics are currently visible in this window. More...
 
Glib::PropertyProxy< Glib::ustring > property_icon_name ()
 Specifies the name of the themed icon to use as the window icon. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_icon_name () const
 Specifies the name of the themed icon to use as the window icon. More...
 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Display > > property_display ()
 The display that will display this window. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Display > > property_display () const
 The display that will display this window. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_is_active () const
 Whether the toplevel is the currently active window. More...
 
Glib::PropertyProxy< bool > property_decorated ()
 Whether the window should have a frame (also known as decorations). More...
 
Glib::PropertyProxy_ReadOnly< bool > property_decorated () const
 Whether the window should have a frame (also known as decorations). More...
 
Glib::PropertyProxy< Window * > property_transient_for ()
 The transient parent of the window. More...
 
Glib::PropertyProxy_ReadOnly< Window * > property_transient_for () const
 The transient parent of the window. More...
 
Glib::PropertyProxy< bool > property_deletable ()
 Whether the window frame should have a close button. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_deletable () const
 Whether the window frame should have a close button. More...
 
Glib::PropertyProxy< Glib::RefPtr< Application > > property_application ()
 The Gtk::Application associated with the window. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Application > > property_application () const
 The Gtk::Application associated with the window. More...
 
Glib::PropertyProxy< bool > property_focus_visible ()
 Whether 'focus rectangles' are currently visible in this window. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_focus_visible () const
 Whether 'focus rectangles' are currently visible in this window. More...
 
Glib::PropertyProxy< bool > property_maximized ()
 Whether the window is maximized. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_maximized () const
 Whether the window is maximized. More...
 
Glib::PropertyProxy< bool > property_fullscreened ()
 Whether the window is fullscreen. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_fullscreened () const
 Whether the window is fullscreen. More...
 
Glib::PropertyProxy< Widget * > property_default_widget ()
 The default widget. More...
 
Glib::PropertyProxy_ReadOnly< Widget * > property_default_widget () const
 The default widget. More...
 
Glib::PropertyProxy< Widget * > property_focus_widget ()
 The focus widget. More...
 
Glib::PropertyProxy_ReadOnly< Widget * > property_focus_widget () const
 The focus widget. More...
 
Glib::PropertyProxy< Widget * > property_child ()
 The child widget. More...
 
Glib::PropertyProxy_ReadOnly< Widget * > property_child () const
 The child widget. More...
 
Glib::PropertyProxy< Widget * > property_titlebar ()
 The titlebar widget. More...
 
Glib::PropertyProxy_ReadOnly< Widget * > property_titlebar () const
 The titlebar widget. More...
 
Glib::PropertyProxy< bool > property_handle_menubar_accel ()
 Whether the window frame should handle F10 for activating menubars. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_handle_menubar_accel () const
 Whether the window frame should handle F10 for activating menubars. More...
 
Glib::SignalProxy< void()> signal_keys_changed ()
 
Glib::SignalProxy< bool()> signal_close_request ()
 
void set_title (const Glib::ustring & title)
 Sets the title of the Gtk::Window. More...
 
Glib::ustring get_title () const
 Retrieves the title of the window. More...
 
void set_startup_id (const Glib::ustring & startup_id)
 Sets the startup notification ID. More...
 
void set_focus (Gtk::Widget & focus)
 If focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. More...
 
void unset_focus ()
 
Widgetget_focus ()
 Retrieves the current focused widget within the window. More...
 
const Widgetget_focus () const
 Retrieves the current focused widget within the window. More...
 
void set_default_widget (Gtk::Widget & default_widget)
 Sets the default widget. More...
 
void unset_default_widget ()
 
Widgetget_default_widget ()
 Returns the default widget for window. More...
 
const Widgetget_default_widget () const
 Returns the default widget for window. More...
 
void set_transient_for (Window & parent)
 Dialog windows should be set transient for the main application window they were spawned from. More...
 
void unset_transient_for ()
 Unsets the current transient window. More...
 
Windowget_transient_for ()
 Fetches the transient parent for this window. More...
 
const Windowget_transient_for () const
 Fetches the transient parent for this window. More...
 
void set_destroy_with_parent (bool setting=true)
 If setting is true, then destroying the transient parent of window will also destroy window itself. More...
 
bool get_destroy_with_parent () const
 Returns whether the window will be destroyed with its transient parent. More...
 
void destroy ()
 Drop the internal reference GTK holds on toplevel windows. More...
 
void set_hide_on_close (bool setting=true)
 If setting is true, then clicking the close button on the window will not destroy it, but only hide it. More...
 
bool get_hide_on_close () const
 Returns whether the window will be hidden when the close button is clicked. More...
 
void set_mnemonics_visible (bool setting=true)
 Sets whether mnemonics are supposed to be visible. More...
 
bool get_mnemonics_visible () const
 Gets whether mnemonics are supposed to be visible. More...
 
void set_focus_visible (bool setting=true)
 Sets whether “focus rectangles” are supposed to be visible. More...
 
bool get_focus_visible () const
 Gets whether “focus rectangles” are supposed to be visible. More...
 
void set_resizable (bool resizable=true)
 Sets whether the user can resize a window. More...
 
bool get_resizable () const
 Gets the value set by set_resizable(). More...
 
void set_display (const Glib::RefPtr< Gdk::Display > & display)
 Sets the Gdk::Display where the window is displayed. More...
 
bool is_active () const
 Returns whether the window is part of the current active toplevel. More...
 
void set_decorated (bool setting=true)
 Sets whether the window should be decorated. More...
 
bool get_decorated () const
 Returns whether the window has been set to have decorations. More...
 
void set_deletable (bool setting=true)
 Sets whether the window should be deletable. More...
 
bool get_deletable () const
 Returns whether the window has been set to have a close button. More...
 
void set_icon_name (const Glib::ustring & name)
 Sets the icon for the window from a named themed icon. More...
 
Glib::ustring get_icon_name () const
 Returns the name of the themed icon for the window. More...
 
void set_modal (bool modal=true)
 Sets a window modal or non-modal. More...
 
bool get_modal () const
 Returns whether the window is modal. More...
 
void present ()
 Presents a window to the user. More...
 
void present (guint32 timestamp)
 Presents a window to the user. More...
 
void minimize ()
 Asks to minimize the specified window. More...
 
void unminimize ()
 Asks to unminimize the specified window. More...
 
void maximize ()
 Asks to maximize window, so that it fills the screen. More...
 
void unmaximize ()
 Asks to unmaximize window. More...
 
void fullscreen ()
 Asks to place window in the fullscreen state. More...
 
void unfullscreen ()
 Asks to remove the fullscreen state for window, and return to its previous state. More...
 
void fullscreen_on_monitor (const Glib::RefPtr< Gdk::Monitor > & monitor)
 Asks to place window in the fullscreen state on the given monitor. More...
 
void close ()
 Requests that the window is closed. More...
 
void set_default_size (int width, int height)
 Sets the default size of a window. More...
 
void get_default_size (int & width, int & height) const
 Gets the default size of the window. More...
 
Glib::RefPtr< WindowGroupget_group ()
 Returns the group for window. More...
 
Glib::RefPtr< const WindowGroupget_group () const
 Returns the group for window. More...
 
bool has_group () const
 Returns whether window has an explicit window group. More...
 
Glib::RefPtr< Applicationget_application ()
 Gets the Gtk::Application associated with the window. More...
 
Glib::RefPtr< const Applicationget_application () const
 Gets the Gtk::Application associated with the window. More...
 
void set_application (const Glib::RefPtr< Application > & application)
 Sets the Gtk::Application associated with the window. More...
 
void unset_application ()
 Unsets the Application associated with the window. More...
 
void set_child (Widget & child)
 Sets the child widget of window. More...
 
void unset_child ()
 
Widgetget_child ()
 Gets the child widget of window. More...
 
const Widgetget_child () const
 Gets the child widget of window. More...
 
void set_titlebar (Widget & titlebar)
 Sets a custom titlebar for window. More...
 
void unset_titlebar ()
 Unsets the titlebar. More...
 
Widgetget_titlebar ()
 Returns the custom titlebar that has been set with set_titlebar(). More...
 
const Widgetget_titlebar () const
 Returns the custom titlebar that has been set with set_titlebar(). More...
 
bool is_maximized () const
 Retrieves the current maximized state of window. More...
 
bool is_fullscreen () const
 Retrieves the current fullscreen state of window. More...
 
void set_handle_menubar_accel (bool handle_menubar_accel)
 Sets whether this window should react to F10 key presses by activating a menubar it contains. More...
 
bool get_handle_menubar_accel () const
 Returns whether this window reacts to F10 key presses by activating a menubar it contains. More...
 
void set_manage () override
 Used by Gtk::manage() and Gtk::make_managed(). More...
 
Glib::RefPtr< Gdk::Displayget_display ()
 Returns the display that this Gtk::Root is on. More...
 
Glib::RefPtr< const Gdk::Displayget_display () const
 Returns the display that this Gtk::Root is on. More...
 
- Public Member Functions inherited from Gtk::Widget
 Widget (Widget && src) noexcept
 
Widgetoperator= (Widget && src) noexcept
 
 Widget (const Widget &)=delete
 
Widgetoperator= (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...
 
Glib::RefPtr< ConstraintTargetmake_refptr_constrainttarget ()
 Converts this widget to a reference counted Gtk::ConstraintTarget. More...
 
Glib::RefPtr< const ConstraintTargetmake_refptr_constrainttarget () const
 Converts this widget to a reference counted Gtk::ConstraintTarget. More...
 
void show ()
 Flags a widget to be displayed. More...
 
void hide ()
 Reverses the effects of show(). More...
 
void queue_draw ()
 Schedules this widget to be redrawn in the paint phase of the current or the next frame. More...
 
void queue_resize ()
 Flags a widget to have its size renegotiated. More...
 
void queue_allocate ()
 Flags the widget for a rerun of the size_allocate_vfunc() function. More...
 
void size_allocate (const Allocation & allocation, int baseline)
 Allocates widget with a transformation that translates the origin to the position in allocation. More...
 
SizeRequestMode get_request_mode () const
 Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More...
 
void measure (Orientation orientation, int for_size, int & minimum, int & natural, int & minimum_baseline, int & natural_baseline) const
 Measures widget in the orientation orientation and for the given for_size. 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 set_layout_manager (const Glib::RefPtr< LayoutManager > & layout_manager)
 Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget. More...
 
void unset_layout_manager ()
 Undoes the effect of a previous call to set_layout_manager(). More...
 
Glib::RefPtr< LayoutManagerget_layout_manager ()
 Retrieves the layout manager used by widget. More...
 
Glib::RefPtr< const LayoutManagerget_layout_manager () const
 Retrieves the layout manager used by widget. More...
 
bool mnemonic_activate (bool group_cycling)
 Emits the signal_mnemonic_activate() signal. More...
 
bool activate ()
 For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More...
 
void set_can_focus (bool can_focus=true)
 Specifies whether the input focus can enter the widget or any of its children. More...
 
bool get_can_focus () const
 Determines whether the input focus can enter widget or any of its children. More...
 
void set_focusable (bool focusable=true)
 Specifies whether widget can own the input focus. More...
 
bool get_focusable () 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...
 
bool 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_target (bool can_target=true)
 Sets whether widget can be the target of pointer events. More...
 
bool get_can_target () const
 Queries whether widget can be the target of pointer events. More...
 
bool has_default () const
 Determines whether widget is the current default widget within its toplevel. 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...
 
void set_name (const Glib::ustring & name)
 Sets a widgets name. More...
 
void unset_name ()
 
Glib::ustring get_name () const
 Retrieves the name of a widget. More...
 
void set_state_flags (StateFlags flags, bool clear=true)
 Turns on flag values in the current widget state. More...
 
void unset_state_flags (StateFlags flags)
 Turns off flag values for the current widget state. 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. More...
 
bool is_sensitive () const
 Returns the widget’s effective sensitivity. 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 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_child_visible (bool visible=true)
 Sets whether widget should be mapped along with its parent. More...
 
bool get_child_visible () const
 Gets the value set with set_child_visible(). 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...
 
Allocation get_allocation () const
 Retrieves the widget’s location. More...
 
int get_width () const
 Returns the content width of the widget. More...
 
int get_height () const
 Returns the content height of the widget. More...
 
int get_size (Orientation orientation) const
 Returns the content width or height of the widget. More...
 
Widgetget_parent ()
 Returns the parent widget of widget. More...
 
const Widgetget_parent () const
 Returns the parent widget of widget. More...
 
Rootget_root ()
 Returns the Gtk::Root widget of widget. More...
 
const Rootget_root () const
 Returns the Gtk::Root widget of widget. More...
 
Nativeget_native ()
 Returns the nearest Gtk::Native ancestor of widget. More...
 
const Nativeget_native () const
 Returns the nearest Gtk::Native ancestor of widget. More...
 
bool child_focus (DirectionType direction)
 Called by widgets as the user moves around the window using keyboard shortcuts. More...
 
bool keynav_failed (DirectionType direction)
 Emits the ::keynav-failed signal on the widget. 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. 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_opacity (double opacity)
 Request the widget to be rendered partially transparent. More...
 
double get_opacity () const
 #Fetches the requested opacity for this widget. More...
 
void set_overflow (Overflow overflow)
 Sets how widget treats content that is drawn outside the widget's content area. More...
 
Overflow get_overflow () const
 Returns the widgets overflow value. More...
 
Widgetget_ancestor (GType widget_type)
 Gets the first ancestor of widget with type widget_type. More...
 
const Widgetget_ancestor (GType widget_type) const
 Gets the first ancestor of widget with type widget_type. 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::Displayget_display ()
 Get the Gdk::Display for the toplevel window associated with this widget. More...
 
Glib::RefPtr< const Gdk::Displayget_display () const
 Get the Gdk::Display for the toplevel window associated with this widget. More...
 
Glib::RefPtr< Settingsget_settings ()
 Gets the settings object holding the settings used for this widget. More...
 
Glib::RefPtr< Gdk::Clipboardget_clipboard ()
 Gets the clipboard object for widget. More...
 
Glib::RefPtr< const Gdk::Clipboardget_clipboard () const
 Gets the clipboard object for widget. More...
 
Glib::RefPtr< Gdk::Clipboardget_primary_clipboard ()
 Gets the primary clipboard of widget. More...
 
Glib::RefPtr< const Gdk::Clipboardget_primary_clipboard () const
 Gets the primary clipboard of 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 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 will be used. More...
 
bool compute_expand (Orientation orientation)
 Computes whether a container should give this widget extra space when possible. More...
 
void set_expand (bool expand=true)
 Sets whether the widget would like any available extra space in both directions. More...
 
Align get_halign () const
 Gets the horizontal alignment of widget. More...
 
void set_halign (Align align)
 Sets the horizontal alignment of widget. More...
 
Align get_valign () const
 Gets the vertical alignment of widget. More...
 
void set_valign (Align align)
 Sets the vertical alignment of widget. More...
 
int get_margin_start () const
 Gets the start margin of widget. More...
 
void set_margin_start (int margin)
 Sets the start margin of widget. More...
 
int get_margin_end () const
 Gets the end margin of widget. More...
 
void set_margin_end (int margin)
 Sets the end margin of widget. More...
 
int get_margin_top () const
 Gets the top margin of widget. More...
 
void set_margin_top (int margin)
 Sets the top margin of widget. More...
 
int get_margin_bottom () const
 Gets the bottom margin of widget. More...
 
void set_margin_bottom (int margin)
 Sets the bottom margin of widget. More...
 
void set_margin (int margin)
 Set all 4 margins to the same value. 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, double src_x, double src_y, double & dest_x, double & dest_y)
 Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More...
 
bool contains (double x, double y) const
 Tests if the point at ( x, y) is contained in widget. More...
 
Widgetpick (double x, double y, PickFlags flags=PickFlags::DEFAULT)
 Finds the descendant of widget closest to the point ( x, y). More...
 
const Widgetpick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const
 Finds the descendant of widget closest to the point ( x, y). More...
 
void add_controller (const Glib::RefPtr< EventController > & controller)
 Adds controller to widget so that it will receive events. More...
 
void remove_controller (const Glib::RefPtr< EventController > & controller)
 Removes controller from widget, so that it doesn't process events anymore. 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 of widget. 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...
 
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 set_cursor (const Glib::RefPtr< Gdk::Cursor > & cursor)
 Sets the cursor to be shown when pointer devices point towards widget. More...
 
void set_cursor (const Glib::ustring & name={})
 Sets a named cursor to be shown when pointer devices point towards the widget. More...
 
Glib::RefPtr< Gdk::Cursorget_cursor ()
 Queries the cursor set on widget. More...
 
Glib::RefPtr< const Gdk::Cursorget_cursor () const
 Queries the cursor set on widget. More...
 
std::vector< Widget * > list_mnemonic_labels ()
 Returns the widgets for which this widget is the target of a mnemonic. More...
 
std::vector< const Widget * > list_mnemonic_labels () const
 Returns the widgets for which this widget is the target of a mnemonic. 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...
 
bool drag_check_threshold (int start_x, int start_y, int current_x, int current_y)
 Checks to see if a drag movement has passed the GTK drag threshold. More...
 
Glib::RefPtr< Gdk::FrameClockget_frame_clock ()
 Obtains the frame clock for a widget. More...
 
Glib::RefPtr< const Gdk::FrameClockget_frame_clock () const
 Obtains the frame clock for a widget. More...
 
void set_parent (Widget & parent)
 Sets parent as the parent widget of widget. More...
 
void unparent ()
 Dissociate widget from its parent. More...
 
void map ()
 Causes a widget to be mapped if it isn’t already. More...
 
void unmap ()
 Causes a widget to be unmapped if it’s currently mapped. 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...
 
bool in_destruction () const
 Returns whether the widget is currently being destroyed. More...
 
Glib::RefPtr< StyleContextget_style_context ()
 Returns the style context associated to widget. More...
 
Glib::RefPtr< const StyleContextget_style_context () const
 Returns the style context associated to widget. 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...
 
bool activate_action (const Glib::ustring & name, const Glib::VariantBase & args={})
 Looks up the action in the action groups associated with the widget and its ancestors, and activates it. More...
 
void activate_default ()
 Activates the default.activate action from 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 of widget. More...
 
Glib::RefPtr< const Pango::FontMap > get_font_map () const
 Gets the font map of widget. More...
 
Widgetget_first_child ()
 Returns the widgets first child. More...
 
const Widgetget_first_child () const
 Returns the widgets first child. More...
 
Widgetget_last_child ()
 Returns the widgets last child. More...
 
const Widgetget_last_child () const
 Returns the widgets last child. More...
 
Widgetget_next_sibling ()
 Returns the widgets next sibling. More...
 
const Widgetget_next_sibling () const
 Returns the widgets next sibling. More...
 
Widgetget_prev_sibling ()
 Returns the widgets previous sibling. More...
 
const Widgetget_prev_sibling () const
 Returns the widgets previous sibling. More...
 
Glib::RefPtr< Gio::ListModel > observe_children ()
 Returns a Gio::ListModel to track the children of widget. More...
 
Glib::RefPtr< const Gio::ListModel > observe_children () const
 Returns a Gio::ListModel to track the children of widget. More...
 
Glib::RefPtr< Gio::ListModel > observe_controllers ()
 Returns a Gio::ListModel to track the Gtk::EventControllers of widget. More...
 
Glib::RefPtr< const Gio::ListModel > observe_controllers () const
 Returns a Gio::ListModel to track the Gtk::EventControllers of widget. More...
 
void insert_after (Widget & parent, const Widget & previous_sibling)
 Inserts the Widget into the child widget list of parent after previous_sibling. More...
 
void insert_before (Widget & parent, const Widget & next_sibling)
 Inserts the Widget into the child widget list of parent before next_sibling. More...
 
void insert_at_start (Widget & parent)
 Inserts the Widget at the beginning of the child widget list of parent. More...
 
void insert_at_end (Widget & parent)
 Inserts the Widget at the end of the child widget list of parent. More...
 
void snapshot_child (Widget & child, const Glib::RefPtr< Gtk::Snapshot > & snapshot)
 Snapshot the a child of widget. More...
 
bool should_layout () const
 Returns whether widget should contribute to the measuring and allocation of its parent. More...
 
Glib::ustring get_css_name () const
 Returns the CSS name that is used for self. More...
 
void add_css_class (const Glib::ustring & css_class)
 Adds a style class to widget. More...
 
void remove_css_class (const Glib::ustring & css_class)
 Removes a style from widget. More...
 
bool has_css_class (const Glib::ustring & css_class) const
 Returns whether css_class is currently applied to widget. More...
 
std::vector< Glib::ustring > get_css_classes () const
 Returns the list of style classes applied to widget. More...
 
void set_css_classes (const std::vector< Glib::ustring > & classes)
 Clear all style classes applied to widget and replace them with classes. More...
 
Gdk::RGBA get_color () const
 Gets the current foreground color for the widget's CSS style. 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(Gtk::StateFlags)> signal_state_flags_changed ()
 
Glib::SignalProxy< void(TextDirection)> signal_direction_changed ()
 
Glib::SignalProxy< bool(bool)> signal_mnemonic_activate ()
 
Glib::SignalProxy< void()> signal_destroy ()
 Emitted during the dispose phase. More...
 
Glib::SignalProxy< bool(int, int, bool, const Glib::RefPtr< Tooltip > &)> signal_query_tooltip ()
 
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_ReadOnly< Widget * > property_parent () const
 The parent widget of this widget. More...
 
Glib::PropertyProxy_ReadOnly< Root * > property_root () const
 The Gtk::Root widget of the widget tree containing this widget. More...
 
Glib::PropertyProxy< int > property_width_request ()
 Override for width request of the widget. More...
 
Glib::PropertyProxy_ReadOnly< int > property_width_request () const
 Override for width request of the widget. More...
 
Glib::PropertyProxy< int > property_height_request ()
 Override for height request of the widget. More...
 
Glib::PropertyProxy_ReadOnly< int > property_height_request () const
 Override for height request of the widget. 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_can_focus ()
 Whether the widget or any of its descendents can accept the input focus. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_can_focus () const
 Whether the widget or any of its descendents can accept the input focus. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_focus () const
 Whether the widget has the input focus. More...
 
Glib::PropertyProxy< bool > property_can_target ()
 Whether the widget can receive pointer events. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_can_target () const
 Whether the widget can receive pointer events. 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_focusable ()
 Whether this widget itself will accept the input focus. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_focusable () const
 Whether this widget itself will accept the input focus. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_default () const
 Whether the widget is the default widget. More...
 
Glib::PropertyProxy< bool > property_receives_default ()
 Whether the widget will receive the default action when it is focused. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_receives_default () const
 Whether the widget will receive the default action when it is focused. More...
 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Cursor > > property_cursor ()
 The cursor used by widget. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Cursor > > property_cursor () const
 The cursor used by widget. More...
 
Glib::PropertyProxy< bool > property_has_tooltip ()
 Enables or disables the emission of the signal_query_tooltip() signal on widget. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_has_tooltip () const
 Enables or disables the emission of the signal_query_tooltip() signal 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 Pango markup. 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 Pango markup. 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< Alignproperty_halign ()
 How to distribute horizontal space if widget gets extra space. More...
 
Glib::PropertyProxy_ReadOnly< Alignproperty_halign () const
 How to distribute horizontal space if widget gets extra space. More...
 
Glib::PropertyProxy< Alignproperty_valign ()
 How to distribute vertical space if widget gets extra space. More...
 
Glib::PropertyProxy_ReadOnly< Alignproperty_valign () const
 How to distribute vertical space if widget gets extra space. 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< 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 hexpand property. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_hexpand_set () const
 Whether to use the 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 vexpand property. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_vexpand_set () const
 Whether to use the vexpand property. 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< Overflowproperty_overflow ()
 How content outside the widget's content area is treated. More...
 
Glib::PropertyProxy_ReadOnly< Overflowproperty_overflow () const
 How content outside the widget's content area is treated. More...
 
Glib::PropertyProxy_ReadOnly< int > property_scale_factor () const
 The scale factor of the widget. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_css_name () const
 The name of this widget in the CSS tree. More...
 
Glib::PropertyProxy< std::vector< Glib::ustring > > property_css_classes ()
 A list of css classes applied to this widget. More...
 
Glib::PropertyProxy_ReadOnly< std::vector< Glib::ustring > > property_css_classes () const
 A list of css classes applied to this widget. More...
 
Glib::PropertyProxy< Glib::RefPtr< LayoutManager > > property_layout_manager ()
 The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< LayoutManager > > property_layout_manager () const
 The Gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children. More...
 
- Public Member Functions inherited from Gtk::Object
 Object (Object && src) noexcept
 
Objectoperator= (Object && src) noexcept
 
 ~Object () noexcept override
 
- Public Member Functions inherited from Gtk::Accessible
 Accessible (Accessible && src) noexcept
 
Accessibleoperator= (Accessible && src) noexcept
 
 ~Accessible () noexcept override
 
GtkAccessible * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkAccessible * gobj () const
 Provides access to the underlying C GObject. More...
 
Role get_accessible_role () const
 Retrieves the Gtk::Accessible::Role for the given Gtk::Accessible. More...
 
void update_state (State state, const Glib::ValueBase & value)
 Updates an accessible state. More...
 
void update_property (Property property, const Glib::ValueBase & value)
 Updates an accessible property. More...
 
void update_relation (Relation relation, const Glib::ValueBase & value)
 Updates an accessible relation. More...
 
void reset_state (State state)
 Resets the accessible state to its default value. More...
 
void reset_property (Property property)
 Resets the accessible property to its default value. More...
 
void reset_relation (Relation relation)
 Resets the accessible relation to its default value. More...
 
Glib::PropertyProxy< Roleproperty_accessible_role ()
 The accessible role of the given Gtk::Accessible implementation. More...
 
Glib::PropertyProxy_ReadOnly< Roleproperty_accessible_role () const
 The accessible role of the given Gtk::Accessible implementation. More...
 
- Public Member Functions inherited from Gtk::Buildable
 Buildable (Buildable && src) noexcept
 
Buildableoperator= (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...
 
Glib::ustring get_buildable_id () const
 Gets the ID of the buildable object. More...
 
- Public Member Functions inherited from Gtk::ConstraintTarget
 ConstraintTarget (ConstraintTarget && src) noexcept
 
ConstraintTargetoperator= (ConstraintTarget && src) noexcept
 
 ~ConstraintTarget () noexcept override
 
GtkConstraintTarget * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkConstraintTarget * gobj () const
 Provides access to the underlying C GObject. More...
 
- Public Member Functions inherited from Gtk::Native
 Native (Native && src) noexcept
 
Nativeoperator= (Native && src) noexcept
 
 ~Native () noexcept override
 
GtkNative * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkNative * gobj () const
 Provides access to the underlying C GObject. More...
 
void realize ()
 Realizes a Gtk::Native. More...
 
void unrealize ()
 Unrealizes a Gtk::Native. More...
 
Glib::RefPtr< Gdk::Surfaceget_surface ()
 Returns the surface of this Gtk::Native. More...
 
Glib::RefPtr< const Gdk::Surfaceget_surface () const
 Returns the surface of this Gtk::Native. More...
 
void get_surface_transform (double & x, double & y)
 Retrieves the surface transform of self. More...
 
- Public Member Functions inherited from Gtk::ShortcutManager
 ShortcutManager (ShortcutManager && src) noexcept
 
ShortcutManageroperator= (ShortcutManager && src) noexcept
 
 ~ShortcutManager () noexcept override
 
GtkShortcutManager * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkShortcutManager * gobj () const
 Provides access to the underlying C GObject. More...
 
- Public Member Functions inherited from Gtk::Root
 Root (Root && src) noexcept
 
Rootoperator= (Root && src) noexcept
 
 ~Root () noexcept override
 
GtkRoot * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkRoot * gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::RefPtr< Gdk::Displayget_display ()
 Returns the display that this Gtk::Root is on. More...
 
Glib::RefPtr< const Gdk::Displayget_display () const
 Returns the display that this Gtk::Root is on. More...
 
void set_focus (Widget & focus)
 If focus is not the current focus widget, and is focusable, sets it as the focus widget for the root. More...
 
void unset_focus ()
 Unsets the focus widget for the root. More...
 
Widgetget_focus ()
 Retrieves the current focused widget within the root. More...
 
const Widgetget_focus () const
 Retrieves the current focused widget within the root. 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::Window
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
static void set_default_icon_name (const Glib::ustring & name)
 Sets an icon to be used as fallback. More...
 
static Glib::ustring get_default_icon_name ()
 Returns the fallback icon name for windows. More...
 
static void set_auto_startup_notification (bool setting=true)
 Sets whether the window should request startup notification. More...
 
static Glib::RefPtr< Gio::ListModel > get_toplevels ()
 Returns a list of all existing toplevel windows. More...
 
static std::vector< Window * > list_toplevels ()
 Returns a list of all existing toplevel windows. 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 void set_default_direction (TextDirection dir)
 Sets the default reading direction for widgets. More...
 
static TextDirection get_default_direction ()
 Obtains the current default reading direction. More...
 
- Static Public Member Functions inherited from Gtk::Accessible
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...
 
- 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...
 
- Static Public Member Functions inherited from Gtk::ConstraintTarget
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...
 
- Static Public Member Functions inherited from Gtk::Native
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...
 
static Nativeget_for_surface (const Glib::RefPtr< const Gdk::Surface > & surface)
 Finds the Gtk::Native associated with the surface. More...
 
- Static Public Member Functions inherited from Gtk::ShortcutManager
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...
 
- Static Public Member Functions inherited from Gtk::Root
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 void on_response (int response_id)
 This is a default handler for the signal signal_response(). More...
 
- Protected Member Functions inherited from Gtk::Window
void on_window_hide ()
 
void destroy_ ()
 
virtual void on_keys_changed ()
 This is a default handler for the signal signal_keys_changed(). More...
 
virtual bool on_close_request ()
 This is a default handler for the signal signal_close_request(). More...
 
- Protected Member Functions inherited from Gtk::Widget
virtual void root_vfunc ()
 
virtual void unroot_vfunc ()
 
virtual void size_allocate_vfunc (int width, int height, int baseline)
 
virtual SizeRequestMode get_request_mode_vfunc () const
 
virtual void measure_vfunc (Orientation orientation, int for_size, int & minimum, int & natural, int & minimum_baseline, int & natural_baseline) const
 
virtual bool grab_focus_vfunc ()
 
virtual void set_focus_child_vfunc (Widget * child)
 Sets the focused child of widget. More...
 
virtual void compute_expand_vfunc (bool & hexpand_p, bool & vexpand_p)
 
virtual bool contains_vfunc (double x, double y) const
 
virtual void snapshot_vfunc (const Glib::RefPtr< Gtk::Snapshot > & snapshot)
 
 Widget ()
 
void realize ()
 Creates the GDK resources associated with a widget. More...
 
void unrealize ()
 Causes a widget to be unrealized (frees all GDK resources associated with the widget). More...
 
void realize_if_needed ()
 
void set_focus_child (Widget & child)
 Set child as the current focus child of widget. More...
 
void unset_focus_child ()
 Unsets the focus child of the widget. More...
 
Widgetget_focus_child ()
 Returns the current focus child of widget. More...
 
const Widgetget_focus_child () const
 Returns the current focus child of widget. More...
 
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_state_flags_changed (Gtk::StateFlags previous_state_flags)
 This is a default handler for the signal signal_state_flags_changed(). More...
 
virtual void on_direction_changed (TextDirection direction)
 This is a default handler for the signal signal_direction_changed(). More...
 
virtual bool on_mnemonic_activate (bool group_cycling)
 This is a default handler for the signal signal_mnemonic_activate(). More...
 
virtual bool on_query_tooltip (int x, int y, bool keyboard_tooltip, const Glib::RefPtr< Tooltip > & tooltip)
 This is a default handler for the signal signal_query_tooltip(). More...
 
- Protected Member Functions inherited from Gtk::Accessible
 Accessible ()
 You should derive from this class to use it. More...
 
- Protected Member Functions inherited from Gtk::Buildable
 Buildable ()
 You should derive from this class to use it. More...
 
- Protected Member Functions inherited from Gtk::ConstraintTarget
 ConstraintTarget ()
 You should derive from this class to use it. More...
 
- Protected Member Functions inherited from Gtk::Native
 Native ()
 You should derive from this class to use it. More...
 
- Protected Member Functions inherited from Gtk::ShortcutManager
 ShortcutManager ()
 You should derive from this class to use it. More...
 
virtual void add_controller_vfunc (const Glib::RefPtr< ShortcutController > & controller)
 
virtual void remove_controller_vfunc (const Glib::RefPtr< ShortcutController > & controller)
 
- Protected Member Functions inherited from Gtk::Root
 Root ()
 You should derive from this class to use it. More...
 

Related Functions

(Note that these are not member functions.)

Gtk::Dialogwrap (GtkDialog * 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...
 
- Public Types inherited from Gtk::Accessible
enum class  Role {
  ALERT ,
  ALERT_DIALOG ,
  BANNER ,
  BUTTON ,
  CAPTION ,
  CELL ,
  CHECKBOX ,
  COLUMN_HEADER ,
  COMBO_BOX ,
  COMMAND ,
  COMPOSITE ,
  DIALOG ,
  DOCUMENT ,
  FEED ,
  FORM ,
  GENERIC ,
  GRID ,
  GRID_CELL ,
  GROUP ,
  HEADING ,
  IMG ,
  INPUT ,
  LABEL ,
  LANDMARK ,
  LEGEND ,
  LINK ,
  LIST ,
  LIST_BOX ,
  LIST_ITEM ,
  LOG ,
  MAIN ,
  MARQUEE ,
  MATH ,
  METER ,
  MENU ,
  MENU_BAR ,
  MENU_ITEM ,
  MENU_ITEM_CHECKBOX ,
  MENU_ITEM_RADIO ,
  NAVIGATION ,
  NONE ,
  NOTE ,
  OPTION ,
  PRESENTATION ,
  PROGRESS_BAR ,
  RADIO ,
  RADIO_GROUP ,
  RANGE ,
  REGION ,
  ROW ,
  ROW_GROUP ,
  ROW_HEADER ,
  SCROLLBAR ,
  SEARCH ,
  SEARCH_BOX ,
  SECTION ,
  SECTION_HEAD ,
  SELECT ,
  SEPARATOR ,
  SLIDER ,
  SPIN_BUTTON ,
  STATUS ,
  STRUCTURE ,
  SWITCH ,
  TAB ,
  TABLE ,
  TAB_LIST ,
  TAB_PANEL ,
  TEXT_BOX ,
  TIME ,
  TIMER ,
  TOOLBAR ,
  TOOLTIP ,
  TREE ,
  TREE_GRID ,
  TREE_ITEM ,
  WIDGET ,
  WINDOW
}
 The accessible role for a Gtk::Accessible implementation. More...
 
enum class  State {
  BUSY ,
  CHECKED ,
  DISABLED ,
  EXPANDED ,
  HIDDEN ,
  INVALID ,
  PRESSED ,
  SELECTED
}
 The possible accessible states of a Gtk::Accessible. More...
 
enum class  Property {
  AUTOCOMPLETE ,
  DESCRIPTION ,
  HAS_POPUP ,
  KEY_SHORTCUTS ,
  LABEL ,
  LEVEL ,
  MODAL ,
  MULTI_LINE ,
  MULTI_SELECTABLE ,
  ORIENTATION ,
  PLACEHOLDER ,
  READ_ONLY ,
  REQUIRED ,
  ROLE_DESCRIPTION ,
  SORT ,
  VALUE_MAX ,
  VALUE_MIN ,
  VALUE_NOW ,
  VALUE_TEXT
}
 The possible accessible properties of a Gtk::Accessible. More...
 
enum class  Relation {
  ACTIVE_DESCENDANT ,
  COL_COUNT ,
  COL_INDEX ,
  COL_INDEX_TEXT ,
  COL_SPAN ,
  CONTROLS ,
  DESCRIBED_BY ,
  DETAILS ,
  ERROR_MESSAGE ,
  FLOW_TO ,
  LABELLED_BY ,
  OWNS ,
  POS_IN_SET ,
  ROW_COUNT ,
  ROW_INDEX ,
  ROW_INDEX_TEXT ,
  ROW_SPAN ,
  SET_SIZE
}
 The possible accessible relations of a Gtk::Accessible. More...
 

Detailed Description

Create popup windows.

Dialog boxes are a convenient way to prompt the user for a small amount of input, eg. to display a message, ask a question, or anything else that does not require extensive effort on the user's part.

The main area of a Dialog is called the "content area", and is yours to populate with widgets such a Gtk::Label or Gtk::Entry, to present your information, questions, or tasks to the user.

In addition, dialogs allow you to add "action widgets". Most commonly, action widgets are buttons. Depending on the platform, action widgets may be presented in the header bar at the top of the window, or at the bottom of the window.

When adding buttons using add_button(), clicking the button will emit signal_response() with a "response id" you specified. You are encouraged to use the Gtk::ResponseType enum (these all have values less than zero). If a dialog receives a delete event, the "response" signal will be emitted with a response id of Gtk::ResponseType::DELETE_EVENT.

A “modal” dialog (that is, one which freezes the rest of the application from user input), can be created by calling Gtk::Window::set_modal() on the dialog. It is also possible to set the modal property in the constructor.

Deprecated:
4.10:

Constructor & Destructor Documentation

◆ Dialog() [1/5]

Gtk::Dialog::Dialog ( Dialog &&  src)
noexcept

◆ Dialog() [2/5]

Gtk::Dialog::Dialog ( const Dialog )
delete

◆ ~Dialog()

Gtk::Dialog::~Dialog ( )
overridenoexcept

◆ Dialog() [3/5]

Gtk::Dialog::Dialog ( )

◆ Dialog() [4/5]

Gtk::Dialog::Dialog ( const Glib::ustring &  title,
bool  modal = false,
bool  use_header_bar = false 
)
explicit

◆ Dialog() [5/5]

Gtk::Dialog::Dialog ( const Glib::ustring &  title,
Gtk::Window parent,
bool  modal = false,
bool  use_header_bar = false 
)

Member Function Documentation

◆ add_action_widget()

void Gtk::Dialog::add_action_widget ( Widget child,
int  response_id 
)

Adds an activatable widget to the action area of a Gtk::Dialog.

GTK connects a signal handler that will emit the signal_response() signal on the dialog when the widget is activated. The widget is appended to the end of the dialog’s action area.

If you want to add a non-activatable widget, simply pack it into the action_area field of the Gtk::Dialog struct.

Parameters
childAn activatable widget.
response_idResponse ID for child.

◆ add_button()

Button* Gtk::Dialog::add_button ( const Glib::ustring &  button_text,
int  response_id 
)

Adds a button with the given text.

GTK arranges things so that clicking the button will emit the signal_response() signal with the given response_id. The button is appended to the end of the dialog’s action area. The button widget is returned, but usually you don’t need it.

Parameters
button_textText of button.
response_idResponse ID for the button.
Returns
The Gtk::Button widget that was added.

◆ get_content_area() [1/2]

Box* Gtk::Dialog::get_content_area ( )

Returns the content area of dialog.

Returns
The content area Gtk::Box.

◆ get_content_area() [2/2]

const Box* Gtk::Dialog::get_content_area ( ) const

Returns the content area of dialog.

Returns
The content area Gtk::Box.

◆ get_header_bar() [1/2]

HeaderBar* Gtk::Dialog::get_header_bar ( )

Returns the header bar of dialog.

Note that the headerbar is only used by the dialog if the property_use_header_bar() property is true.

Returns
The header bar.

◆ get_header_bar() [2/2]

const HeaderBar* Gtk::Dialog::get_header_bar ( ) const

Returns the header bar of dialog.

Note that the headerbar is only used by the dialog if the property_use_header_bar() property is true.

Returns
The header bar.

◆ get_response_for_widget()

int Gtk::Dialog::get_response_for_widget ( const Gtk::Widget widget) const

Gets the response id of a widget in the action area of a dialog.

Parameters
widgetA widget in the action area of dialog.
Returns
The response id of widget, or Gtk::ResponseType::NONE if widget doesn’t have a response id set.

◆ get_type()

static GType Gtk::Dialog::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ get_widget_for_response() [1/2]

Widget* Gtk::Dialog::get_widget_for_response ( int  response_id)

Gets the widget button that uses the given response ID in the action area of a dialog.

Parameters
response_idThe response ID used by the dialog widget.
Returns
The widget button that uses the given response_id.

◆ get_widget_for_response() [2/2]

const Widget* Gtk::Dialog::get_widget_for_response ( int  response_id) const

Gets the widget button that uses the given response ID in the action area of a dialog.

Parameters
response_idThe response ID used by the dialog widget.
Returns
The widget button that uses the given response_id.

◆ gobj() [1/2]

GtkDialog* Gtk::Dialog::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkDialog* Gtk::Dialog::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ on_response()

virtual void Gtk::Dialog::on_response ( int  response_id)
protectedvirtual

This is a default handler for the signal signal_response().

◆ operator=() [1/2]

Dialog& Gtk::Dialog::operator= ( const Dialog )
delete

◆ operator=() [2/2]

Dialog& Gtk::Dialog::operator= ( Dialog &&  src)
noexcept

◆ property_use_header_bar()

Glib::PropertyProxy_ReadOnly< bool > Gtk::Dialog::property_use_header_bar ( ) const

true if the dialog uses a headerbar for action buttons instead of the action-area.

For technical reasons, this property is declared as an integer property, but you should only set it to true or false.

Creating a dialog with headerbar

Builtin Gtk::Dialog subclasses such as Gtk::ColorChooserDialog set this property according to platform conventions (using the Gtk::Settings::property_gtk_dialogs_use_header() setting).

Here is how you can achieve the same:

[C example ellipted]

Default value: -1

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ response()

void Gtk::Dialog::response ( int  response_id)

Emits the signal_response() signal with the given response ID.

Used to indicate that the user has responded to the dialog in some way.

Parameters
response_idResponse ID.

◆ set_default_response()

void Gtk::Dialog::set_default_response ( int  response_id)

Sets the default widget for the dialog based on the response ID.

Pressing “Enter” normally activates the default widget.

Parameters
response_idA response ID.

◆ set_response_sensitive()

void Gtk::Dialog::set_response_sensitive ( int  response_id,
bool  setting = true 
)

A convenient way to sensitize/desensitize dialog buttons.

Calls gtk_widget_set_sensitive (widget, @a setting) for each widget in the dialog’s action area with the given response_id.

Parameters
response_idA response ID.
settingtrue for sensitive.

◆ signal_response()

Glib::SignalProxy<void(int)> Gtk::Dialog::signal_response ( )
Slot Prototype:
void on_my_response(int response_id)

Flags: Run Last

Emitted when an action widget is clicked.

The signal is also emitted when the dialog receives a delete event, and when Gtk::Dialog::response() is called. On a delete event, the response ID is Gtk::ResponseType::DELETE_EVENT. Otherwise, it depends on which action widget was clicked.

Parameters
response_idThe response ID.

Friends And Related Function Documentation

◆ wrap()

Gtk::Dialog * wrap ( GtkDialog *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse 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.