Ardour  9.0-pre0-384-ga76afae0e9
Gtk::Window Class Reference

#include <window.h>

Inheritance diagram for Gtk::Window:
[legend]

Public Member Functions

virtual ~Window ()
 
GtkWindowgobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkWindowgobj () const
 Provides access to the underlying C GtkObject. More...
 
 Window (WindowType type=WINDOW_TOPLEVEL)
 
Glib::PropertyProxy_ReadOnly< WindowTypeproperty_type () const
 
Glib::PropertyProxy< Glib::ustring > property_title ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_title () const
 
Glib::PropertyProxy_WriteOnly< Glib::ustring > property_startup_id ()
 
Glib::PropertyProxy< bool > property_allow_shrink ()
 
Glib::PropertyProxy_ReadOnly< bool > property_allow_shrink () const
 
Glib::PropertyProxy< bool > property_allow_grow ()
 
Glib::PropertyProxy_ReadOnly< bool > property_allow_grow () const
 
Glib::PropertyProxy< bool > property_resizable ()
 
Glib::PropertyProxy_ReadOnly< bool > property_resizable () const
 
Glib::PropertyProxy< bool > property_modal ()
 
Glib::PropertyProxy_ReadOnly< bool > property_modal () const
 
Glib::PropertyProxy< WindowPositionproperty_window_position ()
 
Glib::PropertyProxy_ReadOnly< WindowPositionproperty_window_position () const
 
Glib::PropertyProxy< int > property_default_width ()
 
Glib::PropertyProxy_ReadOnly< int > property_default_width () const
 
Glib::PropertyProxy< int > property_default_height ()
 
Glib::PropertyProxy_ReadOnly< int > property_default_height () const
 
Glib::PropertyProxy< bool > property_destroy_with_parent ()
 
Glib::PropertyProxy_ReadOnly< bool > property_destroy_with_parent () const
 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > > property_icon ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > > property_icon () const
 
Glib::PropertyProxy< bool > property_mnemonics_visible ()
 
Glib::PropertyProxy_ReadOnly< bool > property_mnemonics_visible () const
 
Glib::PropertyProxy< Glib::ustring > property_icon_name ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_icon_name () const
 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Screen > > property_screen ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Screen > > property_screen () const
 
Glib::PropertyProxy_ReadOnly< bool > property_is_active () const
 
Glib::PropertyProxy_ReadOnly< bool > property_has_toplevel_focus () const
 
Glib::PropertyProxy< GdkWindowTypeHintproperty_type_hint ()
 
Glib::PropertyProxy_ReadOnly< GdkWindowTypeHintproperty_type_hint () const
 
Glib::PropertyProxy< bool > property_skip_taskbar_hint ()
 
Glib::PropertyProxy_ReadOnly< bool > property_skip_taskbar_hint () const
 
Glib::PropertyProxy< bool > property_skip_pager_hint ()
 
Glib::PropertyProxy_ReadOnly< bool > property_skip_pager_hint () const
 
Glib::PropertyProxy< Glib::ustring > property_role ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_role () const
 
Glib::PropertyProxy< bool > property_decorated ()
 
Glib::PropertyProxy_ReadOnly< bool > property_decorated () const
 
Glib::PropertyProxy< Gdk::Gravityproperty_gravity ()
 
Glib::PropertyProxy_ReadOnly< Gdk::Gravityproperty_gravity () const
 
Glib::PropertyProxy< Window * > property_transient_for ()
 
Glib::PropertyProxy_ReadOnly< Window * > property_transient_for () const
 
Glib::PropertyProxy< double > property_opacity ()
 
Glib::PropertyProxy_ReadOnly< double > property_opacity () const
 
Glib::PropertyProxy< bool > property_urgency_hint ()
 
Glib::PropertyProxy_ReadOnly< bool > property_urgency_hint () const
 
Glib::PropertyProxy< bool > property_accept_focus ()
 
Glib::PropertyProxy_ReadOnly< bool > property_accept_focus () const
 
Glib::PropertyProxy< bool > property_focus_on_map ()
 
Glib::PropertyProxy_ReadOnly< bool > property_focus_on_map () const
 
Glib::PropertyProxy< bool > property_deletable ()
 
Glib::PropertyProxy_ReadOnly< bool > property_deletable () const
 
bool is_toplevel () const
 
bool is_popup () const
 
Glib::RefPtr< Gdk::Windowget_frame ()
 
Glib::RefPtr< const Gdk::Windowget_frame () const
 
Glib::SignalProxy1< void, Widget * > signal_set_focus ()
 
Glib::SignalProxy1< bool, GdkEvent * > signal_frame_event ()
 
void set_title (const Glib::ustring &title)
 
Glib::ustring get_title () const
 
void set_wmclass (const Glib::ustring &wmclass_name, const Glib::ustring &wmclass_class)
 
void set_role (const Glib::ustring &role)
 
Glib::ustring get_role () const
 
void add_accel_group (const Glib::RefPtr< AccelGroup > &accel_group)
 
void remove_accel_group (const Glib::RefPtr< AccelGroup > &accel_group)
 
void set_position (WindowPosition position)
 
bool activate_focus ()
 
void set_focus (Gtk::Widget &focus)
 
void unset_focus ()
 
Widgetget_focus ()
 
const Widgetget_focus () const
 
void set_default (Gtk::Widget &default_widget)
 
void unset_default ()
 
bool activate_default ()
 
void set_transient_for (Window &parent)
 
void unset_transient_for ()
 
Windowget_transient_for ()
 
const Windowget_transient_for () const
 
void set_opacity (double opacity)
 
double get_opacity () const
 
void set_type_hint (Gdk::WindowTypeHint hint)
 
Gdk::WindowTypeHint get_type_hint () const
 
void set_skip_taskbar_hint (bool setting=true)
 
bool get_skip_taskbar_hint () const
 
void set_skip_pager_hint (bool setting=true)
 
bool get_skip_pager_hint () const
 
void set_urgency_hint (bool setting=true)
 
bool get_urgency_hint () const
 
void set_accept_focus (bool setting=true)
 
bool get_accept_focus () const
 
void set_focus_on_map (bool setting=true)
 
bool get_focus_on_map () const
 
bool get_destroy_with_parent () const
 
void set_mnemonics_visible (bool setting=true)
 
bool get_mnemonics_visible () const
 
void set_resizable (bool resizable=true)
 
bool get_resizable () const
 
void set_gravity (Gdk::Gravity gravity)
 
Gdk::Gravity get_gravity () const
 
void set_geometry_hints (Widget &geometry_widget, const Gdk::Geometry &geometry, Gdk::WindowHints geom_mask)
 
void set_screen (const Glib::RefPtr< Gdk::Screen > &screen)
 
Glib::RefPtr< Gdk::Screenget_screen ()
 
Glib::RefPtr< const Gdk::Screenget_screen () const
 
void set_has_frame (bool setting=true)
 
bool get_has_frame () const
 
void set_frame_dimensions (int left, int top, int right, int bottom)
 
void get_frame_dimensions (int &left, int &top, int &right, int &bottom) const
 
void set_decorated (bool setting=true)
 
bool get_decorated () const
 
void set_deletable (bool setting=true)
 
bool get_deletable () const
 
Glib::ListHandle< Glib::RefPtr< Gdk::Pixbuf > > get_icon_list ()
 
Glib::ListHandle< Glib::RefPtr< const Gdk::Pixbuf > > get_icon_list () const
 
void set_icon_list (const Glib::ListHandle< Glib::RefPtr< Gdk::Pixbuf > > &list)
 
void set_icon (const Glib::RefPtr< Gdk::Pixbuf > &icon)
 
void set_icon_name (const Glib::ustring &name)
 
bool set_icon_from_file (const std::string &filename)
 
Glib::RefPtr< Gdk::Pixbufget_icon ()
 
Glib::RefPtr< const Gdk::Pixbufget_icon () const
 
Glib::ustring get_icon_name () const
 
void set_modal (bool modal=true)
 
bool get_modal () const
 
void add_mnemonic (guint keyval, Widget &target)
 
void remove_mnemonic (guint keyval, Widget &target)
 
bool mnemonic_activate (guint keyval, Gdk::ModifierType modifier)
 
void set_mnemonic_modifier (Gdk::ModifierType modifier)
 
Gdk::ModifierType get_mnemonic_modifier ()
 
void present ()
 
void present (guint32 timestamp)
 
void iconify ()
 
void deiconify ()
 
void stick ()
 
void unstick ()
 
void maximize ()
 
void unmaximize ()
 
void fullscreen ()
 
void unfullscreen ()
 
void begin_resize_drag (Gdk::WindowEdge edge, int button, int root_x, int root_y, guint32 timestamp)
 
void begin_move_drag (int button, int root_x, int root_y, guint32 timestamp)
 
void set_default_size (int width, int height)
 
void get_default_size (int &width, int &height) const
 
void resize (int width, int height)
 
void get_size (int &width, int &height) const
 
void move (int x, int y)
 
void get_position (int &root_x, int &root_y) const
 
bool parse_geometry (const Glib::ustring &geometry)
 
Glib::RefPtr< WindowGroupget_group ()
 
Glib::RefPtr< const WindowGroupget_group () const
 
WindowType get_window_type () const
 
void reshow_with_initial_size ()
 
void set_keep_above (bool setting=true)
 
void set_keep_below (bool setting=true)
 
Glib::RefPtr< AccelGroupget_accel_group ()
 
virtual void raise ()
 
virtual void set_manage ()
 Overriden to warn that it doesn't make sense to use Gtk::manage() on this class because it has no parent container. More...
 
- Public Member Functions inherited from Gtk::Bin
virtual ~Bin ()
 
GtkBingobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkBingobj () const
 Provides access to the underlying C GtkObject. More...
 
Gtk::Widgetget_child ()
 
const Gtk::Widgetget_child () const
 
void remove ()
 
void add_label (const Glib::ustring &label, bool mnemonic=false, double x_align=0.5, double y_align=0.5)
 
void add_label (const Glib::ustring &label, bool mnemonic, AlignmentEnum x_align, AlignmentEnum y_align=ALIGN_CENTER)
 
void add_pixmap (const Glib::RefPtr< Gdk::Pixmap > &pixmap, const Glib::RefPtr< Gdk::Bitmap > &mask)
 
void add_pixlabel (const Glib::RefPtr< Gdk::Pixmap > &pixmap, const Glib::RefPtr< Gdk::Bitmap > &mask, const Glib::ustring &label, double x_align=0.5, double y_align=0.5)
 
void add_pixlabel (const Glib::ustring &pixfile, const Glib::ustring &label, double x_align=0.5, double y_align=0.5)
 
