gtkmm
3.95.1
|
#include <gtkmm/window.h>
Public Member Functions | |
Window (Window&& src) noexcept | |
Window& | operator= (Window&& src) noexcept |
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 (WindowType type=WindowType::TOPLEVEL) | |
Glib::PropertyProxy_ReadOnly< WindowType > | property_type () const |
The type of the window. More... | |
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 () |
The :startup-id is 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 (other windows are not usable while this one is up). More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_modal () const |
If true , the window is modal (other windows are not usable while this one is up). More... | |
Glib::PropertyProxy< WindowPosition > | property_window_position () |
The initial position of the window. More... | |
Glib::PropertyProxy_ReadOnly< WindowPosition > | property_window_position () const |
The initial position of the window. More... | |
Glib::PropertyProxy< int > | property_default_width () |
The default width of the window, used when initially showing the window. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_default_width () const |
The default width of the window, used when initially showing the window. More... | |
Glib::PropertyProxy< int > | property_default_height () |
The default height of the window, used when initially showing the window. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_default_height () const |
The default height of the window, used when initially showing 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 user clicks the close button. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_hide_on_close () const |
If this window should be hidden when the user 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 () |
The :icon-name property specifies the name of the themed icon to use as the window icon. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_icon_name () const |
The :icon-name property 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 current active window. More... | |
Glib::PropertyProxy< Gdk::Surface::TypeHint > | property_type_hint () |
Hint to help the desktop environment understand what kind of window this is and how to treat it. More... | |
Glib::PropertyProxy_ReadOnly< Gdk::Surface::TypeHint > | property_type_hint () const |
Hint to help the desktop environment understand what kind of window this is and how to treat it. More... | |
Glib::PropertyProxy< bool > | property_decorated () |
Whether the window should be decorated by the window manager. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_decorated () const |
Whether the window should be decorated by the window manager. 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_accept_focus () |
Whether the window should receive the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_accept_focus () const |
Whether the window should receive the input focus. More... | |
Glib::PropertyProxy< bool > | property_focus_on_map () |
Whether the window should receive the input focus when mapped. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_focus_on_map () const |
Whether the window should receive the input focus when mapped. 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< Widget* > | property_attached_to () |
The widget to which this window is attached. More... | |
Glib::PropertyProxy_ReadOnly< Widget* > | property_attached_to () const |
The widget to which this window is attached. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_is_maximized () const |
Whether the window is maximized. More... | |
Glib::PropertyProxy< Widget* > | property_default_widget () |
The default widget. More... | |
Glib::PropertyProxy_ReadOnly< Widget* > | property_default_widget () const |
The default widget. 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) |
Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other features. More... | |
void | add_accel_group (const Glib::RefPtr< AccelGroup >& accel_group) |
Associate accel_group with window, such that calling gtk_accel_groups_activate() on window will activate accelerators in accel_group. More... | |
void | remove_accel_group (const Glib::RefPtr< AccelGroup >& accel_group) |
Reverses the effects of add_accel_group(). More... | |
void | set_position (WindowPosition position) |
Sets a position constraint for this window. 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) |
The default widget is the widget that’s activated when the user presses Enter in a dialog (for example). 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 | unset_attached_to () |
Unsets the attached-to widget. More... | |
void | set_attached_to (Widget& attach_widget) |
Marks window as attached to attach_widget. More... | |
Widget* | get_attached_to () |
Fetches the attach widget for this window. More... | |
const Widget* | get_attached_to () const |
Fetches the attach widget for this window. More... | |
void | set_type_hint (Gdk::Surface::TypeHint hint) |
By setting the type hint for the window, you allow the window manager to decorate and handle the window in a way which is suitable to the function of the window in your application. More... | |
Gdk::Surface::TypeHint | get_type_hint () const |
Gets the type hint for this window. More... | |
void | set_accept_focus (bool setting=true) |
Windows may set a hint asking the desktop environment not to receive the input focus. More... | |
bool | get_accept_focus () const |
Gets the value set by set_accept_focus(). More... | |
void | set_focus_on_map (bool setting=true) |
Windows may set a hint asking the desktop environment not to receive the input focus when the window is mapped. More... | |
bool | get_focus_on_map () const |
Gets the value set by set_focus_on_map(). More... | |
bool | get_destroy_with_parent () const |
Returns whether the window will be destroyed with its transient parent. 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 the Gtk::Window::property_mnemonics_visible() property. More... | |
bool | get_mnemonics_visible () const |
Gets the value of the Gtk::Window::property_mnemonics_visible() property. More... | |
void | set_focus_visible (bool setting=true) |
Sets the Gtk::Window::property_focus_visible() property. More... | |
bool | get_focus_visible () const |
Gets the value of the Gtk::Window::property_focus_visible() property. 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; if the window is already mapped, it will be unmapped, and then remapped on the new display. More... | |
bool | is_active () const |
Returns whether the window is part of the current active toplevel. More... | |
void | set_decorated (bool setting=true) |
By default, windows are decorated with a title bar, resize controls, etc. More... | |
bool | get_decorated () const |
Returns whether the window has been set to have decorations such as a title bar via set_decorated(). More... | |
void | set_deletable (bool setting=true) |
By default, windows have a close button in the window frame. More... | |
bool | get_deletable () const |
Returns whether the window has been set to have a close button via set_deletable(). 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, see set_icon_name(). 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 | add_mnemonic (guint keyval, Widget& target) |
Adds a mnemonic to this window. More... | |
void | remove_mnemonic (guint keyval, Widget& target) |
Removes a mnemonic from this window. More... | |
bool | mnemonic_activate (guint keyval, Gdk::ModifierType modifier) |
Activates the targets associated with the mnemonic. More... | |
void | set_mnemonic_modifier (Gdk::ModifierType modifier) |
Sets the mnemonic modifier for this window. More... | |
Gdk::ModifierType | get_mnemonic_modifier () |
Returns the mnemonic modifier for this window. More... | |
void | present () |
Presents a window to the user. More... | |
void | present (guint32 timestamp) |
Presents a window to the user. More... | |
void | iconify () |
Asks to iconify (i.e. minimize) the specified window. More... | |
void | deiconify () |
Asks to deiconify (i.e. unminimize) the specified window. More... | |
void | stick () |
Asks to stick window, which means that it will appear on all user desktops. More... | |
void | unstick () |
Asks to unstick window, which means that it will appear on only one of the user’s desktops. More... | |
void | maximize () |
Asks to maximize window, so that it becomes full-screen. More... | |
void | unmaximize () |
Asks to unmaximize window. More... | |
void | fullscreen () |
Asks to place window in the fullscreen state. More... | |
void | unfullscreen () |
Asks to toggle off the fullscreen state for window. More... | |
void | fullscreen_on_monitor (const Glib::RefPtr< Gdk::Monitor >& monitor) |
Asks to place window in the fullscreen state. More... | |
void | close () |
Requests that the window is closed, similar to what happens when a window manager close button is clicked. More... | |
void | begin_resize_drag (Gdk::SurfaceEdge edge, int button, int x, int y, guint32 timestamp) |
Starts resizing a window. More... | |
void | begin_move_drag (int button, int x, int y, guint32 timestamp) |
Starts moving a window. 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... | |
void | resize (int width, int height) |
Resizes the window as if the user had done so, obeying geometry constraints. More... | |
void | get_size (int& width, int& height) const |
Obtains the current size of window. More... | |
Glib::RefPtr< WindowGroup > | get_group () |
Returns the group for window or the default group, if window is nullptr or if window does not have an explicit window group. More... | |
Glib::RefPtr< const WindowGroup > | get_group () const |
Returns the group for window or the default group, if window is nullptr or if window does not have an explicit window group. More... | |
bool | has_group () const |
Returns whether window has an explicit window group. More... | |
WindowType | get_window_type () const |
Gets the type of the window. More... | |
Glib::RefPtr< Application > | get_application () |
Gets the Gtk::Application associated with the window (if any). More... | |
Glib::RefPtr< const Application > | get_application () const |
Gets the Gtk::Application associated with the window (if any). More... | |
void | set_application (const Glib::RefPtr< Application >& application) |
Sets or unsets the Gtk::Application associated with the window. More... | |
void | unset_application () |
Unsets the Application associated with the window. More... | |
void | set_keep_above (bool setting=true) |
Asks to keep window above, so that it stays on top. More... | |
void | set_keep_below (bool setting=true) |
Asks to keep window below, so that it stays in bottom. More... | |
void | set_titlebar (Widget& titlebar) |
Sets a custom titlebar for window. 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... | |
void | show_uri (const Glib::ustring& uri, guint32 timestamp) |
This is a convenience function for launching the default application to show the uri. More... | |
std::vector< Glib::RefPtr< AccelGroup > > | get_accel_groups () |
Gets a vector containing each Gtk::AccelGroup associated with the window. More... | |
void | raise () |
Brings the window to the front. More... | |
void | set_manage () override |
Overriden to warn that it doesn't make sense to use Gtk::manage() on this class because it has no parent container. More... | |
![]() | |
Bin (Bin&& src) noexcept | |
Bin& | operator= (Bin&& src) noexcept |
Bin (const Bin&)=delete | |
Bin& | operator= (const Bin&)=delete |
~Bin () noexcept override | |
GtkBin* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkBin* | gobj () const |
Provides access to the underlying C GObject. More... | |
Gtk::Widget* | get_child () |
Gets the child of the Gtk::Bin, or nullptr if the bin contains no child widget. More... | |
const Gtk::Widget* | get_child () const |
Gets the child of the Gtk::Bin, or nullptr if the bin contains no child widget. More... | |
void | remove () |
Remove the contained widget. More... | |
void | add_label (const Glib::ustring& label, bool mnemonic=false, Align x_align=Align::CENTER, Align y_align=Align::CENTER) |
Add a Label object. More... | |
void | add_pixlabel (const std::string& pixfile, const Glib::ustring& label, Align x_align=Align::CENTER, Align y_align=Align::CENTER) |
Add Image and Label objects. More... | |
![]() | |
Container (Container&& src) noexcept | |
Container& | operator= (Container&& src) noexcept |
Container (const Container&)=delete | |
Container& | operator= (const Container&)=delete |
~Container () noexcept override | |
GtkContainer* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkContainer* | gobj () const |
Provides access to the underlying C GObject. More... | |
void | add (Widget& widget) |
Adds widget to container. More... | |
void | remove (Widget& widget) |
Removes widget from the container. More... | |
void | foreach (const ForeachSlot& slot) |
Operate on contained items. More... | |
void | forall (const ForeachSlot& slot) |
Operate on contained items, including internal children. More... | |
std::vector< Widget* > | get_children () |
Returns the container’s non-internal children. More... | |
std::vector< const Widget* > | get_children () const |
Returns the container’s non-internal children. More... | |
void | set_focus_vadjustment (const Glib::RefPtr< Adjustment >& adjustment) |
Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. More... | |
Glib::RefPtr< Adjustment > | get_focus_vadjustment () |
Retrieves the vertical focus adjustment for the container. More... | |
Glib::RefPtr< const Adjustment > | get_focus_vadjustment () const |
Retrieves the vertical focus adjustment for the container. More... | |
void | set_focus_hadjustment (const Glib::RefPtr< Adjustment >& adjustment) |
Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. More... | |
Glib::RefPtr< Adjustment > | get_focus_hadjustment () |
Retrieves the horizontal focus adjustment for the container. More... | |
Glib::RefPtr< const Adjustment > | get_focus_hadjustment () const |
Retrieves the horizontal focus adjustment for the container. More... | |
GType | child_type () const |
Returns the type of the children supported by the container. More... | |
WidgetPath | get_path_for_child (const Widget& child) const |
Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child. More... | |
Glib::SignalProxy< void(Widget*)> | signal_add () |
Glib::SignalProxy< void(Widget*)> | signal_remove () |
![]() | |
Widget (Widget&& src) noexcept | |
Widget& | operator= (Widget&& src) noexcept |
Widget (const Widget&)=delete | |
Widget& | operator= (const Widget&)=delete |
~Widget () noexcept override | |
Destroys the widget. More... | |
GtkWidget* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkWidget* | gobj () const |
Provides access to the underlying C GObject. More... | |
void | show () |
Flags a widget to be displayed. More... | |
void | hide () |
Reverses the effects of show(), causing the widget to be hidden (invisible to the user). More... | |
void | queue_draw () |
Schedules this widget to be redrawn in paint phase of the current or the next frame. More... | |
void | queue_resize () |
This function is only for use in widget implementations. More... | |
void | queue_allocate () |
This function is only for use in widget implementations. More... | |
void | size_allocate (const Allocation& allocation, int baseline) |
This is a simple form of allocate() that takes the new position of widget as part of allocation. More... | |
SizeRequestMode | get_request_mode () const |
Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More... | |
void | measure (Orientation orientation, int for_size, int& minimum, int& natural, int& minimum_baseline, int& natural_baseline) const |
Measures widget in the orientation orientation and for the given for_size. More... | |
void | get_preferred_size (Requisition& minimum_size, Requisition& natural_size) const |
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. More... | |
void | set_layout_manager (const Glib::RefPtr< LayoutManager >& layout_manager) |
Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget. More... | |
void | unset_layout_manager () |
Undoes the effect of a previous call to set_layout_manager(). More... | |
Glib::RefPtr< LayoutManager > | get_layout_manager () |
Retrieves the layout manager set using set_layout_manager(). More... | |
Glib::RefPtr< const LayoutManager > | get_layout_manager () const |
Retrieves the layout manager set using set_layout_manager(). More... | |
void | add_accelerator (const Glib::ustring& accel_signal, const Glib::RefPtr< AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods, AccelFlags accel_flags) |
Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated. More... | |
bool | remove_accelerator (const Glib::RefPtr< AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods) |
Removes an accelerator from widget, previously installed with add_accelerator(). More... | |
void | set_accel_path (const Glib::ustring& accel_path, const Glib::RefPtr< AccelGroup >& accel_group) |
Given an accelerator group, accel_group, and an accelerator path, accel_path, sets up an accelerator in accel_group so whenever the key binding that is defined for accel_path is pressed, widget will be activated. More... | |
bool | mnemonic_activate (bool group_cycling) |
Emits the Gtk::Widget::signal_mnemonic_activate() signal. More... | |
bool | event (const Glib::RefPtr< const Gdk::Event >& gdk_event) |
Rarely-used function. More... | |
bool | activate () |
For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More... | |
void | reparent (Container& new_parent) |
Moves a widget from one Gtk::Container to another, handling reference count issues to avoid destroying the widget. More... | |
void | set_can_focus (bool can_focus=true) |
Specifies whether widget can own the input focus. More... | |
bool | get_can_focus () const |
Determines whether widget can own the input focus. More... | |
bool | has_focus () const |
Determines if the widget has the global input focus. More... | |
bool | is_focus () const |
Determines if the widget is the focus widget within its toplevel. More... | |
bool | has_visible_focus () const |
Determines if the widget should show a visible indication that it has the global input focus. More... | |
void | grab_focus () |
Causes widget (or one of its descendents) 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... | |
bool | has_grab () const |
Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse). More... | |
bool | device_is_shadowed (const Glib::RefPtr< const Gdk::Device >& device) |
Returns true if device has been shadowed by a GTK+ device grab on another widget, so it would stop sending events to widget. More... | |
void | add_modal_grab () |
Block events to everything else than this widget and its children. More... | |
void | remove_modal_grab () |
Remove the modal grab of the widget in case it was previously grabbed. More... | |
void | set_name (const Glib::ustring& name) |
Widgets can be named, which allows you to refer to them from a CSS file. More... | |
void | unset_name () |
Glib::ustring | get_name () const |
Retrieves the name of a widget. More... | |
void | set_state_flags (StateFlags flags, bool clear=true) |
This function is for use in widget implementations. More... | |
void | unset_state_flags (StateFlags flags) |
This function is for use in widget implementations. More... | |
StateFlags | get_state_flags () const |
Returns the widget state as a flag set. More... | |
void | set_sensitive (bool sensitive=true) |
Sets the sensitivity of a widget. More... | |
bool | get_sensitive () const |
Returns the widget’s sensitivity (in the sense of returning the value that has been set using set_sensitive()). More... | |
bool | is_sensitive () const |
Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive. More... | |
void | set_visible (bool visible=true) |
Sets the visibility state of widget. More... | |
bool | get_visible () const |
Determines whether the widget is visible. More... | |
bool | is_visible () const |
Determines whether the widget and all its parents are marked as visible. More... | |
bool | get_has_surface () const |
Determines whether widget has a Gdk::Surface of its own. More... | |
bool | get_is_toplevel () const |
Determines whether widget is a toplevel widget. More... | |
bool | get_is_drawable () const |
Determines whether widget can be drawn to. More... | |
bool | get_realized () const |
Determines whether widget is realized. More... | |
bool | get_mapped () const |
Whether the widget is mapped. More... | |
void | set_child_visible (bool visible=true) |
Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with show(). More... | |
bool | get_child_visible () const |
Gets the value set with set_child_visible(). More... | |
Glib::RefPtr< Gdk::Surface > | get_surface () |
Returns the widget’s surface if it is realized, nullptr otherwise. More... | |
Glib::RefPtr< const Gdk::Surface > | get_surface () const |
Returns the widget’s surface if it is realized, nullptr otherwise. More... | |
void | register_surface (const Glib::RefPtr< Gdk::Surface >& surface) |
Registers a Gdk::Surface with the widget and sets it up so that the widget receives events for it. More... | |
void | unregister_surface (const Glib::RefPtr< Gdk::Surface >& surface) |
Unregisters a Gdk::Surface from the widget that was previously set up with register_surface(). More... | |
int | get_allocated_width () const |
Returns the width that has currently been allocated to widget. More... | |
int | get_allocated_height () const |
Returns the height that has currently been allocated to widget. More... | |
int | get_allocated_baseline () const |
Returns the baseline that has currently been allocated to widget. More... | |
Allocation | get_allocation () const |
Retrieves the widget's location. More... | |
int | get_width () const |
Returns the content width of the widget, as passed to its size-allocate implementation. More... | |
int | get_height () const |
Returns the content height of the widget, as passed to its size-allocate implementation. More... | |
Container* | get_parent () |
Returns the parent widget of widget. More... | |
const Container* | get_parent () const |
Returns the parent widget of widget. More... | |
Root* | get_root () |
Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More... | |
const Root* | get_root () const |
Returns the Gtk::Root widget of widget or nullptr if the widget is not contained inside a widget tree with a root widget. More... | |
bool | child_focus (DirectionType direction) |
This function is used by custom widget implementations; if you're writing an app, you’d use grab_focus() to move the focus to a particular widget. More... | |
bool | keynav_failed (DirectionType direction) |
This function should be called whenever keyboard navigation within a single widget hits a boundary. More... | |
void | error_bell () |
Notifies the user about an input-related error on this widget. More... | |
void | set_size_request (int width=-1, int height=-1) |
Sets the minimum size of a widget; that is, the widget’s size request will be at least width by height. More... | |
void | get_size_request (int& width, int& height) const |
Gets the size request that was explicitly set for the widget using set_size_request(). More... | |
void | set_opacity (double opacity) |
Request the widget to be rendered partially transparent, with opacity 0 being fully transparent and 1 fully opaque. More... | |
double | get_opacity () const |
Fetches the requested opacity for this widget. More... | |
void | set_overflow (Overflow overflow) |
Sets how widget treats content that is drawn outside the widget's content area. More... | |
Overflow | get_overflow () const |
Returns the value set via set_overflow(). More... | |
Container* | get_toplevel () |
This function returns the topmost widget in the container hierarchy widget is a part of. More... | |
const Container* | get_toplevel () const |
This function returns the topmost widget in the container hierarchy widget is a part of. More... | |
Widget* | get_ancestor (GType widget_type) |
Gets the first ancestor of widget with type widget_type. More... | |
const Widget* | get_ancestor (GType widget_type) const |
Gets the first ancestor of widget with type widget_type. More... | |
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 () |
This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_clipboard () const |
This is a utility function to get the clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< Gdk::Clipboard > | get_primary_clipboard () |
This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. More... | |
Glib::RefPtr< const Gdk::Clipboard > | get_primary_clipboard () const |
This is a utility function to get the primary clipboard object for the Gdk::Display that widget is using. More... | |
bool | get_hexpand () const |
Gets whether the widget would like any available extra horizontal space. More... | |
void | set_hexpand (bool expand=true) |
Sets whether the widget would like any available extra horizontal space. More... | |
bool | get_hexpand_set () const |
Gets whether set_hexpand() has been used to explicitly set the expand flag on this widget. More... | |
void | set_hexpand_set (bool set=true) |
Sets whether the hexpand flag (see get_hexpand()) will be used. More... | |
bool | get_vexpand () const |
Gets whether the widget would like any available extra vertical space. More... | |
void | set_vexpand (bool expand=true) |
Sets whether the widget would like any available extra vertical space. More... | |
bool | get_vexpand_set () const |
Gets whether set_vexpand() has been used to explicitly set the expand flag on this widget. More... | |
void | set_vexpand_set (bool set=true) |
Sets whether the vexpand flag (see get_vexpand()) will be used. More... | |
void | queue_compute_expand () |
Mark widget as needing to recompute its expand flags. More... | |
bool | compute_expand (Orientation orientation) |
Computes whether a container should give this widget extra space when possible. More... | |
void | set_expand (bool expand=true) |
Sets whether the widget would like any available extra space in both directions. More... | |
bool | get_support_multidevice () const |
Returns true if widget is multiple pointer aware. More... | |
void | set_support_multidevice (bool support_multidevice=true) |
Enables or disables multiple pointer awareness. More... | |
Glib::RefPtr< Atk::Object > | get_accessible () |
Returns the accessible object that describes the widget to an assistive technology. More... | |
Glib::RefPtr< const Atk::Object > | get_accessible () const |
Returns the accessible object that describes the widget to an assistive technology. More... | |
Align | get_halign () const |
Gets the value of the Gtk::Widget::property_halign() property. More... | |
void | set_halign (Align align) |
Sets the horizontal alignment of widget. More... | |
Align | get_valign () const |
Gets the value of the Gtk::Widget::property_valign() property. More... | |
void | set_valign (Align align) |
Sets the vertical alignment of widget. More... | |
int | get_margin_start () const |
Gets the value of the Gtk::Widget::property_margin_start() property. More... | |
void | set_margin_start (int margin) |
Sets the start margin of widget. More... | |
int | get_margin_end () const |
Gets the value of the Gtk::Widget::property_margin_end() property. More... | |
void | set_margin_end (int margin) |
Sets the end margin of widget. More... | |
int | get_margin_top () const |
Gets the value of the Gtk::Widget::property_margin_top() property. More... | |
void | set_margin_top (int margin) |
Sets the top margin of widget. More... | |
int | get_margin_bottom () const |
Gets the value of the Gtk::Widget::property_margin_bottom() property. More... | |
void | set_margin_bottom (int margin) |
Sets the bottom margin of widget. More... | |
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, int src_x, int src_y, int& dest_x, int& dest_y) |
Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More... | |
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 (including widget itself) closest to the screen at the point ( x, y). More... | |
const Widget* | pick (double x, double y, PickFlags flags=PickFlags::DEFAULT) const |
Finds the descendant of widget (including widget itself) closest to the screen at 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... | |
void | reset_style () |
Updates the style context of widget and all descendants by updating its widget path. More... | |
Glib::RefPtr< Pango::Context > | create_pango_context () |
Creates a new Pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget. More... | |
Glib::RefPtr< Pango::Context > | get_pango_context () |
Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget. More... | |
void | set_font_options (const Cairo::FontOptions& options) |
Sets the #cairo_font_options_t used for Pango rendering in this widget. More... | |
void | unset_font_options () |
Undoes the effect of previous calls to set_font_options(). More... | |
Cairo::FontOptions | get_font_options () const |
Returns the #cairo_font_options_t used for Pango rendering. More... | |
Glib::RefPtr< Pango::Layout > | create_pango_layout (const Glib::ustring& text) |
Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. More... | |
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 | input_shape_combine_region (const Cairo::RefPtr< const Cairo::Region >& region) |
Sets an input shape for this widget’s GDK surface. 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 via set_cursor(). More... | |
Glib::RefPtr< const Gdk::Cursor > | get_cursor () const |
Queries the cursor set via set_cursor(). More... | |
WidgetPath | get_path () const |
Returns the Gtk::WidgetPath representing widget, if the widget is not connected to a toplevel widget, a partial path will be created. More... | |
std::vector< Widget* > | list_mnemonic_labels () |
Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More... | |
std::vector< const Widget* > | list_mnemonic_labels () const |
Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget()). More... | |
void | add_mnemonic_label (Widget& label) |
Adds a widget to the list of mnemonic labels for this widget. More... | |
void | remove_mnemonic_label (Widget& label) |
Removes a widget from the list of mnemonic labels for this widget. More... | |
void | drag_get_data (const Glib::RefPtr< Gdk::Drop >& drop, const Glib::ustring& target) |
Gets the data associated with a drag. More... | |
void | drag_highlight () |
Highlights a widget as a currently hovered drop target. More... | |
void | drag_unhighlight () |
Removes a highlight set by gtk_drag_highlight() from a widget. More... | |
void | drag_dest_set (DestDefaults flags=DestDefaults(0), Gdk::DragAction actions=Gdk::DragAction(0)) |
Sets a widget as a potential drop destination, and adds default behaviors. More... | |
void | drag_dest_set (const Glib::RefPtr< Gdk::ContentFormats >& targets, DestDefaults flags=DestDefaults::ALL, Gdk::DragAction actions=Gdk::DragAction::COPY) |
Sets a widget as a potential drop destination, and adds default behaviors. More... | |
void | drag_dest_unset () |
Clears information about a drop destination set with gtk_drag_dest_set(). More... | |
Glib::ustring | drag_dest_find_target (const Glib::RefPtr< Gdk::Drop >& drop, const Glib::RefPtr< Gdk::ContentFormats >& target_list={}) const |
Looks for a match between the supported targets of drop and the target_list, returning the first matching target, otherwise returning an empty string. More... | |
Glib::RefPtr< Gdk::ContentFormats > | drag_dest_get_target_list () |
Returns the list of targets this widget can accept from drag-and-drop. More... | |
Glib::RefPtr< const Gdk::ContentFormats > | drag_dest_get_target_list () const |
Returns the list of targets this widget can accept from drag-and-drop. More... | |
void | drag_dest_set_target_list (const Glib::RefPtr< Gdk::ContentFormats >& target_list) |
Sets the target types that this widget can accept from drag-and-drop. More... | |
void | drag_dest_add_text_targets () |
Add the text targets supported by Gtk::SelectionData to the target list of the drag destination. More... | |
void | drag_dest_add_image_targets () |
Add the image targets supported by Gtk::SelectionData to the target list of the drag destination. More... | |
void | drag_dest_add_uri_targets () |
Add the URI targets supported by Gtk::SelectionData to the target list of the drag destination. More... | |
void | drag_dest_set_track_motion (bool track_motion=true) |
Tells the widget to emit Gtk::Widget::signal_drag_motion() and Gtk::Widget::signal_drag_leave() events regardless of the targets and the Gtk::DestDefaults::MOTION flag. More... | |
bool | drag_dest_get_track_motion () const |
Returns whether the widget has been configured to always emit Gtk::Widget::signal_drag_motion() signals. More... | |
void | drag_source_set (const Glib::RefPtr< Gdk::ContentFormats >& targets, Gdk::ModifierType start_button_mask=Gdk::ModifierType::MODIFIER_MASK, Gdk::DragAction actions=Gdk::DragAction::COPY) |
Sets up a widget so that GTK+ will start a drag operation when the user clicks and drags on the widget. More... | |
void | drag_source_unset () |
Undoes the effects of gtk_drag_source_set(). More... | |
Glib::RefPtr< Gdk::ContentFormats > | drag_source_get_target_list () |
Gets the list of targets this widget can provide for drag-and-drop. More... | |
Glib::RefPtr< const Gdk::ContentFormats > | drag_source_get_target_list () const |
Gets the list of targets this widget can provide for drag-and-drop. More... | |
void | drag_source_set_target_list (const Glib::RefPtr< Gdk::ContentFormats >& target_list) |
Changes the target types that this widget offers for drag-and-drop. More... | |
void | drag_source_set_icon (const Glib::ustring& icon_name) |
Sets the icon that will be used for drags from a particular source to a themed icon. More... | |
void | drag_source_set_icon (const Glib::RefPtr< Gio::Icon >& icon) |
Sets the icon that will be used for drags from a particular source to icon. More... | |
void | drag_source_set_icon (const Glib::RefPtr< Gdk::Paintable >& paintable) |
Sets the icon that will be used for drags from a particular source to paintable. More... | |
void | drag_source_add_text_targets () |
Add the text targets supported by Gtk::SelectionData to the target list of the drag source. More... | |
void | drag_source_add_uri_targets () |
Add the URI targets supported by Gtk::SelectionData to the target list of the drag source. More... | |
void | drag_source_add_image_targets () |
Add the writable image targets supported by Gtk::SelectionData to the target list of the drag source. More... | |
Glib::RefPtr< Gdk::Drag > | drag_begin (const Glib::RefPtr< Gdk::Device >& device, const Glib::RefPtr< Gdk::ContentFormats >& targets, Gdk::DragAction actions, int x, int y) |
Initiates a drag on the source side. More... | |
bool | drag_check_threshold (int start_x, int start_y, int current_x, int current_y) |
Checks to see if a mouse drag starting at ( start_x, start_y) and ending at ( current_x, current_y) has passed the GTK+ drag threshold, and thus should trigger the beginning of a drag-and-drop operation. More... | |
void | queue_resize_no_redraw () |
This function works like queue_resize(), except that the widget is not invalidated. More... | |
Glib::RefPtr< Gdk::FrameClock > | get_frame_clock () |
Obtains the frame clock for a widget. More... | |
Glib::RefPtr< const Gdk::FrameClock > | get_frame_clock () const |
Obtains the frame clock for a widget. More... | |
void | set_parent (Widget& parent) |
This function is useful only when implementing subclasses of Gtk::Widget. More... | |
void | unparent () |
This function is only for use in widget implementations. More... | |
void | map () |
This function is only for use in widget implementations. More... | |
void | unmap () |
This function is only for use in widget implementations. More... | |
void | set_tooltip_window (Window& custom_window) |
Replaces the default window used for displaying tooltips with custom_window. More... | |
Window* | get_tooltip_window () |
Returns the Gtk::Window of the current tooltip. More... | |
void | trigger_tooltip_query () |
Triggers a tooltip query on the display where the toplevel of widget is located. More... | |
void | set_tooltip_text (const Glib::ustring& text) |
Sets text as the contents of the tooltip. More... | |
Glib::ustring | get_tooltip_text () const |
Gets the contents of the tooltip for widget. More... | |
void | set_tooltip_markup (const Glib::ustring& markup) |
Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. More... | |
Glib::ustring | get_tooltip_markup () const |
Gets the contents of the tooltip for widget. More... | |
void | set_has_tooltip (bool has_tooltip=TRUE) |
Sets the has-tooltip property on widget to has_tooltip. More... | |
bool | get_has_tooltip () const |
Returns the current value of the has-tooltip property. More... | |
bool | in_destruction () const |
Returns whether the widget is currently being destroyed. More... | |
Glib::RefPtr< StyleContext > | get_style_context () |
Returns the style context associated to widget. More... | |
Glib::RefPtr< Gtk::StyleContext > | get_style_context () const |
Returns the style context associated to widget. More... | |
Gdk::ModifierType | get_modifier_mask (Gdk::ModifierIntent intent) |
Returns the modifier mask the widget’s windowing system backend uses for a particular purpose. More... | |
guint | add_tick_callback (const SlotTick& slot) |
Queues an animation frame update and adds a callback to be called before each frame. More... | |
void | remove_tick_callback (guint id) |
Removes a tick callback previously registered with add_tick_callback(). More... | |
void | insert_action_group (const Glib::ustring& name, const Glib::RefPtr< Gio::ActionGroup >& group) |
Inserts group into widget. More... | |
void | remove_action_group (const Glib::ustring& name) |
Removes a group from the widget. More... | |
Glib::RefPtr< Gio::ActionGroup > | get_action_group (const Glib::ustring& prefix) |
Retrieves the Gio::ActionGroup that was registered using prefix. More... | |
Glib::RefPtr< const Gio::ActionGroup > | get_action_group (const Glib::ustring& prefix) const |
Retrieves the Gio::ActionGroup that was registered using prefix. More... | |
std::vector< Glib::ustring > | list_action_prefixes () const |
Retrieves a nullptr -terminated array of strings containing the prefixes of Gio::ActionGroup's available to widget. More... | |
void | activate_action (const Glib::ustring& name, const Glib::VariantBase& parameter) |
Looks up the action in the action groups associated with widget and its ancestors, and activates it. More... | |
void | activate_default () |
Activate 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 that has been set with set_font_map(). More... | |
Glib::RefPtr< const Pango::FontMap > | get_font_map () const |
Gets the font map that has been set with set_font_map(). More... | |
Widget* | get_first_child () |
const Widget* | get_first_child () const |
Widget* | get_last_child () |
const Widget* | get_last_child () const |
Widget* | get_next_sibling () |
const Widget* | get_next_sibling () const |
Widget* | get_prev_sibling () |
const Widget* | get_prev_sibling () const |
Glib::RefPtr< Gio::ListModel > | observe_children () |
Returns a ListModel to track the children of widget. More... | |
Glib::RefPtr< const Gio::ListModel > | observe_children () const |
Returns a ListModel to track the children of widget. More... | |
Glib::RefPtr< Gio::ListModel > | observe_controllers () |
Returns a ListModel to track the Gtk::EventControllers of widget. More... | |
Glib::RefPtr< const Gio::ListModel > | observe_controllers () const |
Returns a 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) |
When a widget receives a call to the snapshot function, it must send synthetic Gtk::Widget::signal_snapshot() calls to all children. 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(int, int, int)> | signal_size_allocate () |
Glib::SignalProxy< void(Gtk::StateFlags)> | signal_state_flags_changed () |
Glib::SignalProxy< void()> | signal_style_updated () |
Glib::SignalProxy< void(TextDirection)> | signal_direction_changed () |
Glib::SignalProxy< void(bool)> | signal_grab_notify () |
Glib::SignalProxy< bool(bool)> | signal_mnemonic_activate () |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Drag >&)> | signal_drag_begin () |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Drag >&)> | signal_drag_end () |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Drag >&, SelectionData&)> | signal_drag_data_get () |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Drag >&)> | signal_drag_data_delete () |
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::Drag >&, DragResult)> | signal_drag_failed () |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Drop >&)> | signal_drag_leave () |
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::Drop >&, int, int)> | signal_drag_motion () |
Glib::SignalProxy< bool(const Glib::RefPtr< Gdk::Drop >&, int, int)> | signal_drag_drop () |
Glib::SignalProxy< void(const Glib::RefPtr< Gdk::Drop >&, const SelectionData&)> | signal_drag_data_received () |
Glib::SignalProxy< void()> | signal_accel_closures_changed () |
Glib::SignalProxy< bool()> | signal_popup_menu () |
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< Container* > | 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 or nullptr if the widget is not contained in a root widget. More... | |
Glib::PropertyProxy< int > | property_width_request () |
Override for width request of the widget, or -1 if natural request should be used. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_width_request () const |
Override for width request of the widget, or -1 if natural request should be used. More... | |
Glib::PropertyProxy< int > | property_height_request () |
Override for height request of the widget, or -1 if natural request should be used. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_height_request () const |
Override for height request of the widget, or -1 if natural request should be used. More... | |
Glib::PropertyProxy< bool > | property_visible () |
Whether the widget is visible. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_visible () const |
Whether the widget is visible. More... | |
Glib::PropertyProxy< bool > | property_sensitive () |
Whether the widget responds to input. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_sensitive () const |
Whether the widget responds to input. More... | |
Glib::PropertyProxy< bool > | property_can_focus () |
Whether the widget can accept the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_can_focus () const |
Whether the widget can accept the input focus. More... | |
Glib::PropertyProxy< bool > | property_has_focus () |
Whether the widget has the input focus. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_focus () const |
Whether the widget has the input focus. More... | |
Glib::PropertyProxy< bool > | property_is_focus () |
Whether the widget is the focus widget within the toplevel. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_is_focus () const |
Whether the widget is the focus widget within the toplevel. More... | |
Glib::PropertyProxy< bool > | property_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_ReadOnly< bool > | property_has_default () const |
Whether the widget is the default widget. More... | |
Glib::PropertyProxy< bool > | property_receives_default () |
If true , the widget will receive the default action when it is focused. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_receives_default () const |
If true , the widget will receive the default action when it is focused. More... | |
Glib::PropertyProxy< 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 Gtk::Widget::signal_query_tooltip() on widget. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_has_tooltip () const |
Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget. More... | |
Glib::PropertyProxy< Glib::ustring > | property_tooltip_markup () |
Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_markup () const |
Sets the text of tooltip to be the given string, which is marked up with the [Pango text markup language][PangoMarkupFormat]. More... | |
Glib::PropertyProxy< Glib::ustring > | property_tooltip_text () |
Sets the text of tooltip to be the given string. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_tooltip_text () const |
Sets the text of tooltip to be the given string. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Surface > > | property_surface () const |
The widget's surface if it is realized, nullptr otherwise. More... | |
Glib::PropertyProxy< Align > | property_halign () |
How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy_ReadOnly< Align > | property_halign () const |
How to distribute horizontal space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy< Align > | property_valign () |
How to distribute vertical space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy_ReadOnly< Align > | property_valign () const |
How to distribute vertical space if widget gets extra space, see Gtk::Align. More... | |
Glib::PropertyProxy< int > | property_margin_start () |
Margin on start of widget, horizontally. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_start () const |
Margin on start of widget, horizontally. More... | |
Glib::PropertyProxy< int > | property_margin_end () |
Margin on end of widget, horizontally. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_end () const |
Margin on end of widget, horizontally. More... | |
Glib::PropertyProxy< int > | property_margin_top () |
Margin on top side of widget. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_top () const |
Margin on top side of widget. More... | |
Glib::PropertyProxy< int > | property_margin_bottom () |
Margin on bottom side of widget. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin_bottom () const |
Margin on bottom side of widget. More... | |
Glib::PropertyProxy< int > | property_margin () |
Sets all four sides' margin at once. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_margin () const |
Sets all four sides' margin at once. More... | |
Glib::PropertyProxy< bool > | property_hexpand () |
Whether to expand horizontally. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_hexpand () const |
Whether to expand horizontally. More... | |
Glib::PropertyProxy< bool > | property_hexpand_set () |
Whether to use the Gtk::Widget::property_hexpand() property. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_hexpand_set () const |
Whether to use the Gtk::Widget::property_hexpand() property. More... | |
Glib::PropertyProxy< bool > | property_vexpand () |
Whether to expand vertically. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_vexpand () const |
Whether to expand vertically. More... | |
Glib::PropertyProxy< bool > | property_vexpand_set () |
Whether to use the Gtk::Widget::property_vexpand() property. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_vexpand_set () const |
Whether to use the Gtk::Widget::property_vexpand() property. More... | |
Glib::PropertyProxy< bool > | property_expand () |
Whether to expand in both directions. More... | |
Glib::PropertyProxy_ReadOnly< bool > | property_expand () const |
Whether to expand in both directions. More... | |
Glib::PropertyProxy< double > | property_opacity () |
The requested opacity of the widget. More... | |
Glib::PropertyProxy_ReadOnly< double > | property_opacity () const |
The requested opacity of the widget. More... | |
Glib::PropertyProxy< 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< 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... | |
![]() | |
Object (Object&& src) noexcept | |
Object& | operator= (Object&& src) noexcept |
~Object () noexcept override | |
![]() | |
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object (Object &&src) noexcept | |
Object & | operator= (Object &&src) noexcept |
void * | get_data (const QueryQuark &key) |
void | set_data (const Quark &key, void *data) |
void | set_data (const Quark &key, void *data, DestroyNotify notify) |
void | remove_data (const QueryQuark &quark) |
void * | steal_data (const QueryQuark &quark) |
Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false) |
![]() | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (const ObjectBase &)=delete |
void | set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value) |
void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const |
void | set_property (const Glib::ustring &property_name, const PropertyType &value) |
void | get_property (const Glib::ustring &property_name, PropertyType &value) const |
PropertyType | get_property (const Glib::ustring &property_name) const |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot) |
void | freeze_notify () |
void | thaw_notify () |
virtual void | reference () const |
virtual void | unreference () const |
GObject * | gobj () |
const GObject * | gobj () const |
GObject * | gobj_copy () const |
![]() | |
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable (trackable &&src) noexcept | |
~trackable () | |
void | add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) noexcept |
void | remove_destroy_notify_callback (notifiable *data) const |
![]() | |
Buildable (Buildable&& src) noexcept | |
Buildable& | operator= (Buildable&& src) noexcept |
~Buildable () noexcept override | |
GtkBuildable* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkBuildable* | gobj () const |
Provides access to the underlying C GObject. More... | |
void | set_name (const Glib::ustring& name) |
Sets the name of the buildable object. More... | |
Glib::ustring | get_name () const |
Gets the name of the buildable object. More... | |
![]() | |
Interface () | |
Interface (Interface &&src) noexcept | |
Interface & | operator= (Interface &&src) noexcept |
Interface (const Glib::Interface_Class &interface_class) | |
Interface (GObject *castitem) | |
~Interface () noexcept override | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () const |
![]() | |
Implementor (Implementor &&src) noexcept | |
Implementor & | operator= (Implementor &&src) noexcept |
~Implementor () noexcept override | |
AtkImplementor * | gobj () |
const AtkImplementor * | gobj () const |
Glib::RefPtr< Atk::Implementor > | wrap (AtkImplementor *object, bool take_copy=false) |
![]() | |
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... | |
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... | |
Glib::PropertyProxy< Widget* > | property_focus_widget () |
The focus widget. More... | |
Glib::PropertyProxy_ReadOnly< Widget* > | property_focus_widget () const |
The focus widget. 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 for windows that haven't had gtk_window_set_icon_list() called on them from a named themed icon, see set_icon_name(). More... | |
static Glib::ustring | get_default_icon_name () |
Returns the fallback icon name for windows that has been set with set_default_icon_name(). More... | |
static void | set_auto_startup_notification (bool setting=true) |
By default, after showing the first Gtk::Window, GTK+ calls gdk_notify_startup_complete(). 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 GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
static Widget* | get_current_modal_grab () |
Retrieve the widget which is currently grabbing all events. More... | |
static void | set_default_direction (TextDirection dir) |
Sets the default reading direction for widgets where the direction has not been explicitly set by set_direction(). More... | |
static TextDirection | get_default_direction () |
Obtains the current default reading direction. More... | |
![]() | |
static 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 void | add_interface (GType gtype_implementer) |
static GType | get_type () |
![]() | |
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 Widget* | get_for_surface (const Glib::RefPtr< const Gdk::Surface >& surface) |
Finds the GtkRoot associated with the surface. More... | |
Protected Member Functions | |
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... | |
![]() | |
Bin () | |
This constructor is protected because only derived classes should be instantiated. More... | |
![]() | |
Container () | |
virtual GType | child_type_vfunc () const |
Implements child_type(). More... | |
virtual void | forall_vfunc (const ForeachSlot& slot) |
Invokes a callback on all non-internal children of the container. More... | |
virtual void | set_focus_child_vfunc (Widget* child) |
Sets the focused child of container. More... | |
virtual WidgetPath | get_path_for_child_vfunc (const Widget* child) const |
Returns a widget path representing all the widget hierarchy from the toplevel down to and including child. More... | |
virtual void | on_add (Widget* widget) |
This is a default handler for the signal signal_add(). More... | |
virtual void | on_remove (Widget* widget) |
This is a default handler for the signal signal_remove(). More... | |
![]() | |
virtual void | root_vfunc () |
virtual void | unroot_vfunc () |
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 void | grab_focus_vfunc () |
virtual Glib::RefPtr< Atk::Object > | get_accessible_vfunc () |
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 (windowing system) resources associated with a widget. More... | |
void | unrealize () |
This function is only useful in widget implementations. More... | |
void | set_has_surface (bool has_surface=true) |
Specifies whether widget has a Gdk::Surface of its own. More... | |
void | set_surface (const Glib::RefPtr< Gdk::Surface >& surface) |
Sets a widget's surface. 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_size_allocate (int width, int height, int baseline) |
This is a default handler for the signal signal_size_allocate(). 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_style_updated () |
This is a default handler for the signal signal_style_updated(). More... | |
virtual void | on_direction_changed (TextDirection direction) |
This is a default handler for the signal signal_direction_changed(). More... | |
virtual void | on_grab_notify (bool was_grabbed) |
This is a default handler for the signal signal_grab_notify(). More... | |
virtual bool | on_mnemonic_activate (bool group_cycling) |
This is a default handler for the signal signal_mnemonic_activate(). More... | |
virtual void | on_drag_begin (const Glib::RefPtr< Gdk::Drag >& drag) |
This is a default handler for the signal signal_drag_begin(). More... | |
virtual void | on_drag_end (const Glib::RefPtr< Gdk::Drag >& drag) |
This is a default handler for the signal signal_drag_end(). More... | |
virtual void | on_drag_data_get (const Glib::RefPtr< Gdk::Drag >& drag, SelectionData& selection_data) |
This is a default handler for the signal signal_drag_data_get(). More... | |
virtual void | on_drag_data_delete (const Glib::RefPtr< Gdk::Drag >& drag) |
This is a default handler for the signal signal_drag_data_delete(). More... | |
virtual bool | on_drag_failed (const Glib::RefPtr< Gdk::Drag >& drag, DragResult result) |
This is a default handler for the signal signal_drag_failed(). More... | |
virtual void | on_drag_leave (const Glib::RefPtr< Gdk::Drop >& drop) |
This is a default handler for the signal signal_drag_leave(). More... | |
virtual bool | on_drag_motion (const Glib::RefPtr< Gdk::Drop >& drop, int x, int y) |
This is a default handler for the signal signal_drag_motion(). More... | |
virtual bool | on_drag_drop (const Glib::RefPtr< Gdk::Drop >& drop, int x, int y) |
This is a default handler for the signal signal_drag_drop(). More... | |
virtual void | on_drag_data_received (const Glib::RefPtr< Gdk::Drop >& drop, const SelectionData& selection_data) |
This is a default handler for the signal signal_drag_data_received(). More... | |
virtual bool | on_popup_menu () |
This is a default handler for the signal signal_popup_menu(). 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... | |
![]() | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexcept override | |
![]() | |
ObjectBase () | |
ObjectBase (const char *custom_type_name) | |
ObjectBase (const std::type_info &custom_type_info) | |
ObjectBase (ObjectBase &&src) noexcept | |
ObjectBase & | operator= (ObjectBase &&src) noexcept |
virtual | ~ObjectBase () noexcept=0 |
void | initialize (GObject *castitem) |
void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
![]() | |
Buildable () | |
You should derive from this class to use it. More... | |
![]() | |
Implementor () | |
virtual Glib::RefPtr< Object > | ref_accessibile_vfunc () |
![]() | |
Root () | |
You should derive from this class to use it. More... | |
virtual Glib::RefPtr< Gdk::Display > | get_display_vfunc () |
virtual void | get_surface_transform_vfunc (int& x, int& y) |
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... | |
![]() | |
Gtk::Bin* | wrap (GtkBin* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Gtk::Container* | wrap (GtkContainer* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Gtk::Widget* | wrap (GtkWidget* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Glib::RefPtr< Gtk::Buildable > | wrap (GtkBuildable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Glib::RefPtr< Gtk::Root > | wrap (GtkRoot* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
![]() | |
using | ForeachSlot = sigc::slot< void(Widget&)> |
A slot to invoke with each child iterated over by foreach() or forall(). More... | |
![]() | |
using | SlotTick = sigc::slot< bool(const Glib::RefPtr< Gdk::FrameClock >&)> |
Callback type for adding a function to update animations. More... | |
![]() | |
typedef void(*)(gpointer data | DestroyNotify) |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
![]() | |
typedef internal::func_destroy_notify | func_destroy_notify |
Toplevel Window.
This represents all widgets which are physical windows controlled by the window manager.
The window will be hidden when the window manager's close button is clicked. Override on_delete_event() to stop this.
Gtk::manage() has no effect on Windows because they have no parent Containers.
|
noexcept |
|
delete |
|
overridenoexcept |
|
explicit |
void Gtk::Window::add_accel_group | ( | const Glib::RefPtr< AccelGroup >& | accel_group | ) |
Associate accel_group with window, such that calling gtk_accel_groups_activate() on window will activate accelerators in accel_group.
accel_group | A Gtk::AccelGroup. |
void Gtk::Window::add_mnemonic | ( | guint | keyval, |
Widget& | target | ||
) |
Adds a mnemonic to this window.
keyval | The mnemonic. |
target | The widget that gets activated by the mnemonic. |
void Gtk::Window::begin_move_drag | ( | int | button, |
int | x, | ||
int | y, | ||
guint32 | timestamp | ||
) |
Starts moving a window.
This function is used if an application has window movement grips.
button | Mouse button that initiated the drag. |
x | X position where the user clicked to initiate the drag, in window coordinates. |
y | Y position where the user clicked to initiate the drag. |
timestamp | Timestamp from the click event that initiated the drag. |
void Gtk::Window::begin_resize_drag | ( | Gdk::SurfaceEdge | edge, |
int | button, | ||
int | x, | ||
int | y, | ||
guint32 | timestamp | ||
) |
Starts resizing a window.
This function is used if an application has window resizing controls.
button | Mouse button that initiated the drag. |
edge | Position of the resize control. |
x | X position where the user clicked to initiate the drag, in window coordinates. |
y | Y position where the user clicked to initiate the drag. |
timestamp | Timestamp from the click event that initiated the drag. |
void Gtk::Window::close | ( | ) |
Requests that the window is closed, similar to what happens when a window manager close button is clicked.
This function can be used with close buttons in custom titlebars.
void Gtk::Window::deiconify | ( | ) |
Asks to deiconify (i.e. unminimize) the specified window.
Note that you shouldn’t assume the window is definitely deiconified afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch])) could iconify it again before your code which assumes deiconification gets to run.
You can track iconification via the Gdk::Surface::property_state() property.
|
protected |
void Gtk::Window::fullscreen | ( | ) |
Asks to place window in the fullscreen state.
Note that you shouldn’t assume the window is definitely full screen afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could unfullscreen it again, and not all window managers honor requests to fullscreen windows. But normally the window will end up fullscreen. Just don’t write code that crashes if not.
You can track iconification via the Gdk::Surface::property_state() property
void Gtk::Window::fullscreen_on_monitor | ( | const Glib::RefPtr< Gdk::Monitor >& | monitor | ) |
Asks to place window in the fullscreen state.
Note that you shouldn't assume the window is definitely full screen afterward.
You can track iconification via the Gdk::Surface::property_state() property
monitor | Which monitor to go fullscreen on. |
std::vector< Glib::RefPtr<AccelGroup> > Gtk::Window::get_accel_groups | ( | ) |
Gets a vector containing each Gtk::AccelGroup associated with the window.
bool Gtk::Window::get_accept_focus | ( | ) | const |
Gets the value set by set_accept_focus().
true
if window should receive the input focus. Glib::RefPtr<Application> Gtk::Window::get_application | ( | ) |
Gets the Gtk::Application associated with the window (if any).
nullptr
. Glib::RefPtr<const Application> Gtk::Window::get_application | ( | ) | const |
Gets the Gtk::Application associated with the window (if any).
nullptr
. Widget* Gtk::Window::get_attached_to | ( | ) |
Fetches the attach widget for this window.
See set_attached_to().
nullptr
if the window is not attached to any widget. const Widget* Gtk::Window::get_attached_to | ( | ) | const |
Fetches the attach widget for this window.
See set_attached_to().
nullptr
if the window is not attached to any widget. bool Gtk::Window::get_decorated | ( | ) | const |
Returns whether the window has been set to have decorations such as a title bar via set_decorated().
true
if the window has been set to have decorations.
|
static |
Returns the fallback icon name for windows that has been set with set_default_icon_name().
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().
void Gtk::Window::get_default_size | ( | int & | width, |
int & | height | ||
) | const |
Gets the default size of the window.
A value of -1 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.
width | Location to store the default width. |
height | Location to store the default height. |
Widget* Gtk::Window::get_default_widget | ( | ) |
Returns the default widget for window.
See gtk_window_set_default() for more details.
nullptr
if there is none. const Widget* Gtk::Window::get_default_widget | ( | ) | const |
Returns the default widget for window.
See gtk_window_set_default() for more details.
nullptr
if there is none. bool Gtk::Window::get_deletable | ( | ) | const |
Returns whether the window has been set to have a close button via set_deletable().
true
if the window has been set to have a close button. bool Gtk::Window::get_destroy_with_parent | ( | ) | const |
Returns whether the window will be destroyed with its transient parent.
See set_destroy_with_parent().
true
if the window will be destroyed with its transient parent. 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.
nullptr
if there is none. 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.
nullptr
if there is none. bool Gtk::Window::get_focus_on_map | ( | ) | const |
Gets the value set by set_focus_on_map().
true
if window should receive the input focus when mapped. bool Gtk::Window::get_focus_visible | ( | ) | const |
Gets the value of the Gtk::Window::property_focus_visible() property.
true
if “focus rectangles” are supposed to be visible in this window. Glib::RefPtr<WindowGroup> Gtk::Window::get_group | ( | ) |
Returns the group for window or the default group, if window is nullptr
or if window does not have an explicit window group.
Glib::RefPtr<const WindowGroup> Gtk::Window::get_group | ( | ) | const |
Returns the group for window or the default group, if window is nullptr
or if window does not have an explicit window group.
bool Gtk::Window::get_hide_on_close | ( | ) | const |
Returns whether the window will be hidden when the close button is clicked.
true
if the window will be hidden. Glib::ustring Gtk::Window::get_icon_name | ( | ) | const |
Returns the name of the themed icon for the window, see set_icon_name().
nullptr
if the window has no themed icon. Gdk::ModifierType Gtk::Window::get_mnemonic_modifier | ( | ) |
Returns the mnemonic modifier for this window.
bool Gtk::Window::get_mnemonics_visible | ( | ) | const |
Gets the value of the Gtk::Window::property_mnemonics_visible() property.
true
if mnemonics are supposed to be visible in this window. bool Gtk::Window::get_modal | ( | ) | const |
Returns whether the window is modal.
See set_modal().
true
if the window is set to be modal and establishes a grab when shown. bool Gtk::Window::get_resizable | ( | ) | const |
Gets the value set by set_resizable().
true
if the user can resize the window. void Gtk::Window::get_size | ( | int & | width, |
int & | height | ||
) | const |
Obtains the current size of window.
If window is not visible on screen, this function return the size GTK+ will suggest to the [window manager][gtk-X11-arch] for the initial window size (but this is not reliably the same as the size the window manager will actually select). See: set_default_size().
Depending on the windowing system and the window manager constraints, the size returned by this function may not match the size set using resize(); additionally, since resize() may be implemented as an asynchronous operation, GTK+ cannot guarantee in any way that this code:
[C example ellipted]
will result in new_width
and new_height
matching width
and height
, respectively.
This function will return the logical size of the Gtk::Window, excluding the widgets used in client side decorations; there is, however, no guarantee that the result will be completely accurate because client side decoration may include widgets that depend on the user preferences and that may not be visibile at the time you call this function.
The dimensions returned by this function are suitable for being stored across sessions; use set_default_size() to restore them when before showing the window.
To avoid potential race conditions, you should only call this function in response to a size change notification, for instance inside a handler for the Gtk::Widget::signal_size_allocate() signal, or inside a handler for the Gtk::Widget::signal_configure_event() signal:
[C example ellipted]
Note that, if you connect to the Gtk::Widget::signal_size_allocate() signal, you should not use the dimensions of the Gtk::Allocation passed to the signal handler, as the allocation may contain client side decorations added by GTK+, depending on the windowing system in use.
If you are getting a window size in order to position the window on the screen, you should, instead, simply set the window’s semantic type with set_type_hint(), which allows the window manager to e.g. center dialogs. Also, if you set the transient parent of dialogs with set_transient_for() window managers will often center the dialog over its parent window. It's much preferred to let the window manager handle these cases rather than doing it yourself, because all apps will behave consistently and according to user or system preferences, if the window manager handles it. Also, the window manager can take into account the size of the window decorations and border that it may add, and of which GTK+ has no knowledge. Additionally, positioning windows in global screen coordinates may not be allowed by the windowing system. For more information, see: set_position().
width | Return location for width. |
height | Return location for height. |
Glib::ustring Gtk::Window::get_title | ( | ) | const |
Retrieves the title of the window.
See set_title().
nullptr
if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed. Widget* Gtk::Window::get_titlebar | ( | ) |
Returns the custom titlebar that has been set with set_titlebar().
nullptr
. const Widget* Gtk::Window::get_titlebar | ( | ) | const |
Returns the custom titlebar that has been set with set_titlebar().
nullptr
.
|
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.
Window* Gtk::Window::get_transient_for | ( | ) |
Fetches the transient parent for this window.
See set_transient_for().
nullptr
if no transient parent has been set. const Window* Gtk::Window::get_transient_for | ( | ) | const |
Fetches the transient parent for this window.
See set_transient_for().
nullptr
if no transient parent has been set.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
Gdk::Surface::TypeHint Gtk::Window::get_type_hint | ( | ) | const |
WindowType Gtk::Window::get_window_type | ( | ) | const |
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
bool Gtk::Window::has_group | ( | ) | const |
Returns whether window has an explicit window group.
true
if window has an explicit window group. void Gtk::Window::iconify | ( | ) |
Asks to iconify (i.e. minimize) the specified window.
Note that you shouldn’t assume the window is definitely iconified afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could deiconify it again, or there may not be a window manager in which case iconification isn’t possible, etc. But normally the window will end up iconified. Just don’t write code that crashes if not.
It’s permitted to call this function before showing a window, in which case the window will be iconified before it ever appears onscreen.
You can track iconification via the Gdk::Surface::property_state() property.
bool Gtk::Window::is_active | ( | ) | const |
Returns whether the window is part of the current active toplevel.
(That is, the toplevel 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.
true
if the window part of the current active window. 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().
|
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.
void Gtk::Window::maximize | ( | ) |
Asks to maximize window, so that it becomes full-screen.
Note that you shouldn’t assume the window is definitely maximized afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could unmaximize it again, and not all window managers support maximization. But normally the window will end up maximized. Just don’t write code that crashes if not.
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 iconification via the Gdk::Surface::property_state() property or by listening to notifications on the Gtk::Window::property_is_maximized() property.
bool Gtk::Window::mnemonic_activate | ( | guint | keyval, |
Gdk::ModifierType | modifier | ||
) |
Activates the targets associated with the mnemonic.
keyval | The mnemonic. |
modifier | The modifiers. |
true
if the activation is done.
|
protectedvirtual |
This is a default handler for the signal signal_close_request().
|
protectedvirtual |
This is a default handler for the signal signal_keys_changed().
void Gtk::Window::present | ( | ) |
Presents a window to the user.
This function should not be used as when it is called, it is too late to gather a valid timestamp to allow focus stealing prevention to work correctly.
void Gtk::Window::present | ( | guint32 | timestamp | ) |
Presents a window to the user.
This may mean raising the window in the stacking order, deiconifying 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 calls Gtk::Widget::show() as well.
This function should be used when the user tries to open a window that’s already open. Say for example the preferences dialog is currently open, and the user chooses Preferences from the menu a second time; use present() to move the already-open dialog where the user can see it.
Presents a window to the user in response to a user interaction. 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.
timestamp | The timestamp of the user interaction (typically a button or key press event) which triggered this call. |
Glib::PropertyProxy< bool > Gtk::Window::property_accept_focus | ( | ) |
Whether the window should receive the input focus.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_accept_focus | ( | ) | const |
Whether the window should receive the input focus.
Default value: true
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
.
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
.
Glib::PropertyProxy< Widget* > Gtk::Window::property_attached_to | ( | ) |
The widget to which this window is attached.
See Gtk::Window::set_attached_to().
Examples of places where specifying this relation is useful are for instance a Gtk::Menu created by a Gtk::ComboBox, a completion popup window created by Gtk::Entry or a typeahead search entry created by Gtk::TreeView.
Glib::PropertyProxy_ReadOnly< Widget* > Gtk::Window::property_attached_to | ( | ) | const |
The widget to which this window is attached.
See Gtk::Window::set_attached_to().
Examples of places where specifying this relation is useful are for instance a Gtk::Menu created by a Gtk::ComboBox, a completion popup window created by Gtk::Entry or a typeahead search entry created by Gtk::TreeView.
Glib::PropertyProxy< bool > Gtk::Window::property_decorated | ( | ) |
Whether the window should be decorated by the window manager.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_decorated | ( | ) | const |
Whether the window should be decorated by the window manager.
Default value: true
Glib::PropertyProxy< int > Gtk::Window::property_default_height | ( | ) |
The default height of the window, used when initially showing the window.
Default value: -1
Glib::PropertyProxy_ReadOnly< int > Gtk::Window::property_default_height | ( | ) | const |
The default height of the window, used when initially showing the window.
Default value: -1
Glib::PropertyProxy< Widget* > Gtk::Window::property_default_widget | ( | ) |
The default widget.
Glib::PropertyProxy_ReadOnly< Widget* > Gtk::Window::property_default_widget | ( | ) | const |
The default widget.
Glib::PropertyProxy< int > Gtk::Window::property_default_width | ( | ) |
The default width of the window, used when initially showing the window.
Default value: -1
Glib::PropertyProxy_ReadOnly< int > Gtk::Window::property_default_width | ( | ) | const |
The default width of the window, used when initially showing the window.
Default value: -1
Glib::PropertyProxy< bool > Gtk::Window::property_deletable | ( | ) |
Whether the window frame should have a close button.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_deletable | ( | ) | const |
Whether the window frame should have a close button.
Default value: true
Glib::PropertyProxy< bool > Gtk::Window::property_destroy_with_parent | ( | ) |
If this window should be destroyed when the parent is destroyed.
Default value: false
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
Glib::PropertyProxy< Glib::RefPtr<Gdk::Display> > Gtk::Window::property_display | ( | ) |
The display that will display this window.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Display> > Gtk::Window::property_display | ( | ) | const |
The display that will display this window.
Glib::PropertyProxy< bool > Gtk::Window::property_focus_on_map | ( | ) |
Whether the window should receive the input focus when mapped.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_focus_on_map | ( | ) | const |
Whether the window should receive the input focus when mapped.
Default value: true
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
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
Glib::PropertyProxy< bool > Gtk::Window::property_hide_on_close | ( | ) |
If this window should be hidden when the user clicks the close button.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_hide_on_close | ( | ) | const |
If this window should be hidden when the user clicks the close button.
Default value: false
Glib::PropertyProxy< Glib::ustring > Gtk::Window::property_icon_name | ( | ) |
The :icon-name property specifies the name of the themed icon to use as the window icon.
See Gtk::IconTheme for more details.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Window::property_icon_name | ( | ) | const |
The :icon-name property specifies the name of the themed icon to use as the window icon.
See Gtk::IconTheme for more details.
Default value: ""
Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_is_active | ( | ) | const |
Whether the toplevel is the current active window.
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_is_maximized | ( | ) | const |
Whether the window is maximized.
Default value: false
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: true
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: true
Glib::PropertyProxy< bool > Gtk::Window::property_modal | ( | ) |
If true
, the window is modal (other windows are not usable while this one is up).
Default value: false
Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_modal | ( | ) | const |
If true
, the window is modal (other windows are not usable while this one is up).
Default value: false
Glib::PropertyProxy< bool > Gtk::Window::property_resizable | ( | ) |
If true
, users can resize the window.
Default value: true
Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_resizable | ( | ) | const |
If true
, users can resize the window.
Default value: true
Glib::PropertyProxy_WriteOnly< Glib::ustring > Gtk::Window::property_startup_id | ( | ) |
The :startup-id is a write-only property for setting window's startup notification identifier.
See Gtk::Window::set_startup_id() for more details.
Default value: ""
Glib::PropertyProxy< Glib::ustring > Gtk::Window::property_title | ( | ) |
The title of the window.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Window::property_title | ( | ) | const |
The title of the window.
Default value: ""
Glib::PropertyProxy< Window* > Gtk::Window::property_transient_for | ( | ) |
The transient parent of the window.
See Gtk::Window::set_transient_for() for more details about transient windows.
Glib::PropertyProxy_ReadOnly< Window* > Gtk::Window::property_transient_for | ( | ) | const |
The transient parent of the window.
See Gtk::Window::set_transient_for() for more details about transient windows.
Glib::PropertyProxy_ReadOnly< WindowType > Gtk::Window::property_type | ( | ) | const |
The type of the window.
Default value: Gtk::WindowType::TOPLEVEL
Glib::PropertyProxy< Gdk::Surface::TypeHint > Gtk::Window::property_type_hint | ( | ) |
Hint to help the desktop environment understand what kind of window this is and how to treat it.
Default value: Gdk::Surface::TypeHint::NORMAL
Glib::PropertyProxy_ReadOnly< Gdk::Surface::TypeHint > Gtk::Window::property_type_hint | ( | ) | const |
Hint to help the desktop environment understand what kind of window this is and how to treat it.
Default value: Gdk::Surface::TypeHint::NORMAL
Glib::PropertyProxy< WindowPosition > Gtk::Window::property_window_position | ( | ) |
The initial position of the window.
Default value: Gtk::WindowPosition::NONE
Glib::PropertyProxy_ReadOnly< WindowPosition > Gtk::Window::property_window_position | ( | ) | const |
The initial position of the window.
Default value: Gtk::WindowPosition::NONE
void Gtk::Window::raise | ( | ) |
Brings the window to the front.
This is just a more obvious convenience wrapper for get_surface()->raise().
void Gtk::Window::remove_accel_group | ( | const Glib::RefPtr< AccelGroup >& | accel_group | ) |
Reverses the effects of add_accel_group().
accel_group | A Gtk::AccelGroup. |
void Gtk::Window::remove_mnemonic | ( | guint | keyval, |
Widget& | target | ||
) |
Removes a mnemonic from this window.
keyval | The mnemonic. |
target | The widget that gets activated by the mnemonic. |
void Gtk::Window::resize | ( | int | width, |
int | height | ||
) |
Resizes the window as if the user had done so, obeying geometry constraints.
The default geometry constraint is that windows may not be smaller than their size request; to override this constraint, call Gtk::Widget::set_size_request() to set the window's request to a smaller value.
If resize() is called before showing a window for the first time, it overrides any default size set with set_default_size().
Windows may not be resized smaller than 1 by 1 pixels.
When using client side decorations, GTK+ will do its best to adjust the given size so that the resulting window size matches the requested size without the title bar, borders and shadows added for the client side decorations, but there is no guarantee that the result will be totally accurate because these widgets added for client side decorations depend on the theme and may not be realized or visible at the time resize() is issued.
If the GtkWindow has a titlebar widget (see set_titlebar()), then typically, resize() will compensate for the height of the titlebar widget only if the height is known when the resulting GtkWindow configuration is issued. For example, if new widgets are added after the GtkWindow configuration and cause the titlebar widget to grow in height, this will result in a window content smaller that specified by resize() and not a larger window.
width | Width in pixels to resize the window to. |
height | Height in pixels to resize the window to. |
void Gtk::Window::set_accept_focus | ( | bool | setting = true | ) |
Windows may set a hint asking the desktop environment not to receive the input focus.
This function sets this hint.
setting | true to let this window receive input focus. |
void Gtk::Window::set_application | ( | const Glib::RefPtr< Application >& | application | ) |
Sets or unsets 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 to nullptr
.
This is equivalent to calling Gtk::Application::remove_window() and/or Gtk::Application::add_window() on the old/new applications as relevant.
application | A Gtk::Application, or nullptr to unset. |
void Gtk::Window::set_attached_to | ( | Widget& | attach_widget | ) |
Marks window as attached to attach_widget.
This creates a logical binding between the window and the widget it belongs to, which is used by GTK+ to propagate information such as styling or accessibility to window as if it was a children of attach_widget.
Examples of places where specifying this relation is useful are for instance a Gtk::Menu created by a Gtk::ComboBox, a completion popup window created by Gtk::Entry or a typeahead search entry created by Gtk::TreeView.
Note that this function should not be confused with set_transient_for(), which specifies a window manager relation between two toplevels instead.
Passing nullptr
for attach_widget detaches the window.
attach_widget | A Gtk::Widget, or nullptr . |
|
static |
By default, after showing the first Gtk::Window, GTK+ calls gdk_notify_startup_complete().
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.
setting | true to automatically do startup notification. |
void Gtk::Window::set_decorated | ( | bool | setting = true | ) |
By default, windows are decorated with a title bar, resize controls, etc.
Some [window managers][gtk-X11-arch] 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.
setting | true to decorate the window. |
|
static |
Sets an icon to be used as fallback for windows that haven't had gtk_window_set_icon_list() called on them from a named themed icon, see set_icon_name().
name | The name of the themed icon. |
void Gtk::Window::set_default_size | ( | int | width, |
int | height | ||
) |
Sets the default size of a window.
If the window’s “natural” size (its size request) is larger than the default, the default will be ignored.
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).
For some uses, resize() is a more appropriate function. resize() changes the current size of the window, rather than the size to be used on initial display. resize() always affects the window itself, not the geometry widget.
The default size of a window only affects the first time a window is shown; if a window is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.
Windows can’t actually be 0x0 in size, they must be at least 1x1, but passing 0 for width and height is OK, resulting in a 1x1 default size.
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_size(). Using the window allocation directly will not work in all circumstances and can lead to growing or shrinking windows.
width | Width in pixels, or -1 to unset the default width. |
height | Height in pixels, or -1 to unset the default height. |
void Gtk::Window::set_default_widget | ( | Gtk::Widget& | default_widget | ) |
The default widget is the widget that’s activated when the user presses Enter in a dialog (for example).
This function sets or unsets the default widget for a Gtk::Window.
default_widget | Widget to be the default, or nullptr to unset the default widget for the toplevel. |
void Gtk::Window::set_deletable | ( | bool | setting = true | ) |
By default, windows have a close button in the window frame.
Some [window managers][gtk-X11-arch] 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.
setting | true to decorate the window as deletable. |
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.
display | A Gdk::Display. |
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.
focus | Widget to be the new focus widget. |
void Gtk::Window::set_focus_on_map | ( | bool | setting = true | ) |
Windows may set a hint asking the desktop environment not to receive the input focus when the window is mapped.
This function sets this hint.
setting | true to let this window receive input focus on map. |
void Gtk::Window::set_focus_visible | ( | bool | setting = true | ) |
Sets the Gtk::Window::property_focus_visible() property.
setting | The new value. |
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.
setting | Whether to hide the window when it is closed. |
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.
name | The name of the themed icon. |
void Gtk::Window::set_keep_above | ( | bool | setting = true | ) |
Asks to keep window above, so that it stays on top.
Note that you shouldn’t assume the window is definitely above afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could not keep it above, and not all window managers support keeping windows above. But normally the window will end kept above. Just don’t write code that crashes if not.
It’s permitted to call this function before showing a window, in which case the window will be kept above when it appears onscreen initially.
You can track iconification via the Gdk::Surface::property_state() property
Note that, according to the Extended Window Manager Hints Specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.
setting | Whether to keep window above other windows. |
void Gtk::Window::set_keep_below | ( | bool | setting = true | ) |
Asks to keep window below, so that it stays in bottom.
Note that you shouldn’t assume the window is definitely below afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could not keep it below, and not all window managers support putting windows below. But normally the window will be kept below. Just don’t write code that crashes if not.
It’s permitted to call this function before showing a window, in which case the window will be kept below when it appears onscreen initially.
You can track iconification via the Gdk::Surface::property_state() property
Note that, according to the Extended Window Manager Hints Specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.
setting | Whether to keep window below other windows. |
|
override |
Overriden to warn that it doesn't make sense to use Gtk::manage() on this class because it has no parent container.
void Gtk::Window::set_mnemonic_modifier | ( | Gdk::ModifierType | modifier | ) |
Sets the mnemonic modifier for this window.
modifier | The modifier mask used to activate mnemonics on this window. |
void Gtk::Window::set_mnemonics_visible | ( | bool | setting = true | ) |
Sets the Gtk::Window::property_mnemonics_visible() property.
setting | The new value. |
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][gtk-X11-arch] will then disallow lowering the dialog below the parent.
modal | Whether the window is modal. |
void Gtk::Window::set_position | ( | WindowPosition | position | ) |
Sets a position constraint for this window.
If the old or new constraint is Gtk::WindowPosition::CENTER_ALWAYS, this will also cause the window to be repositioned to satisfy the new constraint.
position | A position constraint. |
void Gtk::Window::set_resizable | ( | bool | resizable = true | ) |
Sets whether the user can resize a window.
Windows are user resizable by default.
resizable | true if the user can resize this window. |
void Gtk::Window::set_startup_id | ( | const Glib::ustring & | startup_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 GdkSurface. 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.
startup_id | A string with startup-notification identifier. |
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][gtk-X11-arch], 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.
title | Title of the window. |
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().
titlebar | The widget to use as titlebar. |
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][gtk-X11-arch] 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.
This function can also be used to attach a new Gtk::WindowType::POPUP to a Gtk::WindowType::TOPLEVEL parent already mapped on screen so that the Gtk::WindowType::POPUP will be positioned relative to the Gtk::WindowType::TOPLEVEL surface.
On Windows, this function puts the child window on top of the parent, much as the window manager would have done on X.
parent | Parent window, or nullptr . |
void Gtk::Window::set_type_hint | ( | Gdk::Surface::TypeHint | hint | ) |
By setting the type hint for the window, you allow the window manager to decorate and handle the window in a way which is suitable to the function of the window in your application.
This function should be called before the window becomes visible.
Gtk::Dialog::new_with_buttons() and other convenience functions in GTK+ will sometimes call set_type_hint() on your behalf.
hint | The window type. |
void Gtk::Window::show_uri | ( | const Glib::ustring & | uri, |
guint32 | timestamp | ||
) |
This is a convenience function for launching the default application to show the uri.
The uri must be of a form understood by GIO (i.e. you need to install gvfs to get support for uri schemes such as http:// or ftp://, as only local files are handled by GIO itself). Typical examples are
file:///home/gnome/pict.jpg
http://www.gnome.org
mailto:me @a gnome.org
Ideally the timestamp is taken from the event triggering the gtk_show_uri_on_window() call. If timestamp is not known you can take GDK_CURRENT_TIME.
This is the recommended call to be used as it passes information necessary for sandbox helpers to parent their dialogs properly.
uri | The uri to show. |
timestamp | A timestamp to prevent focus stealing. |
Glib::Error |
Glib::SignalProxy<bool()> Gtk::Window::signal_close_request | ( | ) |
bool on_my_close_request()
Flags: Run Last
The signal_close_request() signal is emitted when the user clicks on the close button of the window.
Return: true
to stop other handlers from being invoked for the signal
Glib::SignalProxy<void()> Gtk::Window::signal_keys_changed | ( | ) |
void on_my_keys_changed()
Flags: Run First
The signal_keys_changed() signal gets emitted when the set of accelerators or mnemonics that are associated with window changes.
void Gtk::Window::stick | ( | ) |
Asks to stick window, which means that it will appear on all user desktops.
Note that you shouldn’t assume the window is definitely stuck afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch] could unstick it again, and some window managers do not support sticking windows. But normally the window will end up stuck. Just don't write code that crashes if not.
It’s permitted to call this function before showing a window.
You can track iconification via the Gdk::Surface::property_state() property.
void Gtk::Window::unfullscreen | ( | ) |
Asks to toggle off the fullscreen state for window.
Note that you shouldn’t assume the window is definitely not full screen afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could fullscreen it again, and not all window managers honor requests to unfullscreen windows. But normally the window will end up restored to its normal state. Just don’t write code that crashes if not.
You can track iconification via the Gdk::Surface::property_state() property
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][gtk-X11-arch]) could maximize it again, and not all window managers honor requests to unmaximize. But normally the window will end up unmaximized. Just don’t write code that crashes if not.
You can track iconification via the Gdk::Surface::property_state() property
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.
void Gtk::Window::unset_attached_to | ( | ) |
void Gtk::Window::unset_default_widget | ( | ) |
void Gtk::Window::unset_focus | ( | ) |
void Gtk::Window::unset_transient_for | ( | ) |
void Gtk::Window::unstick | ( | ) |
Asks to unstick window, which means that it will appear on only one of the user’s desktops.
Note that you shouldn’t assume the window is definitely unstuck afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could stick it again. But normally the window will end up stuck. Just don’t write code that crashes if not.
You can track iconification via the Gdk::Surface::property_state() property.
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |