Gtk::Window Class Reference

Toplevel Window. More...

#include <gtkmm/window.h>

Inheritance diagram for Gtk::Window:

Public Member Functions
	Window (const Window &)=delete
Window &	operator= (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
Window &	operator= (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_ReadOnly< bool >	property_suspended () const
	Whether the window is suspended. 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 ()
Widget *	get_focus ()
	Retrieves the current focused widget within the window. More...
const Widget *	get_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 ()
Widget *	get_default_widget ()
	Returns the default widget for window. More...
const Widget *	get_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...
Window *	get_transient_for ()
	Fetches the transient parent for this window. More...
const Window *	get_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 in response to an user interaction. 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< WindowGroup >	get_group ()
	Returns the group for window. More...
Glib::RefPtr< const WindowGroup >	get_group () const
	Returns the group for window. More...
bool	has_group () const
	Returns whether window has an explicit window group. More...
Glib::RefPtr< Application >	get_application ()
	Gets the Gtk::Application associated with the window. More...
Glib::RefPtr< const Application >	get_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 ()
Widget *	get_child ()
	Gets the child widget of window. More...
const Widget *	get_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...
Widget *	get_titlebar ()
	Returns the custom titlebar that has been set with set_titlebar(). More...
const Widget *	get_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...
bool	is_suspended () const
	Retrieves the current suspended 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::Display >	get_display ()
	Returns the display that this Gtk::Root is on. More...
Glib::RefPtr< const Gdk::Display >	get_display () const
	Returns the display that this Gtk::Root is on. More...
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...
Glib::RefPtr< ConstraintTarget >	make_refptr_constrainttarget ()
	Converts this widget to a reference counted Gtk::ConstraintTarget. More...
Glib::RefPtr< const ConstraintTarget >	make_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...
Measurements	measure (Orientation orientation, int for_size=-1) const
	Like the other overload of measure() but returns a structure holding the sizes/baselines instead of using output parameters. 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...
PreferredSize	get_preferred_size () const
	Like the other overload of get_preferred_size() but returns a structure holding the sizes instead of using output parameters. 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< LayoutManager >	get_layout_manager ()
	Retrieves the layout manager used by widget. More...
Glib::RefPtr< const LayoutManager >	get_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...
std::optional< Gdk::Graphene::Rect >	compute_bounds (const Widget & target) const
	Computes the bounds for the widget in the coordinate space of target. More...
std::optional< Gdk::Graphene::Point >	compute_point (const Widget & target, const Gdk::Graphene::Point & point) const
	Translates the given point in the widget's coordinates to coordinates relative to target’s coordinate system. 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_baseline () const
	Returns the baseline that has currently been allocated to widget. More...
int	get_size (Orientation orientation) const
	Returns the content width or height of the widget. More...
Widget *	get_parent ()
	Returns the parent widget of widget. More...
const Widget *	get_parent () const
	Returns the parent widget of widget. More...
Root *	get_root ()
	Returns the Gtk::Root widget of widget. More...
const Root *	get_root () const
	Returns the Gtk::Root widget of widget. More...
Native *	get_native ()
	Returns the nearest Gtk::Native ancestor of widget. More...
const Native *	get_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...
Requisition	get_size_request () const
	Like the other overload of get_size_request() but returns a structure holding the sizes instead of using output parameters. 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 widget’s overflow value. 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...
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< Settings >	get_settings ()
	Gets the settings object holding the settings used for this widget. More...
Glib::RefPtr< Gdk::Clipboard >	get_clipboard ()
	Gets the clipboard object for widget. More...
Glib::RefPtr< const Gdk::Clipboard >	get_clipboard () const
	Gets the clipboard object for widget. More...
Glib::RefPtr< Gdk::Clipboard >	get_primary_clipboard ()
	Gets the primary clipboard of widget. More...
Glib::RefPtr< const Gdk::Clipboard >	get_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...
Widget *	pick (double x, double y, PickFlags flags=PickFlags::DEFAULT)
	Finds the descendant of widget closest to the point ( x, y). More...
const Widget *	pick (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::Cursor >	get_cursor ()
	Queries the cursor set on widget. More...
Glib::RefPtr< const Gdk::Cursor >	get_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::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...
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< StyleContext >	get_style_context ()
	Returns the style context associated to widget. More...
Glib::RefPtr< const StyleContext >	get_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...
Widget *	get_first_child ()
	Returns the widget’s first child. More...
const Widget *	get_first_child () const
	Returns the widget’s first child. More...
Widget *	get_last_child ()
	Returns the widget’s last child. More...
const Widget *	get_last_child () const
	Returns the widget’s last child. More...
Widget *	get_next_sibling ()
	Returns the widget’s next sibling. More...
const Widget *	get_next_sibling () const
	Returns the widget’s next sibling. More...
Widget *	get_prev_sibling ()
	Returns the widget’s previous sibling. More...
const Widget *	get_prev_sibling () const
	Returns the widget’s previous sibling. More...
std::vector< Widget * >	get_children ()
	Gets a vector of the widgetʼs current children, from first child to last. More...
std::vector< const Widget * >	get_children () const
	Gets a vector of the widgetʼs current children, from first child to last. 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< Align >	property_halign ()
	How to distribute horizontal space if widget gets extra space. More...
Glib::PropertyProxy_ReadOnly< Align >	property_halign () const
	How to distribute horizontal space if widget gets extra space. More...
Glib::PropertyProxy< Align >	property_valign ()
	How to distribute vertical space if widget gets extra space. More...
Glib::PropertyProxy_ReadOnly< Align >	property_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< Overflow >	property_overflow ()
	How content outside the widget's content area is treated. More...
Glib::PropertyProxy_ReadOnly< Overflow >	property_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
Object &	operator= (Object && src) noexcept
	~Object () noexcept override
Public Member Functions inherited from Gtk::Accessible
	Accessible (Accessible && src) noexcept
Accessible &	operator= (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...
Glib::RefPtr< ATContext >	get_at_context ()
	Retrieves the accessible implementation for the given Gtk::Accessible. More...
Glib::RefPtr< const ATContext >	get_at_context () const
	Retrieves the accessible implementation for the given Gtk::Accessible. More...
bool	get_platform_state (PlatformState state) const
	Query a platform state, such as focus. More...
Glib::RefPtr< Accessible >	get_accessible_parent ()
	Retrieves the accessible parent for an accessible object. More...
Glib::RefPtr< const Accessible >	get_accessible_parent () const
	Retrieves the accessible parent for an accessible object. More...
void	set_accessible_parent (const Glib::RefPtr< Accessible > & parent, const Glib::RefPtr< Accessible > & next_sibling)
	Sets the parent and sibling of an accessible object. More...
Glib::RefPtr< Accessible >	get_first_accessible_child ()
	Retrieves the first accessible child of an accessible object. More...
Glib::RefPtr< const Accessible >	get_first_accessible_child () const
	Retrieves the first accessible child of an accessible object. More...
Glib::RefPtr< Accessible >	get_next_accessible_sibling ()
	Retrieves the next accessible sibling of an accessible object. More...
Glib::RefPtr< const Accessible >	get_next_accessible_sibling () const
	Retrieves the next accessible sibling of an accessible object. More...
void	update_next_accessible_sibling (const Glib::RefPtr< Accessible > & new_sibling)
	Updates the next accessible sibling of self. More...
bool	get_bounds (int & x, int & y, int & width, int & height) const
	Queries the coordinates and dimensions of this accessible. More...
Role	get_accessible_role () const
	Retrieves the accessible role of an accessible object. 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...
void	announce (const Glib::ustring & message, AnnouncementPriority priority)
	Requests the user's screen reader to announce the given message. More...
Glib::PropertyProxy< Role >	property_accessible_role ()
	The accessible role of the given Gtk::Accessible implementation. More...
Glib::PropertyProxy_ReadOnly< Role >	property_accessible_role () const
	The accessible role of the given Gtk::Accessible implementation. 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...
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
ConstraintTarget &	operator= (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
Native &	operator= (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::Surface >	get_surface ()
	Returns the surface of this Gtk::Native. More...
Glib::RefPtr< const Gdk::Surface >	get_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
ShortcutManager &	operator= (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
Root &	operator= (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::Display >	get_display ()
	Returns the display that this Gtk::Root is on. More...
Glib::RefPtr< const Gdk::Display >	get_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...
Widget *	get_focus ()
	Retrieves the current focused widget within the root. More...
const Widget *	get_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 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 Native *	get_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
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...
Widget *	get_focus_child ()
	Returns the current focus child of widget. More...
const Widget *	get_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::Window *	wrap (GtkWindow * 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::Accessible
Glib::RefPtr< Gtk::Accessible >	wrap (GtkAccessible * 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...
Related Functions inherited from Gtk::ConstraintTarget
Glib::RefPtr< Gtk::ConstraintTarget >	wrap (GtkConstraintTarget * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...
Related Functions inherited from Gtk::Native
Glib::RefPtr< Gtk::Native >	wrap (GtkNative * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...
Related Functions inherited from Gtk::ShortcutManager
Glib::RefPtr< Gtk::ShortcutManager >	wrap (GtkShortcutManager * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...
Related Functions inherited from Gtk::Root
Glib::RefPtr< Gtk::Root >	wrap (GtkRoot * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Additional Inherited Members
Public Types inherited from Gtk::Widget
using	PreferredSize = MinimumNatural< Requisition >
	Structure returned by the non-output-parameter overload of get_preferred_size(). More...
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 {   Role::ALERT ,   Role::ALERT_DIALOG ,   Role::BANNER ,   Role::BUTTON ,   Role::CAPTION ,   Role::CELL ,   Role::CHECKBOX ,   Role::COLUMN_HEADER ,   Role::COMBO_BOX ,   Role::COMMAND ,   Role::COMPOSITE ,   Role::DIALOG ,   Role::DOCUMENT ,   Role::FEED ,   Role::FORM ,   Role::GENERIC ,   Role::GRID ,   Role::GRID_CELL ,   Role::GROUP ,   Role::HEADING ,   Role::IMG ,   Role::INPUT ,   Role::LABEL ,   Role::LANDMARK ,   Role::LEGEND ,   Role::LINK ,   Role::LIST ,   Role::LIST_BOX ,   Role::LIST_ITEM ,   Role::LOG ,   Role::MAIN ,   Role::MARQUEE ,   Role::MATH ,   Role::METER ,   Role::MENU ,   Role::MENU_BAR ,   Role::MENU_ITEM ,   Role::MENU_ITEM_CHECKBOX ,   Role::MENU_ITEM_RADIO ,   Role::NAVIGATION ,   Role::NONE ,   Role::NOTE ,   Role::OPTION ,   Role::PRESENTATION ,   Role::PROGRESS_BAR ,   Role::RADIO ,   Role::RADIO_GROUP ,   Role::RANGE ,   Role::REGION ,   Role::ROW ,   Role::ROW_GROUP ,   Role::ROW_HEADER ,   Role::SCROLLBAR ,   Role::SEARCH ,   Role::SEARCH_BOX ,   Role::SECTION ,   Role::SECTION_HEAD ,   Role::SELECT ,   Role::SEPARATOR ,   Role::SLIDER ,   Role::SPIN_BUTTON ,   Role::STATUS ,   Role::STRUCTURE ,   Role::SWITCH ,   Role::TAB ,   Role::TABLE ,   Role::TAB_LIST ,   Role::TAB_PANEL ,   Role::TEXT_BOX ,   Role::TIME ,   Role::TIMER ,   Role::TOOLBAR ,   Role::TOOLTIP ,   Role::TREE ,   Role::TREE_GRID ,   Role::TREE_ITEM ,   Role::WIDGET ,   Role::WINDOW ,   Role::TOGGLE_BUTTON ,   Role::APPLICATION ,   Role::PARAGRAPH ,   Role::BLOCK_QUOTE ,   Role::ARTICLE ,   Role::COMMENT ,   Role::TERMINAL }
	The accessible role for a Gtk::Accessible implementation. More...
enum class	State {   State::BUSY ,   State::CHECKED ,   State::DISABLED ,   State::EXPANDED ,   State::HIDDEN ,   State::INVALID ,   State::PRESSED ,   State::SELECTED ,   State::VISITED }
	The possible accessible states of a Gtk::Accessible. More...
enum class	Property {   Property::AUTOCOMPLETE ,   Property::DESCRIPTION ,   Property::HAS_POPUP ,   Property::KEY_SHORTCUTS ,   Property::LABEL ,   Property::LEVEL ,   Property::MODAL ,   Property::MULTI_LINE ,   Property::MULTI_SELECTABLE ,   Property::ORIENTATION ,   Property::PLACEHOLDER ,   Property::READ_ONLY ,   Property::REQUIRED ,   Property::ROLE_DESCRIPTION ,   Property::SORT ,   Property::VALUE_MAX ,   Property::VALUE_MIN ,   Property::VALUE_NOW ,   Property::VALUE_TEXT }
	The possible accessible properties of a Gtk::Accessible. More...
enum class	Relation {   Relation::ACTIVE_DESCENDANT ,   Relation::COL_COUNT ,   Relation::COL_INDEX ,   Relation::COL_INDEX_TEXT ,   Relation::COL_SPAN ,   Relation::CONTROLS ,   Relation::DESCRIBED_BY ,   Relation::DETAILS ,   Relation::ERROR_MESSAGE ,   Relation::FLOW_TO ,   Relation::LABELLED_BY ,   Relation::OWNS ,   Relation::POS_IN_SET ,   Relation::ROW_COUNT ,   Relation::ROW_INDEX ,   Relation::ROW_INDEX_TEXT ,   Relation::ROW_SPAN ,   Relation::SET_SIZE }
	The possible accessible relations of a Gtk::Accessible. More...
enum class	PlatformState {   PlatformState::FOCUSABLE ,   PlatformState::FOCUSED ,   PlatformState::ACTIVE }
	The various platform states which can be queried using Gtk::Accessible::get_platform_state(). More...
enum class	AnnouncementPriority {   AnnouncementPriority::LOW ,   AnnouncementPriority::MEDIUM ,   AnnouncementPriority::HIGH }
	The priority of an accessibility announcement. More...

Detailed Description

Toplevel Window.

This represents all widgets which are physical windows controlled by the window manager.

The window will be destroyed when the window manager's close button is clicked. Call set_hide_on_close() if you want it to be hidden instead.

When a window is closed (hidden), it's removed from its application. This can cause Application::run() to return, if it is the last window.

Constructor & Destructor Documentation

Window() [1/3]

Gtk::Window::Window ( const Window &  )

delete

~Window()

Gtk::Window::~Window ( )

overridenoexcept

Window() [2/3]

Gtk::Window::Window ( Window &&  src )

noexcept

Window() [3/3]

Gtk::Window::Window ( )

explicit

Member Function Documentation

close()

void Gtk::Window::close

(

)

Requests that the window is closed.

This is similar to what happens when a window manager close button is clicked.

This function can be used with close buttons in custom titlebars.

destroy()

void Gtk::Window::destroy

(

)

Drop the internal reference GTK holds on toplevel windows.

If this window is managed, this C++ wrapper will be deleted when the underlying C instance is destroyed.

After a call to destroy(), don't call any method that accesses the underlying C instance.

If the C++ wrapper is deleted, the underlying C instance will be destroyed. If the C instance is destroyed and the C++ wrapper is managed, the wrapper will be deleted. The difference is in the order in which actions are taken. That may or may not be important. If the C instance is destroyed before the wrapper is deleted, C++ signal handlers can be called during the destruction. For instance, if you connect to Gtk::Widget::signal_unrealize() or override Gtk::Widget::on_unrealize(), those signal handlers can be called only if the wrapper still exists when the signal is emitted.

Since gtkmm 4.8:

destroy_()

void Gtk::Window::destroy_ ( )

protected

fullscreen()

void Gtk::Window::fullscreen

(

)

Asks to place window in the fullscreen state.

Note that you shouldn’t assume the window is definitely fullscreen afterward, because other entities (e.g. the user or window manager) unfullscreen it again, and not all window managers honor requests to fullscreen windows.

You can track the result of this operation via the Gdk::Toplevel::property_state() property, or by listening to notifications of the property_fullscreened() property.

fullscreen_on_monitor()

void Gtk::Window::fullscreen_on_monitor

(

const Glib::RefPtr< Gdk::Monitor > &

monitor

)

Asks to place window in the fullscreen state on the given monitor.

Note that you shouldn't assume the window is definitely fullscreen afterward, or that the windowing system allows fullscreen windows on any given monitor.

You can track the result of this operation via the Gdk::Toplevel::property_state() property, or by listening to notifications of the property_fullscreened() property.

Parameters

monitor

Which monitor to go fullscreen on.

get_application() [1/2]

Glib::RefPtr< Application > Gtk::Window::get_application

(

)

Gets the Gtk::Application associated with the window.

Returns

A Gtk::Application.

get_application() [2/2]

Glib::RefPtr< const Application > Gtk::Window::get_application

(

)

const

Gets the Gtk::Application associated with the window.

Returns

A Gtk::Application.

get_child() [1/2]

Widget * Gtk::Window::get_child

(

)

Gets the child widget of window.

Returns

The child widget of window.

get_child() [2/2]

const Widget * Gtk::Window::get_child

(

)

const

Gets the child widget of window.

Returns

The child widget of window.

get_decorated()

bool Gtk::Window::get_decorated

(

)

const

Returns whether the window has been set to have decorations.

Returns

true if the window has been set to have decorations.

get_default_icon_name()

static Glib::ustring Gtk::Window::get_default_icon_name ( )

static

Returns the fallback icon name for windows.

The returned string is owned by GTK and should not be modified. It is only valid until the next call to set_default_icon_name().

Returns

The fallback icon name for windows.

get_default_size()

void Gtk::Window::get_default_size	(	int &	width,
		int &	height
	)		const

Gets the default size of the window.

A value of 0 for the width or height indicates that a default size has not been explicitly set for that dimension, so the “natural” size of the window will be used.

This function is the recommended way for saving window state across restarts of applications.

Parameters

width	Location to store the default width.
height	Location to store the default height.

get_default_widget() [1/2]

Widget * Gtk::Window::get_default_widget

(

)

Returns the default widget for window.

Returns

The default widget.

get_default_widget() [2/2]

const Widget * Gtk::Window::get_default_widget

(

)

const

Returns the default widget for window.

Returns

The default widget.

get_deletable()

bool Gtk::Window::get_deletable

(

)

const

Returns whether the window has been set to have a close button.

Returns

true if the window has been set to have a close button.

get_destroy_with_parent()

bool Gtk::Window::get_destroy_with_parent

(

)

const

Returns whether the window will be destroyed with its transient parent.

Returns

true if the window will be destroyed with its transient parent.

get_display() [1/2]

Glib::RefPtr< Gdk::Display > Gtk::Root::get_display

(

)

Returns the display that this Gtk::Root is on.

Returns

The display of root.

get_display() [2/2]

Glib::RefPtr< const Gdk::Display > Gtk::Root::get_display

(

)

const

Returns the display that this Gtk::Root is on.

Returns

The display of root.

get_focus() [1/2]

Widget * Gtk::Window::get_focus

(

)

Retrieves the current focused widget within the window.

Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then gtk_widget_has_focus (widget) will not be true for the widget.

Returns

The currently focused widget.

get_focus() [2/2]

const Widget * Gtk::Window::get_focus

(

)

const

Retrieves the current focused widget within the window.

Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then gtk_widget_has_focus (widget) will not be true for the widget.

Returns

The currently focused widget.

get_focus_visible()

bool Gtk::Window::get_focus_visible

(

)

const

Gets whether “focus rectangles” are supposed to be visible.

Returns

true if “focus rectangles” are supposed to be visible in this window.

get_group() [1/2]

Glib::RefPtr< WindowGroup > Gtk::Window::get_group

(

)

Returns the group for window.

If the window has no group, then the default group is returned.

Returns

The Gtk::WindowGroup for a window or the default group.

get_group() [2/2]

Glib::RefPtr< const WindowGroup > Gtk::Window::get_group

(

)

const

Returns the group for window.

If the window has no group, then the default group is returned.

Returns

The Gtk::WindowGroup for a window or the default group.

get_handle_menubar_accel()

bool Gtk::Window::get_handle_menubar_accel

(

)

const

Returns whether this window reacts to F10 key presses by activating a menubar it contains.

Since gtkmm 4.2:

Returns

true if the window handles F10.

get_hide_on_close()

bool Gtk::Window::get_hide_on_close

(

)

const

Returns whether the window will be hidden when the close button is clicked.

Returns

true if the window will be hidden.

get_icon_name()

Glib::ustring Gtk::Window::get_icon_name

(

)

const

Returns the name of the themed icon for the window.

Returns

The icon name.

get_mnemonics_visible()

bool Gtk::Window::get_mnemonics_visible

(

)

const

Gets whether mnemonics are supposed to be visible.

Returns

true if mnemonics are supposed to be visible in this window.

get_modal()

bool Gtk::Window::get_modal

(

)

const

Returns whether the window is modal.

Returns

true if the window is set to be modal and establishes a grab when shown.

get_resizable()

bool Gtk::Window::get_resizable

(

)

const

Gets the value set by set_resizable().

Returns

true if the user can resize the window.

get_title()

Glib::ustring Gtk::Window::get_title

(

)

const

Retrieves the title of the window.

Returns

The title of the window.

get_titlebar() [1/2]

Widget * Gtk::Window::get_titlebar

(

)

Returns the custom titlebar that has been set with set_titlebar().

Returns

The custom titlebar.

get_titlebar() [2/2]

const Widget * Gtk::Window::get_titlebar

(

)

const

Returns the custom titlebar that has been set with set_titlebar().

Returns

The custom titlebar.

get_toplevels()

static Glib::RefPtr< Gio::ListModel > Gtk::Window::get_toplevels ( )

static

Returns a list of all existing toplevel windows.

If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets or add new ones, be aware that the list of toplevels will change and emit the "items-changed" signal.

Returns

The list of toplevel widgets.

get_transient_for() [1/2]

Window * Gtk::Window::get_transient_for

(

)

Fetches the transient parent for this window.

Returns

The transient parent for this window.

get_transient_for() [2/2]

const Window * Gtk::Window::get_transient_for

(

)

const

Fetches the transient parent for this window.

Returns

The transient parent for this window.

get_type()

static GType Gtk::Window::get_type ( )

static

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

gobj() [1/2]

GtkWindow * Gtk::Window::gobj ( )

inline

Provides access to the underlying C GObject.

gobj() [2/2]

const GtkWindow * Gtk::Window::gobj ( ) const

inline

Provides access to the underlying C GObject.

has_group()

bool Gtk::Window::has_group

(

)

const

Returns whether window has an explicit window group.

Returns

true if window has an explicit window group.

is_active()

bool Gtk::Window::is_active

(

)

const

Returns whether the window is part of the current active toplevel.

The active toplevel is the window receiving keystrokes.

The return value is true if the window is active toplevel itself. You might use this function if you wanted to draw a widget differently in an active window from a widget in an inactive window.

Returns

true if the window part of the current active window.

is_fullscreen()

bool Gtk::Window::is_fullscreen

(

)

const

Retrieves the current fullscreen state of window.

Note that since fullscreening is ultimately handled by the window manager and happens asynchronously to an application request, you shouldn’t assume the return value of this function changing immediately (or at all), as an effect of calling fullscreen() or unfullscreen().

If the window isn't yet mapped, the value returned will whether the initial requested state is fullscreen.

Returns

Whether the window has a fullscreen state.

is_maximized()

bool Gtk::Window::is_maximized

(

)

const

Retrieves the current maximized state of window.

Note that since maximization is ultimately handled by the window manager and happens asynchronously to an application request, you shouldn’t assume the return value of this function changing immediately (or at all), as an effect of calling maximize() or unmaximize().

If the window isn't yet mapped, the value returned will whether the initial requested state is maximized.

Returns

Whether the window has a maximized state.

is_suspended()

bool Gtk::Window::is_suspended

(

)

const

Retrieves the current suspended state of window.

A window being suspended means it's currently not visible to the user, for example by being on a inactive workspace, minimized, obstructed.

Since gtkmm 4.12:

Returns

Whether the window is suspended.

list_toplevels()

static std::vector< Window * > Gtk::Window::list_toplevels ( )

static

Returns a list of all existing toplevel windows.

The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call g_list_foreach (result, (GFunc)g_object_ref, <tt>nullptr</tt>) first, and then unref all the widgets afterwards.

Returns

List of toplevel widgets.

maximize()

void Gtk::Window::maximize

(

)

Asks to maximize window, so that it fills the screen.

Note that you shouldn’t assume the window is definitely maximized afterward, because other entities (e.g. the user or window manager) could unmaximize it again, and not all window managers support maximization.

It’s permitted to call this function before showing a window, in which case the window will be maximized when it appears onscreen initially.

You can track the result of this operation via the Gdk::Toplevel::property_state() property, or by listening to notifications on the property_maximized() property.

minimize()

void Gtk::Window::minimize

(

)

Asks to minimize the specified window.

Note that you shouldn’t assume the window is definitely minimized afterward, because the windowing system might not support this functionality; other entities (e.g. the user or the window manager) could unminimize it again, or there may not be a window manager in which case minimization isn’t possible, etc.

It’s permitted to call this function before showing a window, in which case the window will be minimized before it ever appears onscreen.

You can track result of this operation via the Gdk::Toplevel::property_state() property.

on_close_request()

virtual bool Gtk::Window::on_close_request ( )

protectedvirtual

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

on_keys_changed()

virtual void Gtk::Window::on_keys_changed ( )

protectedvirtual

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

on_window_hide()

void Gtk::Window::on_window_hide ( )

protected

operator=() [1/2]

Window & Gtk::Window::operator= ( const Window &  )

delete

operator=() [2/2]

Window & Gtk::Window::operator= ( Window &&  src )

noexcept

present() [1/2]

void Gtk::Window::present

(

)

Presents a window to the user.

This may mean raising the window in the stacking order, unminimizing it, moving it to the current desktop and/or giving it the keyboard focus (possibly dependent on the user’s platform, window manager and preferences).

If window is hidden, this function also makes it visible.

present() [2/2]

void Gtk::Window::present

(

guint32

timestamp

)

Presents a window to the user in response to an user interaction.

See present() for more details.

The timestamp should be gathered when the window was requested to be shown (when clicking a link for example), rather than once the window is ready to be shown.

Deprecated: 4.14: Use present()

Deprecated:

Use the present() overload without a parameter.

Parameters

timestamp

The timestamp of the user interaction (typically a button or key press event) which triggered this call.

property_application() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Application > > Gtk::Window::property_application

(

)

The Gtk::Application associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it (see Glib::application_hold() for a way to keep it alive without windows).

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the :application property to nullptr.

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_application() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Application > > Gtk::Window::property_application

(

)

const

The Gtk::Application associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it (see Glib::application_hold() for a way to keep it alive without windows).

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the :application property to nullptr.

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_child() [1/2]

Glib::PropertyProxy< Widget * > Gtk::Window::property_child

(

)

The child widget.

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_child() [2/2]

Glib::PropertyProxy_ReadOnly< Widget * > Gtk::Window::property_child

(

)

const

The child widget.

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_decorated() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_decorated

(

)

Whether the window should have a frame (also known as decorations).

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_decorated() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_decorated

(

)

const

Whether the window should have a frame (also known as decorations).

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_default_height() [1/2]

Glib::PropertyProxy< int > Gtk::Window::property_default_height

(

)

The default height of the window.

Default value: 0

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_default_height() [2/2]

Glib::PropertyProxy_ReadOnly< int > Gtk::Window::property_default_height

(

)

const

The default height of the window.

Default value: 0

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_default_widget() [1/2]

Glib::PropertyProxy< Widget * > Gtk::Window::property_default_widget

(

)

The default widget.

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_default_widget() [2/2]

Glib::PropertyProxy_ReadOnly< Widget * > Gtk::Window::property_default_widget

(

)

const

The default widget.

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_default_width() [1/2]

Glib::PropertyProxy< int > Gtk::Window::property_default_width

(

)

The default width of the window.

Default value: 0

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_default_width() [2/2]

Glib::PropertyProxy_ReadOnly< int > Gtk::Window::property_default_width

(

)

const

The default width of the window.

Default value: 0

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_deletable() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_deletable

(

)

Whether the window frame should have a close button.

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_deletable() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_deletable

(

)

const

Whether the window frame should have a close button.

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_destroy_with_parent() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_destroy_with_parent

(

)

If this window should be destroyed when the parent is destroyed.

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_destroy_with_parent() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_destroy_with_parent

(

)

const

If this window should be destroyed when the parent is destroyed.

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_display() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Gdk::Display > > Gtk::Window::property_display

(

)

The display that will display this window.

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_display() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Display > > Gtk::Window::property_display

(

)

const

The display that will display this window.

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_focus_visible() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_focus_visible

(

)

Whether 'focus rectangles' are currently visible in this window.

This property is maintained by GTK based on user input and should not be set by applications.

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_focus_visible() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_focus_visible

(

)

const

Whether 'focus rectangles' are currently visible in this window.

This property is maintained by GTK based on user input and should not be set by applications.

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_focus_widget() [1/2]

Glib::PropertyProxy< Widget * > Gtk::Window::property_focus_widget

(

)

The focus widget.

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_focus_widget() [2/2]

Glib::PropertyProxy_ReadOnly< Widget * > Gtk::Window::property_focus_widget

(

)

const

The focus widget.

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_fullscreened() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_fullscreened

(

)

Whether the window is fullscreen.

Setting this property is the equivalent of calling Gtk::Window::fullscreen() or Gtk::Window::unfullscreen(); either operation is asynchronous, which means you will need to connect to the signal_notify() signal in order to know whether the operation was successful.

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_fullscreened() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_fullscreened

(

)

const

Whether the window is fullscreen.

Setting this property is the equivalent of calling Gtk::Window::fullscreen() or Gtk::Window::unfullscreen(); either operation is asynchronous, which means you will need to connect to the signal_notify() signal in order to know whether the operation was successful.

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_handle_menubar_accel() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_handle_menubar_accel

(

)

Whether the window frame should handle F10 for activating menubars.

Since gtkmm 4.2:

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_handle_menubar_accel() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_handle_menubar_accel

(

)

const

Whether the window frame should handle F10 for activating menubars.

Since gtkmm 4.2:

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_hide_on_close() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_hide_on_close

(

)

If this window should be hidden when the users clicks the close button.

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_hide_on_close() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_hide_on_close

(

)

const

If this window should be hidden when the users clicks the close button.

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_icon_name() [1/2]

Glib::PropertyProxy< Glib::ustring > Gtk::Window::property_icon_name

(

)

Specifies the name of the themed icon to use as the window icon.

See Gtk::IconTheme for more details.

Default value: ""

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_icon_name() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Window::property_icon_name

(

)

const

Specifies the name of the themed icon to use as the window icon.

See Gtk::IconTheme for more details.

Default value: ""

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_is_active()

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_is_active

(

)

const

Whether the toplevel is the currently active window.

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_maximized() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_maximized

(

)

Whether the window is maximized.

Setting this property is the equivalent of calling Gtk::Window::maximize() or Gtk::Window::unmaximize(); either operation is asynchronous, which means you will need to connect to the signal_notify() signal in order to know whether the operation was successful.

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_maximized() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_maximized

(

)

const

Whether the window is maximized.

Setting this property is the equivalent of calling Gtk::Window::maximize() or Gtk::Window::unmaximize(); either operation is asynchronous, which means you will need to connect to the signal_notify() signal in order to know whether the operation was successful.

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_mnemonics_visible() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_mnemonics_visible

(

)

Whether mnemonics are currently visible in this window.

This property is maintained by GTK based on user input, and should not be set by applications.

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_mnemonics_visible() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_mnemonics_visible

(

)

const

Whether mnemonics are currently visible in this window.

This property is maintained by GTK based on user input, and should not be set by applications.

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_modal() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_modal

(

)

If true, the window is modal.

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_modal() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_modal

(

)

const

If true, the window is modal.

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_resizable() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_resizable

(

)

If true, users can resize the window.

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_resizable() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_resizable

(

)

const

If true, users can resize the window.

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_startup_id()

Glib::PropertyProxy_WriteOnly< Glib::ustring > Gtk::Window::property_startup_id

(

)

A write-only property for setting window's startup notification identifier.

Default value: ""

Returns

A PropertyProxy_WriteOnly that allows you to set the value of the property, or receive notification when the value of the property changes.

property_suspended()

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_suspended

(

)

const

Whether the window is suspended.

See Gtk::Window::is_suspended() for details about what suspended means.

Since gtkmm 4.12:

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_title() [1/2]

Glib::PropertyProxy< Glib::ustring > Gtk::Window::property_title

(

)

The title of the window.

Default value: ""

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_title() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Window::property_title

(

)

const

The title of the window.

Default value: ""

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_titlebar() [1/2]

Glib::PropertyProxy< Widget * > Gtk::Window::property_titlebar

(

)

The titlebar widget.

Since gtkmm 4.6:

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_titlebar() [2/2]

Glib::PropertyProxy_ReadOnly< Widget * > Gtk::Window::property_titlebar

(

)

const

The titlebar widget.

Since gtkmm 4.6:

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_transient_for() [1/2]

Glib::PropertyProxy< Window * > Gtk::Window::property_transient_for

(

)

The transient parent of the window.

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_transient_for() [2/2]

Glib::PropertyProxy_ReadOnly< Window * > Gtk::Window::property_transient_for

(

)

const

The transient parent of the window.

Returns

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

set_application()

void Gtk::Window::set_application

(

const Glib::RefPtr< Application > &

application

)

Sets the Gtk::Application associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it. (See Gio::Application::hold() for a way to keep it alive without windows.)

Normally, the connection between the application and the window will remain until the window is closed (hidden), but you can explicitly remove it by calling unset_application().

This is equivalent to calling Gtk::Application::remove_window() and/or Gtk::Application::add_window() on the old/new applications as relevant.

Parameters

application

A Gtk::Application.

set_auto_startup_notification()

static void Gtk::Window::set_auto_startup_notification ( bool  setting = true )

static

Sets whether the window should request startup notification.

By default, after showing the first Gtk::Window, GTK calls Gdk::Toplevel::set_startup_id(). Call this function to disable the automatic startup notification. You might do this if your first window is a splash screen, and you want to delay notification until after your real main window has been shown, for example.

In that example, you would disable startup notification temporarily, show your splash screen, then re-enable it so that showing the main window would automatically result in notification.

Parameters

setting

true to automatically do startup notification.

set_child()

void Gtk::Window::set_child

(

Widget &

child

)

Sets the child widget of window.

Parameters

child

The child widget.

set_decorated()

void Gtk::Window::set_decorated

(

bool

setting = true

)

Sets whether the window should be decorated.

By default, windows are decorated with a title bar, resize controls, etc. Some window managers allow GTK to disable these decorations, creating a borderless window. If you set the decorated property to false using this function, GTK will do its best to convince the window manager not to decorate the window. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling Gtk::Widget::show().

On Windows, this function always works, since there’s no window manager policy involved.

Parameters

setting

true to decorate the window.

set_default_icon_name()

static void Gtk::Window::set_default_icon_name ( const Glib::ustring &  name )

static

Sets an icon to be used as fallback.

The fallback icon is used for windows that haven't had set_icon_name() called on them.

Parameters

name	The name of the themed icon.

set_default_size()

void Gtk::Window::set_default_size	(	int	width,
		int	height
	)

Sets the default size of a window.

The default size of a window is the size that will be used if no other constraints apply.

The default size will be updated whenever the window is resized to reflect the new size, unless the window is forced to a size, like when it is maximized or fullscreened.

If the window’s minimum size request is larger than the default, the default will be ignored.

Setting the default size to a value <= 0 will cause it to be ignored and the natural size request will be used instead. It is possible to do this while the window is showing to "reset" it to its initial size.

Unlike Gtk::Widget::set_size_request(), which sets a size request for a widget and thus would keep users from shrinking the window, this function only sets the initial size, just as if the user had resized the window themselves. Users can still shrink the window again as they normally would. Setting a default size of -1 means to use the “natural” default size (the size request of the window).

If you use this function to reestablish a previously saved window size, note that the appropriate size to save is the one returned by get_default_size(). Using the window allocation directly will not work in all circumstances and can lead to growing or shrinking windows.

Parameters

width	Width in pixels, or -1 to unset the default width.
height	Height in pixels, or -1 to unset the default height.

set_default_widget()

void Gtk::Window::set_default_widget

(

Gtk::Widget &

default_widget

)

Sets the default widget.

The default widget is the widget that is activated when the user presses Enter in a dialog (for example).

Parameters

default_widget

Widget to be the default.

set_deletable()

void Gtk::Window::set_deletable

(

bool

setting = true

)

Sets whether the window should be deletable.

By default, windows have a close button in the window frame. Some window managers allow GTK to disable this button. If you set the deletable property to false using this function, GTK will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling Gtk::Widget::show().

On Windows, this function always works, since there’s no window manager policy involved.

Parameters

setting

true to decorate the window as deletable.

set_destroy_with_parent()

void Gtk::Window::set_destroy_with_parent

(

bool

setting = true

)

If setting is true, then destroying the transient parent of window will also destroy window itself.

This is useful for dialogs that shouldn’t persist beyond the lifetime of the main window they are associated with, for example.

Since gtkmm 4.8:

Parameters

setting

Whether to destroy window with its transient parent.

set_display()

void Gtk::Window::set_display

(

const Glib::RefPtr< Gdk::Display > &

display

)

Sets the Gdk::Display where the window is displayed.

If the window is already mapped, it will be unmapped, and then remapped on the new display.

Parameters

display

A Gdk::Display.

set_focus()

void Gtk::Window::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.

To set the focus to a particular widget in the toplevel, it is usually more convenient to use Gtk::Widget::grab_focus() instead of this function.

Parameters

focus

Widget to be the new focus widget.

set_focus_visible()

void Gtk::Window::set_focus_visible

(

bool

setting = true

)

Sets whether “focus rectangles” are supposed to be visible.

This property is maintained by GTK based on user input, and should not be set by applications.

Parameters

setting

The new value.

set_handle_menubar_accel()

void Gtk::Window::set_handle_menubar_accel

(

bool

handle_menubar_accel

)

Sets whether this window should react to F10 key presses by activating a menubar it contains.

Since gtkmm 4.2:

Parameters

handle_menubar_accel

true to make window handle F10.

set_hide_on_close()

void Gtk::Window::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.

Parameters

setting

Whether to hide the window when it is closed.

set_icon_name()

void Gtk::Window::set_icon_name

(

const Glib::ustring &

name

)

Sets the icon for the window from a named themed icon.

See the docs for Gtk::IconTheme for more details. On some platforms, the window icon is not used at all.

Note that this has nothing to do with the WM_ICON_NAME property which is mentioned in the ICCCM.

Since gtkmm 2.18:

Parameters

name	The name of the themed icon.

set_manage()

void Gtk::Window::set_manage ( )

override

Used by Gtk::manage() and Gtk::make_managed().

You should not need to use this directly. Overridden because a Gtk::Window is not managed by a container. Beginning with gtkmm 4.8, a Gtk::Window can be managed. If managed, it's deleted when its underlying C instance is destroyed.

set_mnemonics_visible()

void Gtk::Window::set_mnemonics_visible

(

bool

setting = true

)

Sets whether mnemonics are supposed to be visible.

This property is maintained by GTK based on user input, and should not be set by applications.

Parameters

setting

The new value.

set_modal()

void Gtk::Window::set_modal

(

bool

modal = true

)

Sets a window modal or non-modal.

Modal windows prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use set_transient_for() to make the dialog transient for the parent; most window managers will then disallow lowering the dialog below the parent.

Parameters

modal

Whether the window is modal.

set_resizable()

void Gtk::Window::set_resizable

(

bool

resizable = true

)

Sets whether the user can resize a window.

Windows are user resizable by default.

Parameters

resizable

true if the user can resize this window.

set_startup_id()

void Gtk::Window::set_startup_id

(

const Glib::ustring &

startup_id

)

Sets the startup notification ID.

Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other features. This function changes the corresponding property on the underlying Gdk::Surface.

Normally, startup identifier is managed automatically and you should only use this function in special cases like transferring focus from other processes. You should use this function before calling present() or any equivalent function generating a window map event.

This function is only useful on X11, not with other GTK targets.

Parameters

startup_id

A string with startup-notification identifier.

set_title()

void Gtk::Window::set_title

(

const Glib::ustring &

title

)

Sets the title of the Gtk::Window.

The title of a window will be displayed in its title bar; on the X Window System, the title bar is rendered by the window manager so exactly how the title appears to users may vary according to a user’s exact configuration. The title should help a user distinguish this window from other windows they may have open. A good title might include the application name and current document filename, for example.

Passing nullptr does the same as setting the title to an empty string.

Parameters

title

Title of the window.

set_titlebar()

void Gtk::Window::set_titlebar

(

Widget &

titlebar

)

Sets a custom titlebar for window.

A typical widget used here is Gtk::HeaderBar, as it provides various features expected of a titlebar while allowing the addition of child widgets to it.

If you set a custom titlebar, GTK will do its best to convince the window manager not to put its own titlebar on the window. Depending on the system, this function may not work for a window that is already visible, so you set the titlebar before calling Gtk::Widget::show().

Parameters

titlebar

The widget to use as titlebar.

set_transient_for()

void Gtk::Window::set_transient_for

(

Window &

parent

)

Dialog windows should be set transient for the main application window they were spawned from.

This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. Gtk::Dialog::new_with_buttons() and other convenience functions in GTK will sometimes call set_transient_for() on your behalf.

Passing nullptr for parent unsets the current transient window.

On Windows, this function puts the child window on top of the parent, much as the window manager would have done on X.

Parameters

parent

Parent window.

signal_close_request()

Glib::SignalProxy< bool()> Gtk::Window::signal_close_request

(

)

Slot Prototype:

bool on_my_close_request()

Flags: Run Last

Emitted when the user clicks on the close button of the window.

Return: true to stop other handlers from being invoked for the signal

signal_keys_changed()

Glib::SignalProxy< void()> Gtk::Window::signal_keys_changed

(

)

Slot Prototype:

void on_my_keys_changed()

Flags: Run First

emitted when the set of accelerators or mnemonics that are associated with window changes.

Deprecated: 4.10: Use Gtk::Shortcut and Gtk::EventController to implement keyboard shortcuts

Deprecated:

Use Gtk::Shortcut and Gtk::EventController to implement keyboard shortcuts.

unfullscreen()

void Gtk::Window::unfullscreen

(

)

Asks to remove the fullscreen state for window, and return to its previous state.

Note that you shouldn’t assume the window is definitely not fullscreen afterward, because other entities (e.g. the user or window manager) could fullscreen it again, and not all window managers honor requests to unfullscreen windows; normally the window will end up restored to its normal state. Just don’t write code that crashes if not.

You can track the result of this operation via the Gdk::Toplevel::property_state() property, or by listening to notifications of the property_fullscreened() property.

unmaximize()

void Gtk::Window::unmaximize

(

)

Asks to unmaximize window.

Note that you shouldn’t assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager) maximize it again, and not all window managers honor requests to unmaximize.

You can track the result of this operation via the Gdk::Toplevel::property_state() property, or by listening to notifications on the property_maximized() property.

unminimize()

void Gtk::Window::unminimize

(

)

Asks to unminimize the specified window.

Note that you shouldn’t assume the window is definitely unminimized afterward, because the windowing system might not support this functionality; other entities (e.g. the user or the window manager) could minimize it again, or there may not be a window manager in which case minimization isn’t possible, etc.

You can track result of this operation via the Gdk::Toplevel::property_state() property.

unset_application()

void Gtk::Window::unset_application

(

)

Unsets the Application associated with the window.

This could cause the application to exit if it is the application's last window.

unset_child()

void Gtk::Window::unset_child

(

)

unset_default_widget()

void Gtk::Window::unset_default_widget

(

)

unset_focus()

void Gtk::Window::unset_focus

(

)

unset_titlebar()

void Gtk::Window::unset_titlebar

(

)

Unsets the titlebar.

See also

set_titlebar()

unset_transient_for()

void Gtk::Window::unset_transient_for

(

)

Unsets the current transient window.

See also

set_transient_for().

Since gtkmm 2.20:

Friends And Related Function Documentation

wrap()

Gtk::Window * wrap ( GtkWindow *  object, bool  take_copy = false  )

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.