- Public Member Functions inherited from Gtk::Container
virtual ~Container ()
 
GtkContainergobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkContainergobj () const
 Provides access to the underlying C GtkObject. More...
 
void set_border_width (guint border_width)
 
guint get_border_width () const
 
virtual void add (Widget &widget)
 
void remove (Widget &widget)
 
void set_resize_mode (ResizeMode resize_mode)
 
ResizeMode get_resize_mode () const
 
void check_resize ()
 
void foreach (const ForeachSlot &slot)
 
Glib::ListHandle< Widget * > get_children ()
 (internal) Operate on contained items (see foreach()) More...
 
Glib::ListHandle< const Widget * > get_children () const
 
void propagate_expose (Widget &child, GdkEventExpose *event)
 
void set_focus_chain (const Glib::ListHandle< Widget * > &focusable_widgets)
 
bool has_focus_chain () const
 
Glib::ListHandle< Widget * > get_focus_chain ()
 
Glib::ListHandle< const Widget * > get_focus_chain () const
 
void unset_focus_chain ()
 
void set_reallocate_redraws (bool needs_redraws=true)
 
void set_focus_child (Widget &widget)
 
void set_focus_vadjustment (Adjustment &adjustment)
 
Adjustmentget_focus_vadjustment ()
 
const Adjustmentget_focus_vadjustment () const
 
void set_focus_hadjustment (Adjustment &adjustment)
 
Adjustmentget_focus_hadjustment ()
 
const Adjustmentget_focus_hadjustment () const
 
void resize_children ()
 
GType child_type () const
 
Glib::SignalProxy1< void, Widget * > signal_add ()
 
Glib::SignalProxy1< void, Widget * > signal_remove ()
 
Glib::SignalProxy0< void > signal_check_resize ()
 
Glib::SignalProxy1< void, Widget * > signal_set_focus_child ()
 
void show_all_children (bool recursive=true)
 
- Public Member Functions inherited from Gtk::Widget
virtual ~Widget ()
 
GtkWidgetgobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkWidgetgobj () const
 Provides access to the underlying C GtkObject. More...
 
bool set_scroll_adjustments (Adjustment &hadjustment, Adjustment &vadjustment)
 
void show ()
 
void show_now ()
 
void hide ()
 
void show_all ()
 
void hide_all ()
 
void queue_draw ()
 
void queue_draw_area (int x, int y, int width, int height)
 
void queue_resize ()
 
Requisition size_request () const
 
void size_request (const Requisition &requisition)
 
void size_allocate (const Allocation &allocation)
 
void add_accelerator (const Glib::ustring &accel_signal, const Glib::RefPtr< AccelGroup > &accel_group, guint accel_key, Gdk::ModifierType accel_mods, AccelFlags accel_flags)
 
bool remove_accelerator (const Glib::RefPtr< AccelGroup > &accel_group, guint accel_key, Gdk::ModifierType accel_mods)
 
void set_accel_path (const Glib::ustring &accel_path, const Glib::RefPtr< AccelGroup > &accel_group)
 
bool mnemonic_activate (bool group_cycling)
 
bool event (GdkEvent *event)
 
int send_expose (GdkEvent *event)
 
bool send_focus_change (GdkEvent *event)
 
bool activate ()
 
void reparent (Widget &new_parent)
 
bool intersect (const Gdk::Rectangle &area) const
 
bool intersect (const Gdk::Rectangle &area, Gdk::Rectangle &intersection) const
 
Gdk::Region region_intersect (const Gdk::Region &region) const
 
void freeze_child_notify ()
 
void child_notify (const Glib::ustring &child_property)
 
void thaw_child_notify ()
 
void set_can_focus (bool can_focus=true)
 
bool get_can_focus () const
 
bool can_focus () const
 
bool has_focus () const
 
bool is_focus () const
 
void grab_focus ()
 
void set_can_default (bool can_default=true)
 
bool get_can_default () const
 
bool can_default () const
 
bool has_default () const
 
void grab_default ()
 
void set_receives_default (bool receives_default=true)
 
bool get_receives_default () const
 
bool has_grab () const
 
void add_modal_grab ()
 
void remove_modal_grab ()
 
void set_name (const Glib::ustring &name)
 
void unset_name ()
 
Glib::ustring get_name () const
 
void set_state (StateType state)
 
StateType get_state () const
 
void set_sensitive (bool sensitive=true)
 
bool get_sensitive () const
 
bool is_sensitive () const
 
void set_visible (bool visible=true)
 
bool get_visible () const
 
void set_has_window (bool has_window=true)
 
bool get_has_window () const
 
bool get_is_toplevel () const
 
bool get_is_drawable () const
 
bool get_realized () const
 
bool get_mapped () const
 
void set_app_paintable (bool app_paintable=true)
 
bool get_app_paintable () const
 
void set_double_buffered (bool double_buffered=true)
 
bool get_double_buffered () const
 
void set_redraw_on_allocate (bool redraw_on_allocate=true)
 
void set_child_visible (bool is_visible=true)
 
bool get_child_visible () const
 
void set_window (const Glib::RefPtr< Gdk::Window > &window)
 
Glib::RefPtr< Gdk::Windowget_window ()
 
Glib::RefPtr< const Gdk::Windowget_window () const
 
Allocation get_allocation () const
 
void set_allocation (const Allocation &allocation)
 
Containerget_parent ()
 
const Containerget_parent () const
 
Glib::RefPtr< Gdk::Windowget_parent_window ()
 
Glib::RefPtr< const Gdk::Windowget_parent_window () const
 
void set_parent_window (const Glib::RefPtr< const Gdk::Window > &parent_window)
 
bool child_focus (DirectionType direction)
 
bool keynav_failed (DirectionType direction)
 
void error_bell ()
 
void set_size_request (int width=-1, int height=-1)
 
void get_size_request (int &width, int &height) const
 
void set_events (Gdk::EventMask events)
 
void add_events (Gdk::EventMask events)
 
void set_extension_events (Gdk::ExtensionMode mode)
 
Gdk::ExtensionMode get_extension_events () const
 
Containerget_toplevel ()
 
const Containerget_toplevel () const
 
Widgetget_ancestor (GType widget_type)
 
const Widgetget_ancestor (GType widget_type) const
 
Glib::RefPtr< Gdk::Colormapget_colormap ()
 
Glib::RefPtr< Gdk::Visualget_visual ()
 
Glib::RefPtr< Gdk::Screenget_screen ()
 
Glib::RefPtr< const Gdk::Screenget_screen () const
 
bool has_screen () const
 
Glib::RefPtr< Gdk::Displayget_display ()
 
Glib::RefPtr< const Gdk::Displayget_display () const
 
Glib::RefPtr< Gdk::Windowget_root_window ()
 
Glib::RefPtr< const Gdk::Windowget_root_window () const
 
Glib::RefPtr< Settingsget_settings ()
 
Glib::RefPtr< Clipboardget_clipboard (const Glib::ustring &selection)
 
Glib::RefPtr< const Clipboardget_clipboard (const Glib::ustring &selection) const
 
Glib::RefPtr< Gdk::Pixmapget_snapshot (Gdk::Rectangle &clip_rect) const
 
Glib::RefPtr< Gdk::Pixmapget_snapshot () const
 
void set_colormap (const Glib::RefPtr< const Gdk::Colormap > &colormap)
 
Gdk::EventMask get_events () const
 
void get_pointer (int &x, int &y) const
 
bool is_ancestor (Widget &ancestor) const
 
bool translate_coordinates (Widget &dest_widget, int src_x, int src_y, int &dest_x, int &dest_y)
 
bool has_rc_style () const
 
void set_style (const Glib::RefPtr< Style > &style)
 
void unset_style ()
 
void ensure_style ()
 
Glib::RefPtr< Styleget_style ()
 
Glib::RefPtr< const Styleget_style () const
 
void modify_style (const Glib::RefPtr< RcStyle > &style)
 
Glib::RefPtr< RcStyleget_modifier_style ()
 
Glib::RefPtr< const RcStyleget_modifier_style () const
 
void modify_fg (StateType state, const Gdk::Color &color)
 
void modify_bg (StateType state, const Gdk::Color &color)
 
void modify_bg_pixmap (StateType state, const Glib::ustring &pixmap_name)
 
void modify_text (StateType state, const Gdk::Color &color)
 
void modify_base (StateType state, const Gdk::Color &color)
 
void modify_cursor (const Gdk::Color &primary, const Gdk::Color &secondary)
 
void unset_cursor ()
 See modify_cursor(). More...
 
void modify_font (const Pango::FontDescription &font_desc)
 
void unset_fg (StateType state)
 
void unset_bg (StateType state)
 
void unset_text (StateType state)
 
void unset_base (StateType state)
 
void unset_font ()
 
template<class PropertyType >
void get_style_property (const Glib::ustring &the_property_name, PropertyType &value) const
 
Glib::RefPtr< Pango::Context > create_pango_context ()
 
Glib::RefPtr< Pango::Context > get_pango_context ()
 
Glib::RefPtr< Pango::Layout > create_pango_layout (const Glib::ustring &text)
 
Glib::RefPtr< Gdk::Pixbufrender_icon (const StockID &stock_id, IconSize size, const Glib::ustring &detail=Glib::ustring())
 
void set_composite_name (const Glib::ustring &name)
 
void unset_composite_name ()
 
Glib::ustring get_composite_name () const
 
void reset_rc_styles ()
 
void set_direction (TextDirection dir)
 
TextDirection get_direction ()
 
TextDirection get_direction () const
 
void shape_combine_mask (const Glib::RefPtr< const Gdk::Bitmap > &shape_mask, int offset_x, int offset_y)
 
void unset_shape_combine_mask ()
 
void input_shape_combine_mask (const Glib::RefPtr< const Gdk::Bitmap > &shape_mask, int offset_x, int offset_y)
 
void unset_input_shape_combine_mask ()
 
void reset_shapes ()
 
void path (Glib::ustring &path, Glib::ustring &path_reversed)
 Compute a widget's path of the form "GtkWindow.MyLabel". More...
 
void class_path (Glib::ustring &path, Glib::ustring &path_reversed)
 
Glib::ListHandle< Widget * > list_mnemonic_labels ()
 
Glib::ListHandle< const Widget * > list_mnemonic_labels () const
 
void add_mnemonic_label (Widget &label)
 
void remove_mnemonic_label (Widget &label)
 
void drag_get_data (const Glib::RefPtr< Gdk::DragContext > &context, Glib::ustring &target, guint32 time)
 
void drag_get_data (const Glib::RefPtr< Gdk::DragContext > &context, const Glib::ustring &target, guint32 time)
 
void drag_highlight ()
 
void drag_unhighlight ()
 
void drag_dest_set (DestDefaults flags=DestDefaults(0), Gdk::DragAction actions=Gdk::DragAction(0))
 
void drag_dest_set (const ArrayHandle_TargetEntry &targets, DestDefaults flags=DEST_DEFAULT_ALL, Gdk::DragAction actions=Gdk::ACTION_COPY)
 
void drag_dest_set_proxy (const Glib::RefPtr< Gdk::Window > &proxy_window, Gdk::DragProtocol protocol, bool use_coordinates)
 
void drag_dest_unset ()
 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext > &context, const Glib::RefPtr< TargetList > &target_list) const
 
Glib::ustring drag_dest_find_target (const Glib::RefPtr< Gdk::DragContext > &context) const
 
Glib::RefPtr< TargetListdrag_dest_get_target_list ()
 
Glib::RefPtr< const TargetListdrag_dest_get_target_list () const
 
void drag_dest_set_target_list (const Glib::RefPtr< TargetList > &target_list)
 
void drag_dest_add_text_targets ()
 
void drag_dest_add_image_targets ()
 
void drag_dest_add_uri_targets ()
 
void drag_source_set (const ArrayHandle_TargetEntry &targets, Gdk::ModifierType start_button_mask=Gdk::MODIFIER_MASK, Gdk::DragAction actions=Gdk::ACTION_COPY)
 
void drag_source_unset ()
 
void drag_source_set_icon (const Glib::RefPtr< Gdk::Colormap > &colormap, const Glib::RefPtr< Gdk::Pixmap > &pixmap, const Glib::RefPtr< Gdk::Bitmap > &mask)
 
void drag_source_set_icon (const Glib::RefPtr< Gdk::Pixbuf > &pixbuf)
 
void drag_source_set_icon (const StockID &stock_id)
 
void drag_source_set_icon (const Glib::ustring &icon_name)
 
void drag_source_add_text_targets ()
 
void drag_source_add_uri_targets ()
 
void drag_source_add_image_targets ()
 
Glib::RefPtr< Gdk::DragContextdrag_begin (const Glib::RefPtr< TargetList > &targets, Gdk::DragAction actions, int button, GdkEvent *event)
 
bool drag_check_threshold (int start_x, int start_y, int current_x, int current_y)
 
void drag_set_as_icon (const Glib::RefPtr< Gdk::DragContext > &context, int hot_x, int hot_y)
 
void queue_resize_no_redraw ()
 
bool get_no_show_all () const
 
void set_no_show_all (bool no_show_all=true)
 
void set_parent (Widget &parent)
 
void unparent ()
 
void map ()
 
void unmap ()
 
void draw_insertion_cursor (Glib::RefPtr< Gdk::Drawable > drawable, const Gdk::Rectangle &area, const Gdk::Rectangle &location, bool is_primary, TextDirection direction, bool draw_arrow=true)
 
void set_tooltip_window (Window &window)
 
Windowget_tooltip_window ()
 
void trigger_tooltip_query ()
 
void set_tooltip_text (const Glib::ustring &text)
 
Glib::ustring get_tooltip_text () const
 
void set_tooltip_markup (const Glib::ustring &markup)
 
Glib::ustring get_tooltip_markup () const
 
void set_has_tooltip (bool has_tooltip=TRUE)
 
bool get_has_tooltip () const
 
bool has_no_window () const
 
bool is_realized () const
 
bool is_mapped () const
 
bool is_toplevel () const
 
bool is_drawable () const
 
bool is_visible () const
 
bool sensitive () const
 
bool app_paintable () const
 
bool receives_default () const
 
bool double_buffered () const
 
bool parent_sensitive () const
 
bool rc_style () const
 
bool is_composite_child () const
 
WidgetFlags get_flags () const
 
void set_flags (WidgetFlags flags)
 
void unset_flags (WidgetFlags flags)
 
Gtk::StateType get_saved_state () const
 
int get_width () const
 
int get_height () const
 
bool is_composited () const
 
Glib::RefPtr< Actionget_action ()
 
Glib::RefPtr< const Actionget_action () const
 
Requisition get_requisition () const
 
Glib::SignalProxy0< void > signal_show ()
 
Glib::SignalProxy0< void > signal_hide ()
 
Glib::SignalProxy0< void > signal_map ()
 Emitted on mapping of a widget to the screen. More...
 
Glib::SignalProxy0< void > signal_unmap ()
 
Glib::SignalProxy0< void > signal_realize ()
 Emitted on realization of a widget. More...
 
Glib::SignalProxy0< void > signal_unrealize ()
 
Glib::SignalProxy1< void, Requisition * > signal_size_request ()
 
Glib::SignalProxy1< void, Allocation & > signal_size_allocate ()
 
Glib::SignalProxy1< void, Gtk::StateTypesignal_state_changed ()
 
Glib::SignalProxy1< void, Widget * > signal_parent_changed ()
 Informs objects that their parent changed. More...
 
Glib::SignalProxy1< void, Widget * > signal_hierarchy_changed ()
 
Glib::SignalProxy1< void, const Glib::RefPtr< Gtk::Style > & > signal_style_changed ()
 
Glib::SignalProxy1< void, TextDirectionsignal_direction_changed ()
 
Glib::SignalProxy1< void, bool > signal_grab_notify ()
 
Glib::SignalProxy1< void, GParamSpec * > signal_child_notify ()
 
Glib::SignalProxy1< bool, bool > signal_mnemonic_activate ()
 
Glib::SignalProxy0< void > signal_grab_focus ()
 
Glib::SignalProxy1< bool, DirectionTypesignal_focus ()
 
Glib::SignalProxy1< bool, GdkEvent * > signal_event ()
 
Glib::SignalProxy1< void, GdkEvent * > signal_event_after ()
 
Glib::SignalProxy1< bool, GdkEventButton * > signal_button_press_event ()
 
Glib::SignalProxy1< bool, GdkEventButton * > signal_button_release_event ()
 
Glib::SignalProxy1< bool, GdkEventScroll * > signal_scroll_event ()
 
Glib::SignalProxy1< bool, GdkEventMotion * > signal_motion_notify_event ()
 
Glib::SignalProxy1< bool, GdkEventAny * > signal_delete_event ()
 
Glib::SignalProxy1< bool, GdkEventExpose * > signal_expose_event ()
 Event triggered by window requiring a refresh. More...
 
Glib::SignalProxy1< bool, GdkEventKey * > signal_key_press_event ()
 
Glib::SignalProxy1< bool, GdkEventKey * > signal_key_release_event ()
 
Glib::SignalProxy1< bool, GdkEventCrossing * > signal_enter_notify_event ()
 
Glib::SignalProxy1< bool, GdkEventCrossing * > signal_leave_notify_event ()
 
Glib::SignalProxy1< bool, GdkEventConfigure * > signal_configure_event ()
 
Glib::SignalProxy1< bool, GdkEventFocus * > signal_focus_in_event ()
 
Glib::SignalProxy1< bool, GdkEventFocus * > signal_focus_out_event ()
 
Glib::SignalProxy1< bool, GdkEventAny * > signal_map_event ()
 
Glib::SignalProxy1< bool, GdkEventAny * > signal_unmap_event ()
 
Glib::SignalProxy1< bool, GdkEventProperty * > signal_property_notify_event ()
 
Glib::SignalProxy1< bool, GdkEventSelection * > signal_selection_clear_event ()
 
Glib::SignalProxy1< bool, GdkEventSelection * > signal_selection_request_event ()
 
Glib::SignalProxy1< bool, GdkEventSelection * > signal_selection_notify_event ()
 
Glib::SignalProxy1< bool, GdkEventProximity * > signal_proximity_in_event ()
 
Glib::SignalProxy1< bool, GdkEventProximity * > signal_proximity_out_event ()
 
Glib::SignalProxy1< bool, GdkEventVisibility * > signal_visibility_notify_event ()
 
Glib::SignalProxy1< bool, GdkEventClient * > signal_client_event ()
 
Glib::SignalProxy1< bool, GdkEventAny * > signal_no_expose_event ()
 
Glib::SignalProxy1< bool, GdkEventWindowState * > signal_window_state_event ()
 
Glib::SignalProxy3< void, SelectionData &, guint, guint > signal_selection_get ()
 
Glib::SignalProxy2< void, const SelectionData &, guint > signal_selection_received ()
 
Glib::SignalProxy1< void, const Glib::RefPtr< Gdk::DragContext > & > signal_drag_begin ()
 
Glib::SignalProxy1< void, const Glib::RefPtr< Gdk::DragContext > & > signal_drag_end ()
 
Glib::SignalProxy4< void, const Glib::RefPtr< Gdk::DragContext > &, SelectionData &, guint, guint > signal_drag_data_get ()
 
Glib::SignalProxy1< void, const Glib::RefPtr< Gdk::DragContext > & > signal_drag_data_delete ()
 
Glib::SignalProxy2< bool, const Glib::RefPtr< Gdk::DragContext > &, DragResultsignal_drag_failed ()
 
Glib::SignalProxy2< void, const Glib::RefPtr< Gdk::DragContext > &, guint > signal_drag_leave ()
 
Glib::SignalProxy4< bool, const Glib::RefPtr< Gdk::DragContext > &, int, int, guint > signal_drag_motion ()
 
Glib::SignalProxy4< bool, const Glib::RefPtr< Gdk::DragContext > &, int, int, guint > signal_drag_drop ()
 
Glib::SignalProxy6< void, const Glib::RefPtr< Gdk::DragContext > &, int, int, const SelectionData &, guint, guint > signal_drag_data_received ()
 
Glib::SignalProxy1< void, const Glib::RefPtr< Gdk::Screen > & > signal_screen_changed ()
 
Glib::SignalProxy0< void > signal_composited_changed ()
 
Glib::SignalProxy0< bool > signal_popup_menu ()
 
Glib::SignalProxy4< bool, int, int, bool, const Glib::RefPtr< Tooltip > & > signal_query_tooltip ()
 
Glib::SignalProxy1< bool, GdkEventGrabBroken * > signal_grab_broken_event ()
 
Glib::SignalProxy1< bool, GdkEventExpose * > signal_damage_event ()
 
Glib::PropertyProxy< Glib::ustring > property_name ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_name () const
 
Glib::PropertyProxy< Container * > property_parent ()
 
Glib::PropertyProxy_ReadOnly< Container * > property_parent () const
 
Glib::PropertyProxy< int > property_width_request ()
 
Glib::PropertyProxy_ReadOnly< int > property_width_request () const
 
Glib::PropertyProxy< int > property_height_request ()
 
Glib::PropertyProxy_ReadOnly< int > property_height_request () const
 
Glib::PropertyProxy< bool > property_visible ()
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 
Glib::PropertyProxy< bool > property_sensitive ()
 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 
Glib::PropertyProxy< bool > property_app_paintable ()
 
Glib::PropertyProxy_ReadOnly< bool > property_app_paintable () const
 
Glib::PropertyProxy< bool > property_can_focus ()
 
Glib::PropertyProxy_ReadOnly< bool > property_can_focus () const
 
Glib::PropertyProxy< bool > property_has_focus ()
 
Glib::PropertyProxy_ReadOnly< bool > property_has_focus () const
 
Glib::PropertyProxy< bool > property_is_focus ()
 
Glib::PropertyProxy_ReadOnly< bool > property_is_focus () const
 
Glib::PropertyProxy< bool > property_can_default ()
 
Glib::PropertyProxy_ReadOnly< bool > property_can_default () const
 
Glib::PropertyProxy< bool > property_has_default ()
 
Glib::PropertyProxy_ReadOnly< bool > property_has_default () const
 
Glib::PropertyProxy< bool > property_receives_default ()
 
Glib::PropertyProxy_ReadOnly< bool > property_receives_default () const
 
Glib::PropertyProxy_ReadOnly< bool > property_composite_child () const
 
Glib::PropertyProxy< Glib::RefPtr< Style > > property_style ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Style > > property_style () const
 
Glib::PropertyProxy< Gdk::EventMaskproperty_events ()
 
Glib::PropertyProxy_ReadOnly< Gdk::EventMaskproperty_events () const
 
Glib::PropertyProxy< Gdk::ExtensionModeproperty_extension_events ()
 
Glib::PropertyProxy_ReadOnly< Gdk::ExtensionModeproperty_extension_events () const
 
Glib::PropertyProxy< bool > property_has_tooltip ()
 
Glib::PropertyProxy_ReadOnly< bool > property_has_tooltip () const
 
Glib::PropertyProxy< Glib::ustring > property_tooltip_markup ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_tooltip_markup () const
 
Glib::PropertyProxy< Glib::ustring > property_tooltip_text ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_tooltip_text () const
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Window > > property_window () const
 
Glib::PropertyProxy< bool > property_no_show_all ()
 
Glib::PropertyProxy_ReadOnly< bool > property_no_show_all () const
 
Glib::PropertyProxy< bool > property_double_buffered ()
 
Glib::PropertyProxy_ReadOnly< bool > property_double_buffered () const
 
- Public Member Functions inherited from Gtk::Object
virtual ~Object ()
 
GtkObjectgobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkObjectgobj () const
 Provides access to the underlying C GtkObject. More...
 
Glib::PropertyProxy< void * > property_user_data ()
 
Glib::PropertyProxy_ReadOnly< void * > property_user_data () const
 

Static Public Member Functions

static void set_default_icon_list (const Glib::ListHandle< Glib::RefPtr< Gdk::Pixbuf > > &list)
 
static Glib::ListHandle< Glib::RefPtr< Gdk::Pixbuf > > get_default_icon_list ()
 
static void set_default_icon (const Glib::RefPtr< Gdk::Pixbuf > &icon)
 
static void set_default_icon_name (const Glib::ustring &name)
 
static bool set_default_icon_from_file (const std::string &filename)
 
static void set_auto_startup_notification (bool setting=true)
 
static Glib::ListHandle< Window * > list_toplevels ()
 
- Static Public Member Functions inherited from Gtk::Widget
static Widgetget_current_modal_grab ()
 
static void push_colormap (const Glib::RefPtr< const Gdk::Colormap > &cmap)
 
static void pop_colormap ()
 
static void push_composite_child ()
 
static void pop_composite_child ()
 
static void set_default_colormap (const Glib::RefPtr< const Gdk::Colormap > &colormap)
 
static Glib::RefPtr< Styleget_default_style ()
 
static Glib::RefPtr< Gdk::Colormapget_default_colormap ()
 
static Glib::RefPtr< Gdk::Visualget_default_visual ()
 
static void set_default_direction (TextDirection dir)
 
static TextDirection get_default_direction ()
 
static Widgetdrag_get_source_widget (const Glib::RefPtr< Gdk::DragContext > &context)
 

Protected Member Functions

virtual void on_set_focus (Widget *focus)
 This is a default handler for the signal signal_set_focus(). More...
 
virtual bool on_frame_event (GdkEvent *event)
 This is a default handler for the signal signal_frame_event(). More...
 
void destroy_ ()
 
void _destroy_c_instance ()
 
- Protected Member Functions inherited from Gtk::Bin
 Bin ()
 
- Protected Member Functions inherited from Gtk::Container
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 on_check_resize ()
 This is a default handler for the signal signal_check_resize(). More...
 
virtual void on_set_focus_child (Widget *widget)
 This is a default handler for the signal signal_set_focus_child(). More...
 
 Container ()
 
virtual GType child_type_vfunc () const
 
virtual void forall_vfunc (gboolean include_internals, GtkCallback callback, gpointer callback_data)
 
virtual char * composite_name_vfunc (GtkWidget *child)
 
virtual void set_child_property_vfunc (GtkWidget *child, guint property_id, const GValue *value, GParamSpec *pspec)
 
virtual void get_child_property_vfunc (GtkWidget *child, guint property_id, GValue *value, GParamSpec *pspec) const
 
Glib::PropertyProxy< guint > property_border_width ()
 
Glib::PropertyProxy_ReadOnly< guint > property_border_width () const
 
Glib::PropertyProxy< ResizeModeproperty_resize_mode ()
 
Glib::PropertyProxy_ReadOnly< ResizeModeproperty_resize_mode () const
 
Glib::PropertyProxy_WriteOnly< Widget * > property_child ()
 
- Protected Member Functions inherited from Gtk::Widget
virtual void on_show ()
 This is a default handler for the signal signal_show(). More...
 
virtual void on_hide ()
 This is a default handler for the signal signal_hide(). More...
 
virtual void on_map ()
 This is a default handler for the signal signal_map(). More...
 
virtual void on_unmap ()
 This is a default handler for the signal signal_unmap(). More...
 
virtual void on_realize ()
 This is a default handler for the signal signal_realize(). More...
 
virtual void on_unrealize ()
 This is a default handler for the signal signal_unrealize(). More...
 
virtual void on_size_request (Requisition *requisition)
 This is a default handler for the signal signal_size_request(). More...
 
virtual void on_size_allocate (Allocation &allocation)
 This is a default handler for the signal signal_size_allocate(). More...
 
virtual void on_state_changed (Gtk::StateType previous_state)
 This is a default handler for the signal signal_state_changed(). More...
 
virtual void on_parent_changed (Widget *previous_parent)
 This is a default handler for the signal signal_parent_changed(). More...
 
virtual void on_hierarchy_changed (Widget *previous_toplevel)
 This is a default handler for the signal signal_hierarchy_changed(). More...
 
virtual void on_style_changed (const Glib::RefPtr< Gtk::Style > &previous_style)
 This is a default handler for the signal signal_style_changed(). More...
 
virtual void on_direction_changed (TextDirection direction)
 This is a default handler for the signal signal_direction_changed(). More...
 
virtual void on_grab_notify (bool was_grabbed)
 This is a default handler for the signal signal_grab_notify(). More...
 
virtual void on_child_notify (GParamSpec *pspec)
 This is a default handler for the signal signal_child_notify(). More...
 
virtual bool on_mnemonic_activate (bool group_cycling)
 This is a default handler for the signal signal_mnemonic_activate(). More...
 
virtual void on_grab_focus ()
 This is a default handler for the signal signal_grab_focus(). More...
 
virtual bool on_focus (DirectionType direction)
 This is a default handler for the signal signal_focus(). More...
 
virtual bool on_event (GdkEvent *event)
 This is a default handler for the signal signal_event(). More...
 
virtual bool on_button_press_event (GdkEventButton *event)
 This is a default handler for the signal signal_button_press_event(). More...
 
virtual bool on_button_release_event (GdkEventButton *event)
 This is a default handler for the signal signal_button_release_event(). More...
 
virtual bool on_scroll_event (GdkEventScroll *event)
 This is a default handler for the signal signal_scroll_event(). More...
 
virtual bool on_motion_notify_event (GdkEventMotion *event)
 This is a default handler for the signal signal_motion_notify_event(). More...
 
virtual bool on_delete_event (GdkEventAny *event)
 This is a default handler for the signal signal_delete_event(). More...
 
virtual bool on_expose_event (GdkEventExpose *event)
 This is a default handler for the signal signal_expose_event(). More...
 
virtual bool on_key_press_event (GdkEventKey *event)
 This is a default handler for the signal signal_key_press_event(). More...
 
virtual bool on_key_release_event (GdkEventKey *event)
 This is a default handler for the signal signal_key_release_event(). More...
 
virtual bool on_enter_notify_event (GdkEventCrossing *event)
 This is a default handler for the signal signal_enter_notify_event(). More...
 
virtual bool on_leave_notify_event (GdkEventCrossing *event)
 This is a default handler for the signal signal_leave_notify_event(). More...
 
virtual bool on_configure_event (GdkEventConfigure *event)
 This is a default handler for the signal signal_configure_event(). More...
 
virtual bool on_focus_in_event (GdkEventFocus *event)
 This is a default handler for the signal signal_focus_in_event(). More...
 
virtual bool on_focus_out_event (GdkEventFocus *event)
 This is a default handler for the signal signal_focus_out_event(). More...
 
virtual bool on_map_event (GdkEventAny *event)
 This is a default handler for the signal signal_map_event(). More...
 
virtual bool on_unmap_event (GdkEventAny *event)
 This is a default handler for the signal signal_unmap_event(). More...
 
virtual bool on_property_notify_event (GdkEventProperty *event)
 This is a default handler for the signal signal_property_notify_event(). More...
 
virtual bool on_selection_clear_event (GdkEventSelection *event)
 This is a default handler for the signal signal_selection_clear_event(). More...
 
virtual bool on_selection_request_event (GdkEventSelection *event)
 This is a default handler for the signal signal_selection_request_event(). More...
 
virtual bool on_selection_notify_event (GdkEventSelection *event)
 This is a default handler for the signal signal_selection_notify_event(). More...
 
virtual bool on_proximity_in_event (GdkEventProximity *event)
 This is a default handler for the signal signal_proximity_in_event(). More...
 
virtual bool on_proximity_out_event (GdkEventProximity *event)
 This is a default handler for the signal signal_proximity_out_event(). More...
 
virtual bool on_visibility_notify_event (GdkEventVisibility *event)
 This is a default handler for the signal signal_visibility_notify_event(). More...
 
virtual bool on_client_event (GdkEventClient *event)
 This is a default handler for the signal signal_client_event(). More...
 
virtual bool on_no_expose_event (GdkEventAny *event)
 This is a default handler for the signal signal_no_expose_event(). More...
 
virtual bool on_window_state_event (GdkEventWindowState *event)
 This is a default handler for the signal signal_window_state_event(). More...
 
virtual void on_selection_get (SelectionData &selection_data, guint info, guint time)
 This is a default handler for the signal signal_selection_get(). More...
 
virtual void on_selection_received (const SelectionData &selection_data, guint time)
 This is a default handler for the signal signal_selection_received(). More...
 
virtual void on_drag_begin (const Glib::RefPtr< Gdk::DragContext > &context)
 This is a default handler for the signal signal_drag_begin(). More...
 
virtual void on_drag_end (const Glib::RefPtr< Gdk::DragContext > &context)
 This is a default handler for the signal signal_drag_end(). More...
 
virtual void on_drag_data_get (const Glib::RefPtr< Gdk::DragContext > &context, SelectionData &selection_data, guint info, guint time)
 This is a default handler for the signal signal_drag_data_get(). More...
 
virtual void on_drag_data_delete (const Glib::RefPtr< Gdk::DragContext > &context)
 This is a default handler for the signal signal_drag_data_delete(). More...
 
virtual void on_drag_leave (const Glib::RefPtr< Gdk::DragContext > &context, guint time)
 This is a default handler for the signal signal_drag_leave(). More...
 
virtual bool on_drag_motion (const Glib::RefPtr< Gdk::DragContext > &context, int x, int y, guint time)
 This is a default handler for the signal signal_drag_motion(). More...
 
virtual bool on_drag_drop (const Glib::RefPtr< Gdk::DragContext > &context, int x, int y, guint time)
 This is a default handler for the signal signal_drag_drop(). More...
 
virtual void on_drag_data_received (const Glib::RefPtr< Gdk::DragContext > &context, int x, int y, const SelectionData &selection_data, guint info, guint time)
 This is a default handler for the signal signal_drag_data_received(). More...
 
virtual bool on_touch_begin_event (GdkEventTouch *event)
 
virtual bool on_touch_update_event (GdkEventTouch *event)
 
virtual bool on_touch_end_event (GdkEventTouch *event)
 
virtual void on_screen_changed (const Glib::RefPtr< Gdk::Screen > &previous_screen)
 This is a default handler for the signal signal_screen_changed(). More...
 
virtual void dispatch_child_properties_changed_vfunc (guint p1, GParamSpec **p2)
 
virtual void show_all_vfunc ()
 
virtual void hide_all_vfunc ()
 
 Widget ()
 
void realize ()
 
void unrealize ()
 
void set_mapped (bool mapped=true)
 
void set_realized (bool realized=true)
 
void style_attach ()
 
void get_child_requisition (Requisition &requisition) const
 
void get_style_property_value (const Glib::ustring &the_property_name, Glib::ValueBase &value) const
 
void realize_if_needed ()
 

Private Attributes

Glib::RefPtr< AccelGroupaccel_group_
 

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Public Types inherited from Gtk::Container
typedef sigc::slot< void, Widget & > ForeachSlot
 

Detailed Description

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.

Definition at line 158 of file ytkmm/ytkmm/gtkmm/window.h.

Constructor & Destructor Documentation

◆ ~Window()

virtual Gtk::Window::~Window ( )
virtual

◆ Window()

Gtk::Window::Window ( WindowType  type = WINDOW_TOPLEVEL)
explicit

Member Function Documentation

◆ _destroy_c_instance()

void Gtk::Window::_destroy_c_instance ( )
protected

◆ activate_default()

bool Gtk::Window::activate_default ( )

Activates the default widget for the window, unless the current focused widget has been configured to receive the default action (see Gtk::Widget::set_receives_default()), in which case the focused widget is activated.

Returns
true if a widget got activated.

◆ activate_focus()

bool Gtk::Window::activate_focus ( )

Activates the current focused widget within the window.

Returns
true if a widget got activated.

◆ add_accel_group()

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.

Parameters
accel_groupA Gtk::AccelGroup.

◆ add_mnemonic()

void Gtk::Window::add_mnemonic ( guint  keyval,
Widget target 
)

Adds a mnemonic to this window.

Parameters
keyvalThe mnemonic.
targetThe widget that gets activated by the mnemonic.

◆ begin_move_drag()

void Gtk::Window::begin_move_drag ( int  button,
int  root_x,
int  root_y,
guint32  timestamp 
)

Starts moving a window. This function is used if an application has window movement grips. When GDK can support it, the window movement will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window movement, potentially not all that well, depending on the windowing system.

Parameters
buttonMouse button that initiated the drag.
root_xX position where the user clicked to initiate the drag, in root window coordinates.
root_yY position where the user clicked to initiate the drag.
timestampTimestamp from the click event that initiated the drag.

◆ begin_resize_drag()

void Gtk::Window::begin_resize_drag ( Gdk::WindowEdge  edge,
int  button,
int  root_x,
int  root_y,
guint32  timestamp 
)

Starts resizing a window. This function is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window resizing, potentially not all that well, depending on the windowing system.

Parameters
buttonMouse button that initiated the drag.
edgePosition of the resize control.
root_xX position where the user clicked to initiate the drag, in root window coordinates.
root_yY position where the user clicked to initiate the drag.
timestampTimestamp from the click event that initiated the drag.

◆ deiconify()

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) could iconify it again before your code which assumes deiconification gets to run.

You can track iconification via the "window-state-event" signal on Gtk::Widget.

◆ destroy_()

void Gtk::Window::destroy_ ( )
protected

◆ fullscreen()

void Gtk::Window::fullscreen ( )

Asks to place window in the fullscreen state. Note that you shouldn't assume the window is definitely full screen afterward, because other entities (e.g. the user or window manager) 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 the fullscreen state via the "window-state-event" signal on Gtk::Widget.

◆ get_accel_group()

Glib::RefPtr<AccelGroup> Gtk::Window::get_accel_group ( )

Returns a default accel group for this window This is a gtkmm-specific function. This accel group can not be removed.

◆ get_accept_focus()

bool Gtk::Window::get_accept_focus ( ) const

Gets the value set by set_accept_focus().

Returns
true if window should receive the input focus.

◆ get_decorated()

bool Gtk::Window::get_decorated ( ) const

Returns whether the window has been set to have decorations such as a title bar via set_decorated().

Returns
true if the window has been set to have decorations.

◆ get_default_icon_list()

static Glib::ListHandle< Glib::RefPtr<Gdk::Pixbuf> > Gtk::Window::get_default_icon_list ( )
static

Gets the value set by Gtk::Window::set_default_icon_list().

Returns
Copy of default icon list.

◆ get_default_size()

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.

Parameters
widthLocation to store the default width.
heightLocation to store the default height.

◆ get_deletable()

bool Gtk::Window::get_deletable ( ) const

Returns whether the window has been set to have a close button via set_deletable().

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

◆ get_destroy_with_parent()

bool Gtk::Window::get_destroy_with_parent ( ) const

Returns whether the window will be destroyed with its transient parent. See set_destroy_with_parent().

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

◆ get_focus() [1/2]

Widget* Gtk::Window::get_focus ( )

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

Returns
The currently focused widget, or 0 if there is none.

◆ get_focus() [2/2]

const Widget* Gtk::Window::get_focus ( ) const

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

Returns
The currently focused widget, or 0 if there is none.

◆ get_focus_on_map()

bool Gtk::Window::get_focus_on_map ( ) const

Gets the value set by set_focus_on_map().

Returns
true if window should receive the input focus when mapped.

◆ get_frame() [1/2]

Glib::RefPtr<Gdk::Window> Gtk::Window::get_frame ( )

◆ get_frame() [2/2]

Glib::RefPtr<const Gdk::Window> Gtk::Window::get_frame ( ) const

◆ get_frame_dimensions()

void Gtk::Window::get_frame_dimensions ( int &  left,
int &  top,
int &  right,
int &  bottom 
) const

(Note: this is a special-purpose function intended for the framebuffer port; see set_has_frame(). It will not return the size of the window border drawn by the window manager, which is the normal case when using a windowing system. See gdk_window_get_frame_extents() to get the standard window border extents.)

Retrieves the dimensions of the frame window for this toplevel. See set_has_frame(), set_frame_dimensions().

Deprecated: 2.24: This function will be removed in GTK+ 3

Parameters
leftLocation to store the width of the frame at the left.
topLocation to store the height of the frame at the top.
rightLocation to store the width of the frame at the returns.
bottomLocation to store the height of the frame at the bottom.

◆ get_gravity()

Gdk::Gravity Gtk::Window::get_gravity ( ) const

Gets the value set by set_gravity().

Returns
Window gravity.

◆ get_group() [1/2]

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

Returns the group for window or the default group, if window is 0 or if window does not have an explicit window group.

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

◆ get_group() [2/2]

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

Returns the group for window or the default group, if window is 0 or if window does not have an explicit window group.

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

◆ get_has_frame()

bool Gtk::Window::get_has_frame ( ) const

Accessor for whether the window has a frame window exterior to window->window. Gets the value set by set_has_frame().

Deprecated: 2.24: This function will be removed in GTK+ 3

Returns
true if a frame has been added to the window via set_has_frame().

◆ get_icon() [1/2]

Glib::RefPtr<Gdk::Pixbuf> Gtk::Window::get_icon ( )

Gets the value set by set_icon() (or if you've called set_icon_list(), gets the first icon in the icon list).

Returns
Icon for window.

◆ get_icon() [2/2]

Glib::RefPtr<const Gdk::Pixbuf> Gtk::Window::get_icon ( ) const

Gets the value set by set_icon() (or if you've called set_icon_list(), gets the first icon in the icon list).

Returns
Icon for window.

◆ get_icon_list() [1/2]

Glib::ListHandle< Glib::RefPtr<Gdk::Pixbuf> > Gtk::Window::get_icon_list ( )

Retrieves the list of icons set by set_icon_list(). The list is copied, but the reference count on each member won't be incremented.

Returns
Copy of window's icon list.

◆ get_icon_list() [2/2]

Glib::ListHandle< Glib::RefPtr<const Gdk::Pixbuf> > Gtk::Window::get_icon_list ( ) const

Retrieves the list of icons set by set_icon_list(). The list is copied, but the reference count on each member won't be incremented.

Returns
Copy of window's icon list.

◆ get_icon_name()

Glib::ustring Gtk::Window::get_icon_name ( ) const

Returns the name of the themed icon for the window, see set_icon_name().

Returns
The icon name or 0 if the window has no themed icon.

◆ get_mnemonic_modifier()

Gdk::ModifierType Gtk::Window::get_mnemonic_modifier ( )

Returns the mnemonic modifier for this window. See set_mnemonic_modifier().

Returns
The modifier mask used to activate mnemonics on this window.

◆ get_mnemonics_visible()

bool Gtk::Window::get_mnemonics_visible ( ) const

◆ get_modal()

bool Gtk::Window::get_modal ( ) const

Returns whether the window is modal. See set_modal().

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

◆ get_opacity()

double Gtk::Window::get_opacity ( ) const

Fetches the requested opacity for this window. See set_opacity().

Returns
The requested opacity for this window.

◆ get_position()

void Gtk::Window::get_position ( int &  root_x,
int &  root_y 
) const

This function returns the position you need to pass to move() to keep window in its current position. This means that the meaning of the returned value varies with window gravity. See move() for more details.

If you haven't changed the window gravity, its gravity will be Gdk::GRAVITY_NORTH_WEST. This means that get_position() gets the position of the top-left corner of the window manager frame for the window. move() sets the position of this same top-left corner.

get_position() is not 100% reliable because the X Window System does not specify a way to obtain the geometry of the decorations placed on a window by the window manager. Thus GTK+ is using a "best guess" that works with most window managers.

Moreover, nearly all window managers are historically broken with respect to their handling of window gravity. So moving a window to its current position as returned by get_position() tends to result in moving the window slightly. Window managers are slowly getting better over time.

If a window has gravity Gdk::GRAVITY_STATIC the window manager frame is not relevant, and thus get_position() will always produce accurate results. However you can't use static gravity to do things like place a window in a corner of the screen, because static gravity ignores the window manager decorations.

If you are saving and restoring your application's window positions, you should know that it's impossible for applications to do this without getting it somewhat wrong because applications do not have sufficient knowledge of window manager state. The Correct Mechanism is to support the session management protocol (see the "GnomeClient" object in the GNOME libraries for example) and allow the window manager to save your window sizes and positions.

Parameters
root_xReturn location for X coordinate of gravity-determined reference point.
root_yReturn location for Y coordinate of gravity-determined reference point.

◆ get_resizable()

bool Gtk::Window::get_resizable ( ) const

Gets the value set by set_resizable().

Returns
true if the user can resize the window.

◆ get_role()

Glib::ustring Gtk::Window::get_role ( ) const

Returns the role of the window. See set_role() for further explanation.

Returns
The role of the window if set, or 0. The returned is owned by the widget and must not be modified or freed.

◆ get_screen() [1/2]

Glib::RefPtr<Gdk::Screen> Gtk::Window::get_screen ( )

Returns the Gdk::Screen associated with window.

Returns
A Gdk::Screen.

◆ get_screen() [2/2]

Glib::RefPtr<const Gdk::Screen> Gtk::Window::get_screen ( ) const

Returns the Gdk::Screen associated with window.

Returns
A Gdk::Screen.

◆ get_size()

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

Obtains the current size of window. If window is not onscreen, it returns the size GTK+ will suggest to the window manager for the initial window size (but this is not reliably the same as the size the window manager will actually select). The size obtained by get_size() is the last size received in a Gdk::EventConfigure, that is, GTK+ uses its locally-stored size, rather than querying the X server for the size. As a result, if you call resize() then immediately call get_size(), the size won't have taken effect yet. After the window manager processes the resize request, GTK+ receives notification that the size has changed via a configure event, and the size of the window gets updated.

Note
Nearly any use of this function creates a race condition, because the size of the window may change between the time that you get the size and the time that you perform some action assuming that size is the current size. To avoid race conditions, connect to "configure-event" on the window and adjust your size-dependent state to match the size delivered in the Gdk::EventConfigure.
The returned size does not include the size of the window manager decorations (aka the window frame or border). Those are not drawn by GTK+ and GTK+ has no reliable method of determining their size.
If you are getting a window size in order to position the window onscreen, there may be a better way. The preferred way is to 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 things rather than doing it yourself, because all apps will behave consistently and according to user prefs if the window manager handles it. Also, the window manager can take the size of the window decorations/border into account, while your application cannot.

In any case, if you insist on application-specified window positioning, there's still a better way than doing it yourself - set_position() will frequently handle the details for you.

Parameters
widthReturn location for width.
heightReturn location for height.

◆ get_skip_pager_hint()

bool Gtk::Window::get_skip_pager_hint ( ) const

Gets the value set by set_skip_pager_hint().

Returns
true if window shouldn't be in pager.

◆ get_skip_taskbar_hint()

bool Gtk::Window::get_skip_taskbar_hint ( ) const

Gets the value set by set_skip_taskbar_hint()

Returns
true if window shouldn't be in taskbar.

◆ get_title()

Glib::ustring Gtk::Window::get_title ( ) const

Retrieves the title of the window. See set_title().

Returns
The title of the window, or 0 if none has been set explicitely. The returned string is owned by the widget and must not be modified or freed.

◆ get_transient_for() [1/2]

Window* Gtk::Window::get_transient_for ( )

Fetches the transient parent for this window. See set_transient_for().

Returns
The transient parent for this window, or 0 if no transient parent has been set.

◆ get_transient_for() [2/2]

const Window* Gtk::Window::get_transient_for ( ) const

Fetches the transient parent for this window. See set_transient_for().

Returns
The transient parent for this window, or 0 if no transient parent has been set.

◆ get_type_hint()

Gdk::WindowTypeHint Gtk::Window::get_type_hint ( ) const

Gets the type hint for this window. See set_type_hint().

Returns
The type hint for window.

◆ get_urgency_hint()

bool Gtk::Window::get_urgency_hint ( ) const

Gets the value set by set_urgency_hint()

Returns
true if window is urgent.

◆ get_window_type()

WindowType Gtk::Window::get_window_type ( ) const

Gets the type of the window. See Gtk::WindowType.

Returns
The type of the window.

◆ gobj() [1/2]

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

Provides access to the underlying C GtkObject.

Definition at line 195 of file ytkmm/ytkmm/gtkmm/window.h.

◆ gobj() [2/2]

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

Provides access to the underlying C GtkObject.

Definition at line 198 of file ytkmm/ytkmm/gtkmm/window.h.

◆ iconify()

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) 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 "window-state-event" signal on Gtk::Widget.

◆ is_popup()

bool Gtk::Window::is_popup ( ) const

◆ is_toplevel()

bool Gtk::Window::is_toplevel ( ) const

◆ list_toplevels()

static Glib::ListHandle<Window*> Gtk::Window::list_toplevels ( )
static

Returns a list of all existing toplevel windows. The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call g_list_foreach (result, (GFunc)g_object_ref, 0) first, and then unref all the widgets afterwards.

Returns
List of toplevel widgets.

◆ maximize()

void Gtk::Window::maximize ( )

Asks to maximize window, so that it 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) 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 maximization via the "window-state-event" signal on Gtk::Widget.

◆ mnemonic_activate()

bool Gtk::Window::mnemonic_activate ( guint  keyval,
Gdk::ModifierType  modifier 
)

Activates the targets associated with the mnemonic.

Parameters
keyvalThe mnemonic.
modifierThe modifiers.
Returns
true if the activation is done.

◆ move()

void Gtk::Window::move ( int  x,
int  y 
)

Asks the window manager to move window to the given position. Window managers are free to ignore this; most window managers ignore requests for initial window positions (instead using a user-defined placement algorithm) and honor requests after the window has already been shown.

Note
the position is the position of the gravity-determined reference point for the window. The gravity determines two things: first, the location of the reference point in root window coordinates; and second, which point on the window is positioned at the reference point.

By default the gravity is Gdk::GRAVITY_NORTH_WEST, so the reference point is simply the x, y supplied to move(). The top-left corner of the window decorations (aka window frame or border) will be placed at x, y. Therefore, to position a window at the top left of the screen, you want to use the default gravity (which is Gdk::GRAVITY_NORTH_WEST) and move the window to 0,0.

To position a window at the bottom right corner of the screen, you would set Gdk::GRAVITY_SOUTH_EAST, which means that the reference point is at x + the window width and y + the window height, and the bottom-right corner of the window border will be placed at that reference point. So, to place a window in the bottom right corner you would first set gravity to south east, then write: gtk_window_move (window, gdk_screen_width() - window_width, gdk_screen_height() - window_height) (note that this example does not take multi-head scenarios into account).

The Extended Window Manager Hints specification at http://www.freedesktop.org/Standards/wm-spec has a nice table of gravities in the "implementation notes" section.

The get_position() documentation may also be relevant.

Parameters
xX coordinate to move window to.
yY coordinate to move window to.

◆ on_frame_event()

virtual bool Gtk::Window::on_frame_event ( GdkEvent event)
protectedvirtual

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

◆ on_set_focus()

virtual void Gtk::Window::on_set_focus ( Widget focus)
protectedvirtual

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

◆ parse_geometry()

bool Gtk::Window::parse_geometry ( const Glib::ustring &  geometry)

Parses a standard X Window System geometry string - see the manual page for X (type 'man X') for details on this. parse_geometry() does work on all GTK+ ports including Win32 but is primarily intended for an X environment.

If either a size or a position can be extracted from the geometry string, parse_geometry() returns true and calls set_default_size() and/or move() to resize/move the window.

If parse_geometry() returns true, it will also set the Gdk::HINT_USER_POS and/or Gdk::HINT_USER_SIZE hints indicating to the window manager that the size/position of the window was user-specified. This causes most window managers to honor the geometry.

Note that for parse_geometry() to work as expected, it has to be called when the window has its "final" size, i.e. after calling Gtk::Widget::show_all() on the contents and set_geometry_hints() on the window.

[C example ellipted]

Parameters
geometryGeometry string.
Returns
true if string was parsed successfully.

◆ present() [1/2]

void Gtk::Window::present ( )

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.

If you are calling this function in response to a user interaction, it is preferable to use present_with_time().

◆ present() [2/2]

void Gtk::Window::present ( guint32  timestamp)

Presents a window to the user in response to a user interaction. If you need to present a window without a timestamp, use present(). See present() for details.

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

◆ property_accept_focus() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_accept_focus ( )

TRUE if the window should receive the input focus.

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

◆ property_accept_focus() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_accept_focus ( ) const

TRUE if the window should receive the input focus.

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

◆ property_allow_grow() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_allow_grow ( )

If TRUE, users can expand the window beyond its minimum size.

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

◆ property_allow_grow() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_allow_grow ( ) const

If TRUE, users can expand the window beyond its minimum size.

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

◆ property_allow_shrink() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_allow_shrink ( )

If TRUE, the window has no mimimum size. Setting this to TRUE is 99% of the time a bad idea.

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

◆ property_allow_shrink() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_allow_shrink ( ) const

If TRUE, the window has no mimimum size. Setting this to TRUE is 99% of the time a bad idea.

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

◆ property_decorated() [1/2]

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

Whether the window should be decorated by the window manager.

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

◆ property_decorated() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_decorated ( ) const

Whether the window should be decorated by the window manager.

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

◆ property_default_height() [1/2]

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

The default height of the window, used when initially showing the window.

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

◆ property_default_height() [2/2]

Glib::PropertyProxy_ReadOnly< int > Gtk::Window::property_default_height ( ) const

The default height of the window, used when initially showing the window.

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

◆ property_default_width() [1/2]

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

The default width of the window, used when initially showing the window.

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

◆ property_default_width() [2/2]

Glib::PropertyProxy_ReadOnly< int > Gtk::Window::property_default_width ( ) const

The default width of the window, used when initially showing the window.

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

◆ property_deletable() [1/2]

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

Whether the window frame should have a close button.

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

◆ property_deletable() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_deletable ( ) const

Whether the window frame should have a close button.

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

◆ property_destroy_with_parent() [1/2]

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

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

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

◆ property_destroy_with_parent() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_destroy_with_parent ( ) const

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

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

◆ property_focus_on_map() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_focus_on_map ( )

TRUE if the window should receive the input focus when mapped.

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

◆ property_focus_on_map() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_focus_on_map ( ) const

TRUE if the window should receive the input focus when mapped.

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

◆ property_gravity() [1/2]

Glib::PropertyProxy< Gdk::Gravity > Gtk::Window::property_gravity ( )

The window gravity of the window.

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

◆ property_gravity() [2/2]

Glib::PropertyProxy_ReadOnly< Gdk::Gravity > Gtk::Window::property_gravity ( ) const

The window gravity of the window.

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

◆ property_has_toplevel_focus()

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_has_toplevel_focus ( ) const

Whether the input focus is within this GtkWindow.

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

◆ property_icon() [1/2]

Glib::PropertyProxy< Glib::RefPtr<Gdk::Pixbuf> > Gtk::Window::property_icon ( )

Icon for this window.

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

◆ property_icon() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Pixbuf> > Gtk::Window::property_icon ( ) const

Icon for this window.

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

◆ property_icon_name() [1/2]

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

Name of the themed icon for this window.

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

◆ property_icon_name() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Window::property_icon_name ( ) const

Name of the themed icon for this window.

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

◆ property_is_active()

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_is_active ( ) const

Whether the toplevel is the current active window.

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

◆ property_mnemonics_visible() [1/2]

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

Whether mnemonics are currently visible in this window.

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

◆ property_mnemonics_visible() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_mnemonics_visible ( ) const

Whether mnemonics are currently visible in this window.

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

◆ property_modal() [1/2]

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

If TRUE, the window is modal (other windows are not usable while this one is up).

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

◆ property_modal() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_modal ( ) const

If TRUE, the window is modal (other windows are not usable while this one is up).

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

◆ property_opacity() [1/2]

Glib::PropertyProxy< double > Gtk::Window::property_opacity ( )

The opacity of the window, from 0 to 1.

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

◆ property_opacity() [2/2]

Glib::PropertyProxy_ReadOnly< double > Gtk::Window::property_opacity ( ) const

The opacity of the window, from 0 to 1.

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

◆ property_resizable() [1/2]

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

If TRUE, users can resize the window.

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

◆ property_resizable() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_resizable ( ) const

If TRUE, users can resize the window.

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

◆ property_role() [1/2]

Glib::PropertyProxy< Glib::ustring > Gtk::Window::property_role ( )

Unique identifier for the window to be used when restoring a session.

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

◆ property_role() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Window::property_role ( ) const

Unique identifier for the window to be used when restoring a session.

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

◆ property_screen() [1/2]

Glib::PropertyProxy< Glib::RefPtr<Gdk::Screen> > Gtk::Window::property_screen ( )

The screen where this window will be displayed.

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

◆ property_screen() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gdk::Screen> > Gtk::Window::property_screen ( ) const

The screen where this window will be displayed.

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

◆ property_skip_pager_hint() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_skip_pager_hint ( )

TRUE if the window should not be in the pager.

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

◆ property_skip_pager_hint() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_skip_pager_hint ( ) const

TRUE if the window should not be in the pager.

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

◆ property_skip_taskbar_hint() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_skip_taskbar_hint ( )

TRUE if the window should not be in the task bar.

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

◆ property_skip_taskbar_hint() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_skip_taskbar_hint ( ) const

TRUE if the window should not be in the task bar.

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

◆ property_startup_id()

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

Unique startup identifier for the window used by startup-notification.

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

◆ property_title() [1/2]

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

The title of the window.

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

◆ property_title() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::Window::property_title ( ) const

The title of the window.

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

◆ property_transient_for() [1/2]

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

The transient parent of the dialog.

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

◆ property_transient_for() [2/2]

Glib::PropertyProxy_ReadOnly< Window* > Gtk::Window::property_transient_for ( ) const

The transient parent of the dialog.

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

◆ property_type()

Glib::PropertyProxy_ReadOnly< WindowType > Gtk::Window::property_type ( ) const

The type of the window.

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

◆ property_type_hint() [1/2]

Glib::PropertyProxy< GdkWindowTypeHint > Gtk::Window::property_type_hint ( )

Hint to help the desktop environment understand what kind of window this is and how to treat it.

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

◆ property_type_hint() [2/2]

Glib::PropertyProxy_ReadOnly< GdkWindowTypeHint > Gtk::Window::property_type_hint ( ) const

Hint to help the desktop environment understand what kind of window this is and how to treat it.

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

◆ property_urgency_hint() [1/2]

Glib::PropertyProxy< bool > Gtk::Window::property_urgency_hint ( )

TRUE if the window should be brought to the user's attention.

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

◆ property_urgency_hint() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::Window::property_urgency_hint ( ) const

TRUE if the window should be brought to the user's attention.

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

◆ property_window_position() [1/2]

Glib::PropertyProxy< WindowPosition > Gtk::Window::property_window_position ( )

The initial position of the window.

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

◆ property_window_position() [2/2]

Glib::PropertyProxy_ReadOnly< WindowPosition > Gtk::Window::property_window_position ( ) const

The initial position of the window.

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

◆ raise()

virtual void Gtk::Window::raise ( )
virtual

Brings the window to the front. This is just a more obvious convenience wrapper for get_window()->raise().

◆ remove_accel_group()

void Gtk::Window::remove_accel_group ( const Glib::RefPtr< AccelGroup > &  accel_group)

Reverses the effects of add_accel_group().

Parameters
accel_groupA Gtk::AccelGroup.

◆ remove_mnemonic()

void Gtk::Window::remove_mnemonic ( guint  keyval,
Widget target 
)

Removes a mnemonic from this window.

Parameters
keyvalThe mnemonic.
targetThe widget that gets activated by the mnemonic.

◆ reshow_with_initial_size()

void Gtk::Window::reshow_with_initial_size ( )

Hides window, then reshows it, resetting the default size and position of the window. Used by GUI builders only.

◆ resize()

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.

Parameters
widthWidth in pixels to resize the window to.
heightHeight in pixels to resize the window to.

◆ set_accept_focus()

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.

Parameters
settingtrue to let this window receive input focus.

◆ set_auto_startup_notification()

static void Gtk::Window::set_auto_startup_notification ( bool  setting = true)
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.

Parameters
settingtrue to automatically do startup notification.

◆ set_decorated()

void Gtk::Window::set_decorated ( bool  setting = true)

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

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

Parameters
settingtrue to decorate the window.

◆ set_default()

void Gtk::Window::set_default ( 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 the default widget for a Gtk::Window. When setting (rather than unsetting) the default widget it's generally easier to call Gtk::Widget::grab_focus() on the widget. Before making a widget the default widget, you must set the Gtk::CAN_DEFAULT flag on the widget you'd like to make the default using GTK_WIDGET_SET_FLAGS().

Parameters
default_widgetWidget to be the default.

◆ set_default_icon()

static void Gtk::Window::set_default_icon ( const Glib::RefPtr< Gdk::Pixbuf > &  icon)
static

Sets an icon to be used as fallback for windows that haven't had set_icon() called on them from a pixbuf.

Parameters
iconThe icon.

◆ set_default_icon_from_file()

static bool Gtk::Window::set_default_icon_from_file ( const std::string &  filename)
static

Sets an icon to be used as fallback for windows that haven't had set_icon_list() called on them from a file on disk. Warns on failure if err is 0.

Parameters
filenameLocation of icon file.
Returns
true if setting the icon succeeded.

◆ set_default_icon_list()

static void Gtk::Window::set_default_icon_list ( const Glib::ListHandle< Glib::RefPtr< Gdk::Pixbuf > > &  list)
static

Sets an icon list to be used as fallback for windows that haven't had set_icon_list() called on them to set up a window-specific icon list. This function allows you to set up the icon for all windows in your app at once.

See set_icon_list() for more details.

Parameters
listA list of Gdk::Pixbuf.

◆ set_default_icon_name()

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

Sets an icon to be used as fallback for windows that haven't had set_icon_list() called on them from a named themed icon, see set_icon_name().

Parameters
nameThe name of the themed icon.

◆ set_default_size()

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

Sets the default size of a window. If the window's "natural" size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the window (set_geometry_hints() can be used to set these explicitly), the default size will be clamped to the nearest permitted size.

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

For more control over a window's initial size and how resizing works, investigate set_geometry_hints().

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.

Parameters
widthWidth in pixels, or -1 to unset the default width.
heightHeight in pixels, or -1 to unset the default height.

◆ set_deletable()

void Gtk::Window::set_deletable ( bool  setting = true)

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

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

Parameters
settingtrue to decorate the window as deletable.

◆ set_focus()

void Gtk::Window::set_focus ( Gtk::Widget focus)

If focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. To set the focus to a particular widget in the toplevel, it is usually more convenient to use Gtk::Widget::grab_focus() instead of this function.

Parameters
focusWidget to be the new focus widget.

◆ set_focus_on_map()

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.

Parameters
settingtrue to let this window receive input focus on map.

◆ set_frame_dimensions()

void Gtk::Window::set_frame_dimensions ( int  left,
int  top,
int  right,
int  bottom 
)

(Note: this is a special-purpose function intended for the framebuffer port; see set_has_frame(). It will have no effect on the window border drawn by the window manager, which is the normal case when using the X Window system.)

For windows with frames (see set_has_frame()) this function can be used to change the size of the frame border.

Deprecated: 2.24: This function will be removed in GTK+ 3

Parameters
leftThe width of the left border.
topThe height of the top border.
rightThe width of the right border.
bottomThe height of the bottom border.

◆ set_geometry_hints()

void Gtk::Window::set_geometry_hints ( Widget geometry_widget,
const Gdk::Geometry geometry,
Gdk::WindowHints  geom_mask 
)

This function sets up hints about how a window can be resized by the user. You can set a minimum and maximum size; allowed resize increments (e.g. for xterm, you can only resize by the size of a character); aspect ratios; and more. See the Gdk::Geometry struct.

Parameters
geometry_widgetWidget the geometry hints will be applied to.
geometryStruct containing geometry information.
geom_maskMask indicating which struct fields should be paid attention to.

◆ set_gravity()

void Gtk::Window::set_gravity ( Gdk::Gravity  gravity)

Window gravity defines the meaning of coordinates passed to move(). See move() and Gdk::Gravity for more details.

The default window gravity is Gdk::GRAVITY_NORTH_WEST which will typically "do what you mean."

Parameters
gravityWindow gravity.

◆ set_has_frame()

void Gtk::Window::set_has_frame ( bool  setting = true)

(Note: this is a special-purpose function for the framebuffer port, that causes GTK+ to draw its own window border. For most applications, you want set_decorated() instead, which tells the window manager whether to draw the window border.)

If this function is called on a window with setting of true, before it is realized or showed, it will have a "frame" window around window->window, accessible in window->frame. Using the signal frame_event you can receive all events targeted at the frame.

This function is used by the linux-fb port to implement managed windows, but it could conceivably be used by X-programs that want to do their own window decorations.

Deprecated: 2.24: This function will be removed in GTK+ 3

Parameters
settingA boolean.

◆ set_icon()

void Gtk::Window::set_icon ( const Glib::RefPtr< Gdk::Pixbuf > &  icon)

Sets up the icon representing a Gtk::Window. This icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts.

The icon should be provided in whatever size it was naturally drawn; that is, don't scale the image before passing it to GTK+. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality.

If you have your icon hand-drawn in multiple sizes, use set_icon_list(). Then the best size will be used.

This function is equivalent to calling set_icon_list() with a 1-element list.

See also set_default_icon_list() to set the icon for all windows in your application in one go.

Parameters
iconIcon image, or 0.

◆ set_icon_from_file()

bool Gtk::Window::set_icon_from_file ( const std::string &  filename)

Sets the icon for the window.

This function is equivalent to calling set_icon() with a pixbuf created by loading the image from filename.

Parameters
filenameLocation of icon file.
Returns
true if setting the icon succeeded.

◆ set_icon_list()

void Gtk::Window::set_icon_list ( const Glib::ListHandle< Glib::RefPtr< Gdk::Pixbuf > > &  list)

Sets up the icon representing a Gtk::Window. The icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts.

set_icon_list() allows you to pass in the same icon in several hand-drawn sizes. The list should contain the natural sizes your icon is available in; that is, don't scale the image before passing it to GTK+. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality.

By passing several sizes, you may improve the final image quality of the icon, by reducing or eliminating automatic image scaling.

Recommended sizes to provide: 16x16, 32x32, 48x48 at minimum, and larger images (64x64, 128x128) if you have them.

See also set_default_icon_list() to set the icon for all windows in your application in one go.

Note that transient windows (those who have been set transient for another window using set_transient_for()) will inherit their icon from their transient parent. So there's no need to explicitly set the icon on transient windows.

Parameters
listList of Gdk::Pixbuf.

◆ set_icon_name()

void Gtk::Window::set_icon_name ( const Glib::ustring &  name)

Sets the icon for the window from a named themed icon. See the docs for Gtk::IconTheme for more details.

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

Parameters
nameThe name of the themed icon.

◆ set_keep_above()

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) 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 the above state via the "window-state-event" signal on Gtk::Widget.

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.

Parameters
settingWhether to keep window above other windows.

◆ set_keep_below()

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) 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 the below state via the "window-state-event" signal on Gtk::Widget.

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.

Parameters
settingWhether to keep window below other windows.

◆ set_manage()

virtual void Gtk::Window::set_manage ( )
virtual

Overriden to warn that it doesn't make sense to use Gtk::manage() on this class because it has no parent container.

◆ set_mnemonic_modifier()

void Gtk::Window::set_mnemonic_modifier ( Gdk::ModifierType  modifier)

Sets the mnemonic modifier for this window.

Parameters
modifierThe modifier mask used to activate mnemonics on this window.

◆ set_mnemonics_visible()

void Gtk::Window::set_mnemonics_visible ( bool  setting = true)

Sets the Gtk::Window::property_mnemonics_visible() property.

Parameters
settingThe new value.

◆ set_modal()

void Gtk::Window::set_modal ( bool  modal = true)

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

Parameters
modalWhether the window is modal.

◆ set_opacity()

void Gtk::Window::set_opacity ( double  opacity)

Request the windowing system to make window partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Values of the opacity parameter are clamped to the [0,1] range.) On X11 this has any effect only on X screens with a compositing manager running. See Gtk::Widget::is_composited(). On Windows it should work always.

Note that setting a window's opacity after the window has been shown causes it to flicker once on Windows.

Parameters
opacityDesired opacity, between 0 and 1.

◆ set_position()

void Gtk::Window::set_position ( WindowPosition  position)

Sets a position constraint for this window. If the old or new constraint is Gtk::WIN_POS_CENTER_ALWAYS, this will also cause the window to be repositioned to satisfy the new constraint.

Parameters
positionA position constraint.

◆ set_resizable()

void Gtk::Window::set_resizable ( bool  resizable = true)

Sets whether the user can resize a window. Windows are user resizable by default.

Parameters
resizabletrue if the user can resize this window.

◆ set_role()

void Gtk::Window::set_role ( const Glib::ustring &  role)

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

In combination with the window title, the window role allows a window manager to identify "the same" window when an application is restarted. So for example you might set the "toolbox" role on your app's toolbox window, so that when the user restarts their session, the window manager can put the toolbox back in the same place.

If a window already has a unique title, you don't need to set the role, since the WM can use the title to identify the window when restoring the session.

Parameters
roleUnique identifier for the window to be used when restoring a session.

◆ set_screen()

void Gtk::Window::set_screen ( const Glib::RefPtr< Gdk::Screen > &  screen)

Sets the Gdk::Screen where the window is displayed; if the window is already mapped, it will be unmapped, and then remapped on the new screen.

Parameters
screenA Gdk::Screen.

◆ set_skip_pager_hint()

void Gtk::Window::set_skip_pager_hint ( bool  setting = true)

Windows may set a hint asking the desktop environment not to display the window in the pager. This function sets this hint. (A "pager" is any desktop navigation tool such as a workspace switcher that displays a thumbnail representation of the windows on the screen.)

Parameters
settingtrue to keep this window from appearing in the pager.

◆ set_skip_taskbar_hint()

void Gtk::Window::set_skip_taskbar_hint ( bool  setting = true)

Windows may set a hint asking the desktop environment not to display the window in the task bar. This function sets this hint.

Parameters
settingtrue to keep this window from appearing in the task bar.

◆ set_title()

void Gtk::Window::set_title ( const Glib::ustring &  title)

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

Parameters
titleTitle of the window.

◆ set_transient_for()

void Gtk::Window::set_transient_for ( Window parent)

Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. Gtk::Dialog::new_with_buttons() and other convenience functions in GTK+ will sometimes call set_transient_for() on your behalf.

Passing 0 for parent unsets the current transient window.

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

Parameters
parentParent window, or 0.

◆ set_type_hint()

void Gtk::Window::set_type_hint ( Gdk::WindowTypeHint  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.

Parameters
hintThe window type.

◆ set_urgency_hint()

void Gtk::Window::set_urgency_hint ( bool  setting = true)

Windows may set a hint asking the desktop environment to draw the users attention to the window. This function sets this hint.

Parameters
settingtrue to mark this window as urgent.

◆ set_wmclass()

void Gtk::Window::set_wmclass ( const Glib::ustring &  wmclass_name,
const Glib::ustring &  wmclass_class 
)

Don't use this function. It sets the X Window System "class" and "name" hints for a window. According to the ICCCM, you should always set these to the same value for all windows in an application, and GTK+ sets them to that value by default, so calling this function is sort of pointless. However, you may want to call set_role() on each window in your application, for the benefit of the session manager. Setting the role allows the window manager to restore window positions when loading a saved session.

Parameters
wmclass_nameWindow name hint.
wmclass_classWindow class hint.

◆ signal_frame_event()

Glib::SignalProxy1< bool,GdkEvent* > Gtk::Window::signal_frame_event ( )
Slot Prototype:
bool on_my_frame_event(GdkEvent* event)

◆ signal_set_focus()

Glib::SignalProxy1< void,Widget* > Gtk::Window::signal_set_focus ( )
Slot Prototype:
void on_my_set_focus(Widget* focus)

◆ stick()

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) 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 stickiness via the "window-state-event" signal on Gtk::Widget.

◆ unfullscreen()

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) 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 the fullscreen state via the "window-state-event" signal on Gtk::Widget.

◆ unmaximize()

void Gtk::Window::unmaximize ( )

Asks to unmaximize window. Note that you shouldn't assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager) 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 maximization via the "window-state-event" signal on Gtk::Widget.

◆ unset_default()

void Gtk::Window::unset_default ( )

◆ unset_focus()

void Gtk::Window::unset_focus ( )

◆ unset_transient_for()

void Gtk::Window::unset_transient_for ( )

Unsets the current transient window.

See also
set_transient_for().

◆ unstick()

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) could stick it again. But normally the window will end up stuck. Just don't write code that crashes if not.

You can track stickiness via the "window-state-event" signal on Gtk::Widget.

Friends And Related Function Documentation

◆ wrap()

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

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

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.

Member Data Documentation

◆ accel_group_

Glib::RefPtr<AccelGroup> Gtk::Window::accel_group_
private

Definition at line 1921 of file ytkmm/ytkmm/gtkmm/window.h.


The documentation for this class was generated from the following file: