gtkmm: Gtk::Notebook Class Reference

Container which shows one of its children at a time, in tabbed windows. More...

#include <gtkmm/notebook.h>

Inheritance diagram for Gtk::Notebook:

Public Member Functions

Notebook ( Notebook && src) noexcept
Notebook & operator= ( Notebook && src) noexcept
Notebook (const Notebook &)=delete
Notebook & operator= (const Notebook &)=delete
~Notebook () noexceptoverride
GtkNotebook* gobj ()
Provides access to the underlying C GtkObject. More...

const GtkNotebook* gobj () const
Provides access to the underlying C GtkObject. More...

Notebook ()
int prepend_page ( Widget & child, Widget & tab_label)
Prepends a page to notebook . More...

int prepend_page ( Widget & child)
int prepend_page ( Widget & child, const Glib::ustring & tab_label, bool use_mnemonic=false)
int prepend_page ( Widget & child, Widget & tab_label, Widget & menu_label)
Prepends a page to notebook , specifying the widget to use as the label in the popup menu. More...

int prepend_page ( Widget & child, const Glib::ustring & tab_label, const Glib::ustring & menu_label, bool use_mnemonic)
int append_page ( Widget & child, Widget & tab_label)
Appends a page to notebook . More...

int append_page ( Widget & child)
int append_page ( Widget & child, const Glib::ustring & tab_label, bool use_mnemonic=false)
int append_page ( Widget & child, Widget & tab_label, Widget & menu_label)
Appends a page to notebook , specifying the widget to use as the label in the popup menu. More...

int append_page ( Widget & child, const Glib::ustring & tab_label, const Glib::ustring & menu_label, bool use_mnemonic=false)
int insert_page ( Widget & child, Widget & tab_label, int position)
Insert a page into notebook at the given position. More...

int insert_page ( Widget & child, int position)
int insert_page ( Widget & child, const Glib::ustring & tab_label, int position, bool use_mnemonic=false)
int insert_page ( Widget & child, Widget & tab_label, Widget & menu_label, int position)
Insert a page into notebook at the given position, specifying the widget to use as the label in the popup menu. More...

int insert_page ( Widget & child, const Glib::ustring & tab_label, const Glib::ustring & menu_label, int position, bool use_mnemonic=false)
void remove_page (int page_number=0)
Removes a page from the notebook given its index in the notebook. More...

void remove_page ( Widget & child)
void set_group_name (const Glib::ustring & group_name)
Sets a group name for notebook . More...

Glib::ustring get_group_name () const
Gets the current group name for notebook . More...

int get_current_page () const
Returns the page number of the current page. More...

Widget * get_nth_page (int page_number)
Returns the child widget contained in page number page_number . More...

const Widget * get_nth_page (int page_number) const
Returns the child widget contained in page number page_number . More...

int get_n_pages () const
Gets the number of pages in a notebook. More...

int page_num (const Widget & child) const
Finds the index of the page which contains the given child widget. More...

void set_current_page (int page_number)
Switches to the page number page_number . More...

void next_page ()
Switches to the next page. More...

void prev_page ()
Switches to the previous page. More...

void set_show_border (bool show_border=true)
Sets whether a bevel will be drawn around the notebook pages. More...

bool get_show_border () const
Returns whether a bevel will be drawn around the notebook pages. More...

void set_show_tabs (bool show_tabs=true)
Sets whether to show the tabs for the notebook or not. More...

bool get_show_tabs () const
Returns whether the tabs of the notebook are shown. More...

void set_tab_pos ( PositionType pos)
Sets the edge at which the tabs for switching pages in the notebook are drawn. More...

PositionType get_tab_pos () const
Gets the edge at which the tabs for switching pages in the notebook are drawn. More...

void set_scrollable (bool scrollable=true)
Sets whether the tab label area will have arrows for scrolling if there are too many tabs to fit in the area. More...

bool get_scrollable () const
Returns whether the tab label area has arrows for scrolling. More...

guint16 get_tab_hborder () const
Returns the horizontal width of a tab border. More...

guint16 get_tab_vborder () const
Returns the vertical width of a tab border. More...

void popup_enable ()
Enables the popup menu: if the user clicks with the right mouse button on the tab labels, a menu with all the pages will be popped up. More...

void popup_disable ()
Disables the popup menu. More...

Widget * get_tab_label ( Widget & child)
Returns the tab label widget for the page child . More...

const Widget * get_tab_label ( Widget & child) const
Returns the tab label widget for the page child . More...

void set_tab_label ( Widget & child, Widget & tab_label)
Changes the tab label for child . More...

void set_tab_label_text ( Widget & child, const Glib::ustring & tab_text)
Creates a new label and sets it as the tab label for the page containing child . More...

Glib::ustring get_tab_label_text ( Widget & child) const
Retrieves the text of the tab label for the page containing child . More...

Widget * get_menu_label ( Widget & child)
Retrieves the menu label widget of the page containing child . More...

const Widget * get_menu_label ( Widget & child) const
Retrieves the menu label widget of the page containing child . More...

void set_menu_label ( Widget & child, Widget & menu_label)
Changes the menu label for the page containing child . More...

void set_menu_label_text ( Widget & child, const Glib::ustring & menu_text)
Creates a new label and sets it as the menu label of child . More...

Glib::ustring get_menu_label_text ( Widget & child) const
Retrieves the text of the menu label for the page containing child . More...

void reorder_child ( Widget & child, int position)
Reorders the page containing child , so that it appears in position position . More...

bool get_tab_reorderable ( Widget & child) const
Gets whether the tab can be reordered via drag and drop or not. More...

void set_tab_reorderable ( Widget & child, bool reorderable=true)
Sets whether the notebook tab can be reordered via drag and drop or not. More...

bool get_tab_detachable ( Widget & child) const
Returns whether the tab contents can be detached from notebook . More...

void set_tab_detachable ( Widget & child, bool detachable=true)
Sets whether the tab can be detached from notebook to another notebook or widget. More...

void detach_tab ( Widget & child)
Removes the child from the notebook. More...

Widget * get_action_widget ( PackType pack_type= PACK_START )
Gets one of the action widgets. More...

void set_action_widget ( Widget * widget, PackType pack_type= PACK_START )
Sets widget as one of the action widgets. More...

Glib::SignalProxy < void, Widget *, guint > signal_switch_page ()
Glib::SignalProxy < void, Widget *, guint > signal_page_reordered ()
Glib::SignalProxy < void, Widget *, guint > signal_page_removed ()
Glib::SignalProxy < void, Widget *, guint > signal_page_added ()
Glib::PropertyProxy < PositionType > property_tab_pos ()
Which side of the notebook holds the tabs. More...

Glib::PropertyProxy_ReadOnly < PositionType > property_tab_pos () const
Which side of the notebook holds the tabs. More...

Glib::PropertyProxy < bool > property_show_tabs ()
Whether tabs should be shown. More...

Glib::PropertyProxy_ReadOnly < bool > property_show_tabs () const
Whether tabs should be shown. More...

Glib::PropertyProxy < bool > property_show_border ()
Whether the border should be shown. More...

Glib::PropertyProxy_ReadOnly < bool > property_show_border () const
Whether the border should be shown. More...

Glib::PropertyProxy < bool > property_scrollable ()
If TRUE, scroll arrows are added if there are too many tabs to fit. More...

Glib::PropertyProxy_ReadOnly < bool > property_scrollable () const
If TRUE, scroll arrows are added if there are too many tabs to fit. More...

Glib::PropertyProxy < int > property_page ()
The index of the current page. More...

Glib::PropertyProxy_ReadOnly < int > property_page () const
The index of the current page. More...

Glib::PropertyProxy < Glib::ustring > property_group_name ()
Group name for tab drag and drop. More...

Glib::PropertyProxy_ReadOnly < Glib::ustring > property_group_name () const
Group name for tab drag and drop. More...

Glib::PropertyProxy < bool > property_enable_popup ()
If TRUE, pressing the right mouse button on the notebook pops up a menu that you can use to go to a page. More...

Glib::PropertyProxy_ReadOnly < bool > property_enable_popup () const
If TRUE, pressing the right mouse button on the notebook pops up a menu that you can use to go to a page. More...

Gtk::ChildPropertyProxy < Glib::ustring > child_property_tab_label ( Gtk::Widget & child)
The string displayed on the child's tab label. More...

Gtk::ChildPropertyProxy_ReadOnly < Glib::ustring > child_property_tab_label (const Gtk::Widget & child) const
The string displayed on the child's tab label. More...

Gtk::ChildPropertyProxy < Glib::ustring > child_property_menu_label ( Gtk::Widget & child)
The string displayed in the child's menu entry. More...

Gtk::ChildPropertyProxy_ReadOnly < Glib::ustring > child_property_menu_label (const Gtk::Widget & child) const
The string displayed in the child's menu entry. More...

Gtk::ChildPropertyProxy < int > child_property_position ( Gtk::Widget & child)
The index of the child in the parent. More...

Gtk::ChildPropertyProxy_ReadOnly < int > child_property_position (const Gtk::Widget & child) const
The index of the child in the parent. More...

Gtk::ChildPropertyProxy < bool > child_property_tab_expand ( Gtk::Widget & child)
Whether to expand the child's tab. More...

Gtk::ChildPropertyProxy_ReadOnly < bool > child_property_tab_expand (const Gtk::Widget & child) const
Whether to expand the child's tab. More...

Gtk::ChildPropertyProxy < bool > child_property_tab_fill ( Gtk::Widget & child)
Whether the child's tab should fill the allocated area. More...

Gtk::ChildPropertyProxy_ReadOnly < bool > child_property_tab_fill (const Gtk::Widget & child) const
Whether the child's tab should fill the allocated area. More...

Gtk::ChildPropertyProxy < bool > child_property_reorderable ( Gtk::Widget & child)
Whether the tab is reorderable by user action. More...

Gtk::ChildPropertyProxy_ReadOnly < bool > child_property_reorderable (const Gtk::Widget & child) const
Whether the tab is reorderable by user action. More...

Gtk::ChildPropertyProxy < bool > child_property_detachable ( Gtk::Widget & child)
Whether the tab is detachable. More...

Gtk::ChildPropertyProxy_ReadOnly < bool > child_property_detachable (const Gtk::Widget & child) const
Whether the tab is detachable. More...

- Public Member Functions inherited from Gtk::Container
Container ( Container && src) noexcept
Container & operator= ( Container && src) noexcept
Container (const Container &)=delete
Container & operator= (const Container &)=delete
~Container () noexceptoverride
GtkContainer* gobj ()
Provides access to the underlying C GtkObject. More...

const GtkContainer* gobj () const
Provides access to the underlying C GtkObject. More...

void set_border_width (guint border_width)
Sets the border width of the container. More...

guint get_border_width () const
Retrieves the border width of the container. More...

virtual void add ( Widget & widget)
void remove ( Widget & widget)
Removes widget from container . More...

void set_resize_mode ( ResizeMode resize_mode)
Sets the resize mode for the container. More...

ResizeMode get_resize_mode () const
Returns the resize mode for the container. More...

void check_resize ()
Request that contained widgets check their size. More...

void foreach (const ForeachSlot & slot)
Operate on contained items. More...

void forall (const ForeachSlot & slot)
Operate on contained items, including internal children. More...

std::vector < Widget * > get_children ()
Returns the container’s non-internal children. More...

std::vector < const Widget * > get_children () const
Returns the container’s non-internal children. More...

void propagate_draw ( Widget & child, const :: Cairo::RefPtr < :: Cairo::Context >& cr)
When a container receives a call to the draw function, it must send synthetic Gtk::Widget::signal_draw() calls to all children that don’t have their own Gdk::Windows. More...

void set_focus_chain (const std::vector < Widget * >& focusable_widgets)
Sets a focus chain, overriding the one computed automatically by GTK+. More...

bool has_focus_chain () const
std::vector < Widget * > get_focus_chain ()
std::vector < const Widget * > get_focus_chain () const
void unset_focus_chain ()
Removes a focus chain explicitly set with set_focus_chain() . More...

void set_reallocate_redraws (bool needs_redraws=true)
Sets the reallocate_redraws flag of the container to the given value. More...

void set_focus_child ( Widget & widget)
Sets the focus on a child. More...

Widget * get_focus_child ()
Returns the current focus child widget inside container . More...

const Widget * get_focus_child () const
Returns the current focus child widget inside container . More...

void set_focus_vadjustment (const Glib::RefPtr < Adjustment >& adjustment)
Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. More...

Glib::RefPtr < Adjustment > get_focus_vadjustment ()
Retrieves the vertical focus adjustment for the container. More...

Glib::RefPtr < const Adjustment > get_focus_vadjustment () const
Retrieves the vertical focus adjustment for the container. More...

void set_focus_hadjustment (const Glib::RefPtr < Adjustment >& adjustment)
Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. More...

Glib::RefPtr < Adjustment > get_focus_hadjustment ()
Retrieves the horizontal focus adjustment for the container. More...

Glib::RefPtr < const Adjustment > get_focus_hadjustment () const
Retrieves the horizontal focus adjustment for the container. More...

void resize_children ()
GType child_type () const
Returns the type of the children supported by the container. More...

WidgetPath get_path_for_child (const Widget & child) const
Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child . More...

Glib::SignalProxy < void, Widget * > signal_add ()
Glib::SignalProxy < void, Widget * > signal_remove ()
Glib::SignalProxy < void > signal_check_resize ()
Glib::SignalProxy < void, Widget * > signal_set_focus_child ()
void show_all_children (bool recursive=true)
- Public Member Functions inherited from Gtk::Widget
Widget ( Widget && src) noexcept
Widget & operator= ( Widget && src) noexcept
Widget (const Widget &)=delete
Widget & operator= (const Widget &)=delete
~Widget () noexceptoverride
Destroys the widget. More...

GtkWidget* gobj ()
Provides access to the underlying C GtkObject. More...

const GtkWidget* gobj () const
Provides access to the underlying C GtkObject. More...

void show ()
Flags a widget to be displayed. More...

void show_now ()
Shows a widget. More...

void hide ()
Reverses the effects of show() , causing the widget to be hidden (invisible to the user). More...

void show_all ()
Recursively shows a widget, and any child widgets (if the widget is a container). More...

void queue_draw ()
Equivalent to calling queue_draw_area() for the entire area of a widget. More...

void queue_draw_area (int x, int y, int width, int height)
Convenience function that calls queue_draw_region() on the region created from the given coordinates. More...

void queue_draw_region (const :: Cairo::RefPtr < const :: Cairo::Region >& region)
Invalidates the area of widget defined by region by calling gdk_window_invalidate_region() on the widget’s window and all its child windows. More...

void queue_resize ()
This function is only for use in widget implementations. More...

void queue_allocate ()
This function is only for use in widget implementations. More...

void size_allocate (const Allocation & allocation)
This function is only used by Gtk::Container subclasses, to assign a size and position to their child widgets. More...

void size_allocate (const Allocation & allocation, int baseline)
This function is only used by Gtk::Container subclasses, to assign a size, position and (optionally) baseline to their child widgets. More...

SizeRequestMode get_request_mode () const
Gets whether the widget prefers a height-for-width layout or a width-for-height layout. More...

void get_preferred_width (int& minimum_width, int& natural_width) const
Retrieves a widget’s initial minimum and natural width. More...

void get_preferred_height_for_width (int width, int& minimum_height, int& natural_height) const
Retrieves a widget’s minimum and natural height if it would be given the specified width . More...

void get_preferred_height_for_width (int width, int& minimum_height, int& natural_height, int& minimum_baseline, int& natural_baseline) const
Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given the specified width , or the default height if width is -1. More...

void get_preferred_height (int& minimum_height, int& natural_height) const
Retrieves a widget’s initial minimum and natural height. More...

void get_preferred_width_for_height (int height, int& minimum_width, int& natural_width) const
Retrieves a widget’s minimum and natural width if it would be given the specified height . More...

void get_preferred_size ( Requisition & minimum_size, Requisition & natural_size) const
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. More...

void add_accelerator (const Glib::ustring & accel_signal, const Glib::RefPtr < AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods, AccelFlags accel_flags)
Installs an accelerator for this widget in accel_group that causes accel_signal to be emitted if the accelerator is activated. More...

bool remove_accelerator (const Glib::RefPtr < AccelGroup >& accel_group, guint accel_key, Gdk::ModifierType accel_mods)
Removes an accelerator from widget , previously installed with add_accelerator() . More...

void set_accel_path (const Glib::ustring & accel_path, const Glib::RefPtr < AccelGroup >& accel_group)
Given an accelerator group, accel_group , and an accelerator path, accel_path , sets up an accelerator in accel_group so whenever the key binding that is defined for accel_path is pressed, widget will be activated. More...

bool mnemonic_activate (bool group_cycling)
Emits the Gtk::Widget::signal_mnemonic_activate() signal. More...

bool event (GdkEvent* gdk_event)
Rarely-used function. More...

int send_expose (GdkEvent* gdk_event)
Very rarely-used function. More...

bool send_focus_change (GdkEvent* gdk_event)
Sends the focus change gdk_event to widget . More...

bool activate ()
For widgets that can be “activated” (buttons, menu items, etc.) this function activates them. More...

void reparent ( Widget & new_parent)
Moves a widget from one Gtk::Container to another, handling reference count issues to avoid destroying the widget. More...

bool intersect (const Gdk::Rectangle & area) const
bool intersect (const Gdk::Rectangle & area, Gdk::Rectangle & intersection) const
Computes the intersection of a widget’s area and area , storing the intersection in intersection , and returns true if there was an intersection. More...

:: Cairo::RefPtr < :: Cairo::Region > region_intersect (const :: Cairo::RefPtr < :: Cairo::Region >& region) const
Computes the intersection of a widget’s area and region , returning the intersection. More...

void freeze_child_notify ()
Stops emission of Gtk::Widget::signal_child_notify() signals on widget . More...

void child_notify (const Glib::ustring & child_property)
Emits a Gtk::Widget::signal_child_notify() signal for the [child property][child-properties] child_property on widget . More...

void thaw_child_notify ()
Reverts the effect of a previous call to freeze_child_notify() . More...

void set_can_focus (bool can_focus=true)
Specifies whether widget can own the input focus. More...

bool get_can_focus () const
Determines whether widget can own the input focus. More...

bool has_focus () const
Determines if the widget has the global input focus. More...

bool is_focus () const
Determines if the widget is the focus widget within its toplevel. More...

bool has_visible_focus () const
Determines if the widget should show a visible indication that it has the global input focus. More...

void grab_focus ()
Causes widget to have the keyboard focus for the Gtk::Window it's inside. More...

void set_focus_on_click (bool focus_on_click=true)
Sets whether the widget should grab focus when it is clicked with the mouse. More...

bool get_focus_on_click () const
Returns whether the widget should grab focus when it is clicked with the mouse. More...

void set_can_default (bool can_default=true)
Specifies whether widget can be a default widget. More...

bool get_can_default () const
Determines whether widget can be a default widget. More...

bool has_default () const
Determines whether widget is the current default widget within its toplevel. More...

void grab_default ()
Causes widget to become the default widget. More...

void set_receives_default (bool receives_default=true)
Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More...

bool get_receives_default () const
Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. More...

bool has_grab () const
Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse). More...

bool device_is_shadowed (const Glib::RefPtr < const Gdk::Device >& device)
Returns true if device has been shadowed by a GTK+ device grab on another widget, so it would stop sending events to widget . More...

void add_modal_grab ()
Block events to everything else than this widget and its children. More...

void remove_modal_grab ()
Remove the modal grab of the widget in case it was previously grabbed. More...

void set_name (const Glib::ustring & name)
Widgets can be named, which allows you to refer to them from a CSS file. More...

void unset_name ()
Glib::ustring get_name () const
Retrieves the name of a widget. More...

void set_state ( StateType state)
This function is for use in widget implementations. More...

StateType get_state () const
Returns the widget’s state. More...

void set_state_flags ( StateFlags flags, bool clear=true)
This function is for use in widget implementations. More...

void unset_state_flags ( StateFlags flags)
This function is for use in widget implementations. More...

StateFlags get_state_flags () const
Returns the widget state as a flag set. More...

void set_sensitive (bool sensitive=true)
Sets the sensitivity of a widget. More...

bool get_sensitive () const
Returns the widget’s sensitivity (in the sense of returning the value that has been set using set_sensitive() ). More...

bool is_sensitive () const
Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive. More...

void set_visible (bool visible=true)
Sets the visibility state of widget . More...

bool get_visible () const
Determines whether the widget is visible. More...

bool is_visible () const
Determines whether the widget and all its parents are marked as visible. More...

bool get_has_window () const
Determines whether widget has a Gdk::Window of its own. More...

bool get_is_toplevel () const
Determines whether widget is a toplevel widget. More...

bool get_is_drawable () const
Determines whether widget can be drawn to. More...

bool get_realized () const
Determines whether widget is realized. More...

bool get_mapped () const
Whether the widget is mapped. More...

void set_app_paintable (bool app_paintable=true)
Sets whether the application intends to draw on the widget in an Gtk::Widget::signal_draw() handler. More...

bool get_app_paintable () const
Determines whether the application intends to draw on the widget in an Gtk::Widget::signal_draw() handler. More...

void set_double_buffered (bool double_buffered=true)
Widgets are double buffered by default; you can use this function to turn off the buffering. More...

bool get_double_buffered () const
Determines whether the widget is double buffered. More...

void set_redraw_on_allocate (bool redraw_on_allocate=true)
Sets whether the entire widget is queued for drawing when its size allocation changes. More...

void set_child_visible (bool visible=true)
Sets whether widget should be mapped along with its when its parent is mapped and widget has been shown with show() . More...

bool get_child_visible () const
Gets the value set with set_child_visible() . More...

Glib::RefPtr < Gdk::Window > get_window ()
Returns the widget’s window if it is realized, nullptr otherwise. More...

Glib::RefPtr < const Gdk::Window > get_window () const
Returns the widget’s window if it is realized, nullptr otherwise. More...

void register_window (const Glib::RefPtr < Gdk::Window >& window)
Registers a Gdk::Window with the widget and sets it up so that the widget receives events for it. More...

void unregister_window (const Glib::RefPtr < Gdk::Window >& window)
Unregisters a Gdk::Window from the widget that was previously set up with register_window() . More...

int get_allocated_width () const
Returns the width that has currently been allocated to widget . More...

int get_allocated_height () const
Returns the height that has currently been allocated to widget . More...

int get_allocated_baseline () const
Returns the baseline that has currently been allocated to widget . More...

void get_allocated_size ( Allocation & allocation, int& baseline) const
Retrieves the widget’s allocated size. More...

Allocation get_allocation () const
Retrieves the widget's location. More...

void set_allocation (const Allocation & allocation)
Sets the widget’s allocation. More...

void set_clip (const Allocation & clip)
Sets the widget’s clip. More...

Allocation get_clip () const
Retrieves the widget’s clip area. More...

Container * get_parent ()
Returns the parent container of widget . More...

const Container * get_parent () const
Returns the parent container of widget . More...

Glib::RefPtr < Gdk::Window > get_parent_window ()
Gets widget’s parent window. More...

Glib::RefPtr < const Gdk::Window > get_parent_window () const
Gets widget’s parent window. More...

void set_parent_window (const Glib::RefPtr < const Gdk::Window >& parent_window)
Sets a non default parent window for widget . More...

bool child_focus ( DirectionType direction)
This function is used by custom widget implementations; if you're writing an app, you’d use grab_focus() to move the focus to a particular widget, and Gtk::Container::set_focus_chain() to change the focus tab order. More...

bool keynav_failed ( DirectionType direction)
This function should be called whenever keyboard navigation within a single widget hits a boundary. More...

void error_bell ()
Notifies the user about an input-related error on this widget. More...

void set_size_request (int width=-1, int height=-1)
Sets the minimum size of a widget; that is, the widget’s size request will be at least width by height . More...

void get_size_request (int& width, int& height) const
Gets the size request that was explicitly set for the widget using set_size_request() . More...

void set_events ( Gdk::EventMask events)
Sets the event mask (see Gdk::EventMask ) for a widget. More...

void add_events ( Gdk::EventMask events)
Adds the events in the bitfield events to the event mask for widget . More...

void set_device_events (const Glib::RefPtr < const Gdk::Device >& device, Gdk::EventMask events)
Sets the device event mask (see Gdk::EventMask ) for a widget. More...

void add_device_events (const Glib::RefPtr < const Gdk::Device >& device, Gdk::EventMask events)
Adds the device events in the bitfield events to the event mask for widget . More...

void set_opacity (double opacity)
Request the widget to be rendered partially transparent, with opacity 0 being fully transparent and 1 fully opaque. More...

double get_opacity () const
Fetches the requested opacity for this widget. More...

void set_device_enabled (const Glib::RefPtr < Gdk::Device >& device, bool enabled=true)
Enables or disables a Gdk::Device to interact with widget and all its children. More...

bool get_device_enabled (const Glib::RefPtr < const Gdk::Device >& device) const
Returns whether device can interact with widget and its children. More...

Container * get_toplevel ()
This function returns the topmost widget in the container hierarchy widget is a part of. More...

const Container * get_toplevel () const
This function returns the topmost widget in the container hierarchy widget is a part of. More...

Widget * get_ancestor (GType widget_type)
Gets the first ancestor of widget with type widget_type . More...

const Widget * get_ancestor (GType widget_type) const
Gets the first ancestor of widget with type widget_type . More...

Glib::RefPtr < Gdk::Visual > get_visual ()
Gets the visual that will be used to render widget . More...

Glib::RefPtr < Gdk::Screen > get_screen ()
Get the Gdk::Screen from the toplevel window associated with this widget. More...

Glib::RefPtr < const Gdk::Screen > get_screen () const
Get the Gdk::Screen from the toplevel window associated with this widget. More...

bool has_screen () const
Checks whether there is a Gdk::Screen is associated with this widget. More...

int get_scale_factor () const
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. More...

Glib::RefPtr < Gdk::Display > get_display ()
Get the Gdk::Display for the toplevel window associated with this widget. More...

Glib::RefPtr < const Gdk::Display > get_display () const
Get the Gdk::Display for the toplevel window associated with this widget. More...

Glib::RefPtr < Gdk::Window > get_root_window ()
Get the root window where this widget is located. More...

Glib::RefPtr < const Gdk::Window > get_root_window () const
Get the root window where this widget is located. More...

Glib::RefPtr < Settings > get_settings ()
Gets the settings object holding the settings used for this widget. More...

Glib::RefPtr < Clipboard > get_clipboard (const Glib::ustring & selection)
Returns the clipboard object for the given selection to be used with widget . More...

Glib::RefPtr < const Clipboard > get_clipboard (const Glib::ustring & selection) const
Returns the clipboard object for the given selection to be used with widget . More...

bool get_hexpand () const
Gets whether the widget would like any available extra horizontal space. More...

void set_hexpand (bool expand=true)
Sets whether the widget would like any available extra horizontal space. More...

bool get_hexpand_set () const
Gets whether set_hexpand() has been used to explicitly set the expand flag on this widget. More...

void set_hexpand_set (bool set =true)
Sets whether the hexpand flag (see get_hexpand() ) will be used. More...

bool get_vexpand () const
Gets whether the widget would like any available extra vertical space. More...

void set_vexpand (bool expand=true)
Sets whether the widget would like any available extra vertical space. More...

bool get_vexpand_set () const
Gets whether set_vexpand() has been used to explicitly set the expand flag on this widget. More...

void set_vexpand_set (bool set =true)
Sets whether the vexpand flag (see get_vexpand() ) will be used. More...

void queue_compute_expand ()
Mark widget as needing to recompute its expand flags. More...

bool compute_expand ( Orientation orientation)
Computes whether a container should give this widget extra space when possible. More...

bool get_support_multidevice () const
Returns true if widget is multiple pointer aware. More...

void set_support_multidevice (bool support_multidevice=true)
Enables or disables multiple pointer awareness. More...

Glib::RefPtr < Atk::Object > get_accessible ()
Returns the accessible object that describes the widget to an assistive technology. More...

Glib::RefPtr < const Atk::Object > get_accessible () const
Returns the accessible object that describes the widget to an assistive technology. More...

Align get_halign () const
Gets the value of the Gtk::Widget::property_halign() property. More...

void set_halign ( Align align)
Sets the horizontal alignment of widget . More...

Align get_valign () const
Gets the value of the Gtk::Widget::property_valign() property. More...

Align get_valign_with_baseline () const
Gets the value of the Gtk::Widget::property_valign() property, including Gtk::ALIGN_BASELINE . More...

void set_valign ( Align align)
Sets the vertical alignment of widget . More...

int get_margin_left () const
Gets the value of the Gtk::Widget::property_margin_left() property. More...

void set_margin_left (int margin)
Sets the left margin of widget . More...

int get_margin_right () const
Gets the value of the Gtk::Widget::property_margin_right() property. More...

void set_margin_right (int margin)
Sets the right margin of widget . More...

int get_margin_start () const
Gets the value of the Gtk::Widget::property_margin_start() property. More...

void set_margin_start (int margin)
Sets the start margin of widget . More...

int get_margin_end () const
Gets the value of the Gtk::Widget::property_margin_end() property. More...

void set_margin_end (int margin)
Sets the end margin of widget . More...

int get_margin_top () const
Gets the value of the Gtk::Widget::property_margin_top() property. More...

void set_margin_top (int margin)
Sets the top margin of widget . More...

int get_margin_bottom () const
Gets the value of the Gtk::Widget::property_margin_bottom() property. More...

void set_margin_bottom (int margin)
Sets the bottom margin of widget . More...

Gdk::EventMask get_events () const
Returns the event mask (see Gdk::EventMask ) for the widget. More...

Gdk::EventMask get_device_events (const Glib::RefPtr < const Gdk::Device >& device) const
Returns the events mask for the widget corresponding to an specific device. More...

void get_pointer (int& x, int& y) const
Obtains the location of the mouse pointer in widget coordinates. More...

bool is_ancestor ( Widget & ancestor) const
Determines whether widget is somewhere inside ancestor , possibly with intermediate containers. More...

bool translate_coordinates ( Widget & dest_widget, int src_x, int src_y, int& dest_x, int& dest_y)
Translate coordinates relative to src_widget’s allocation to coordinates relative to dest_widget’s allocations. More...

void override_color (const Gdk::RGBA & color, StateFlags state= STATE_FLAG_NORMAL )
Sets the color to use for a widget. More...

void unset_color ( StateFlags state= STATE_FLAG_NORMAL )
Undoes the effect of previous calls to override_color() . More...

void override_background_color (const Gdk::RGBA & color, StateFlags state= STATE_FLAG_NORMAL )
Sets the background color to use for a widget. More...

void unset_background_color ( StateFlags state= STATE_FLAG_NORMAL )
Undoes the effect of previous calls to override_background_color() . More...

void override_font (const Pango::FontDescription & font_desc)
Sets the font to use for a widget. More...

void unset_font ()
Undoes the effect of previous calls to override_font() . More...

void override_symbolic_color (const Glib::ustring & name, const Gdk::RGBA & color)
Sets a symbolic color for a widget. More...

void unset_symbolic_color (const Glib::ustring & name)
Undoes the effect of previous calls to override_symbolic_color() . More...

void override_cursor (const Gdk::RGBA & cursor, const Gdk::RGBA & secondary_cursor)
Sets the cursor color to use in a widget, overriding the cursor-color and secondary-cursor-color style properties. More...

void unset_cursor ()
Undoes the effect of previous calls to override_cursor() . More...

void reset_style ()
Updates the style context of widget and all descendants by updating its widget path. More...

template<class PropertyType >
void get_style_property (const Glib::ustring & the_property_name, PropertyType& value) const
Gets the value of a style property of widget . More...

Glib::RefPtr < Pango::Context > create_pango_context ()
Creates a new Pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget. More...

Glib::RefPtr < Pango::Context > get_pango_context ()
Gets a Pango::Context with the appropriate font map, font description, and base direction for this widget. More...

void set_font_options (const :: Cairo::FontOptions & options)
Sets the #cairo_font_options_t used for Pango rendering in this widget. More...

void unset_font_options ()
Undoes the effect of previous calls to set_font_options() . More...

:: Cairo::FontOptions get_font_options () const
Returns the #cairo_font_options_t used for Pango rendering. More...

Glib::RefPtr < Pango::Layout > create_pango_layout (const Glib::ustring & text)
Creates a new Pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. More...

Glib::RefPtr < Gdk::Pixbuf > render_icon_pixbuf (const StockID & stock_id, IconSize size )
A convenience function that uses the theme engine and style settings for widget to look up stock_id and render it to a pixbuf. More...

void set_composite_name (const Glib::ustring & name)
Sets a widgets composite name. More...

void unset_composite_name ()
Glib::ustring get_composite_name () const
Obtains the composite name of a widget. More...

void set_direction ( TextDirection dir)
Sets the reading direction on a particular widget. More...

TextDirection get_direction () const
Gets the reading direction for a particular widget. More...

void shape_combine_region (const :: Cairo::RefPtr < const :: Cairo::Region >& region)
Sets a shape for this widget’s GDK window. More...

void input_shape_combine_region (const :: Cairo::RefPtr < const :: Cairo::Region >& region)
Sets an input shape for this widget’s GDK window. More...

WidgetPath get_path () const
Returns the Gtk::WidgetPath representing widget , if the widget is not connected to a toplevel widget, a partial path will be created. More...

std::vector < Widget * > list_mnemonic_labels ()
Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget() ). More...

std::vector < const Widget * > list_mnemonic_labels () const
Returns a newly allocated list of the widgets, normally labels, for which this widget is the target of a mnemonic (see for example, Gtk::Label::set_mnemonic_widget() ). More...

void add_mnemonic_label ( Widget & label)
Adds a widget to the list of mnemonic labels for this widget. More...

void remove_mnemonic_label ( Widget & label)
Removes a widget from the list of mnemonic labels for this widget. More...

void drag_get_data (const Glib::RefPtr < Gdk::DragContext >& context, const Glib::ustring & target, guint32 time)
void drag_highlight ()
void drag_unhighlight ()
void drag_dest_set ( DestDefaults flags= DestDefaults (0), Gdk::DragAction actions= Gdk::DragAction (0))
void drag_dest_set (const std::vector < TargetEntry >& targets, DestDefaults flags= DEST_DEFAULT_ALL , Gdk::DragAction actions= Gdk::ACTION_COPY )
void drag_dest_set_proxy (const Glib::RefPtr < Gdk::Window >& proxy_window, Gdk::DragProtocol protocol, bool use_coordinates)
void drag_dest_unset ()
Glib::ustring drag_dest_find_target (const Glib::RefPtr < Gdk::DragContext >& context, const Glib::RefPtr < TargetList >& target_list) const
Looks for a match between context->targets and the dest_target_list , returning the first matching target, otherwise returning Gdk::NONE. More...

Glib::ustring drag_dest_find_target (const Glib::RefPtr < Gdk::DragContext >& context) const
Glib::RefPtr < TargetList > drag_dest_get_target_list ()
Glib::RefPtr < const TargetList > drag_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 std::vector < TargetEntry >& targets, Gdk::ModifierType start_button_mask= Gdk::MODIFIER_MASK , Gdk::DragAction actions= Gdk::ACTION_COPY )
void drag_source_unset ()
Undoes the effects of set() . More...

void drag_source_set_icon (const Glib::RefPtr < Gdk::Pixbuf >& pixbuf)
Sets the icon that will be used for drags from a particular widget from a Gdk::Pixbuf . More...

void drag_source_set_icon (const StockID & stock_id)
Sets the icon that will be used for drags from a particular source to a stock icon. More...

void drag_source_set_icon (const Glib::ustring & icon_name)
Sets the icon that will be used for drags from a particular source to a themed icon. More...

void drag_source_add_text_targets ()
Add the text targets supported by Gtk::SelectionData to the target list of the drag source. More...

void drag_source_add_uri_targets ()
Add the URI targets supported by Gtk::SelectionData to the target list of the drag source. More...

void drag_source_add_image_targets ()
Add the writable image targets supported by Gtk::SelectionData to the target list of the drag source. More...

Glib::RefPtr < Gdk::DragContext > drag_begin (const Glib::RefPtr < TargetList >& targets, Gdk::DragAction actions, int button, GdkEvent* gdk_event)
Glib::RefPtr < Gdk::DragContext > drag_begin (const Glib::RefPtr < TargetList >& targets, Gdk::DragAction actions, int button, GdkEvent* gdk_event, int x, int y)
bool drag_check_threshold (int start_x, int start_y, int current_x, int current_y)
void drag_set_as_icon (const Glib::RefPtr < Gdk::DragContext >& context, int hot_x, int hot_y)
void queue_resize_no_redraw ()
This function works like queue_resize() , except that the widget is not invalidated. More...

bool get_no_show_all () const
Returns the current value of the Gtk::Widget::property_no_show_all() property, which determines whether calls to show_all() will affect this widget. More...

void set_no_show_all (bool no_show_all=true)
Sets the Gtk::Widget::property_no_show_all() property, which determines whether calls to show_all() will affect this widget. More...

void set_parent ( Widget & parent)
This function is useful only when implementing subclasses of Gtk::Container . More...

void unparent ()
This function is only for use in widget implementations. More...

void map ()
This function is only for use in widget implementations. More...

void unmap ()
This function is only for use in widget implementations. More...

void draw_insertion_cursor (const :: Cairo::RefPtr < :: Cairo::Context >& cr, const Gdk::Rectangle & location, bool is_primary, TextDirection direction, bool draw_arrow=true)
Draws a text caret on cr at location . More...

void set_tooltip_window ( Window & custom_window)
Replaces the default, usually yellow, window used for displaying tooltips with custom_window . More...

Window * get_tooltip_window ()
Returns the Gtk::Window of the current tooltip. More...

void trigger_tooltip_query ()
Triggers a tooltip query on the display where the toplevel of widget is located. More...

void set_tooltip_text (const Glib::ustring & text)
Sets text as the contents of the tooltip. More...

Glib::ustring get_tooltip_text () const
Gets the contents of the tooltip for widget . More...

void set_tooltip_markup (const Glib::ustring & markup)
Sets markup as the contents of the tooltip, which is marked up with the Pango text markup language. More...

Glib::ustring get_tooltip_markup () const
Gets the contents of the tooltip for widget . More...

void set_has_tooltip (bool has_tooltip=TRUE)
Sets the has-tooltip property on widget to has_tooltip . More...

bool get_has_tooltip () const
Returns the current value of the has-tooltip property. More...

int get_width () const
int get_height () const
bool is_composited () const
Whether widget can rely on having its alpha channel drawn correctly. More...

bool in_destruction () const
Returns whether the widget is currently being destroyed. More...

Glib::RefPtr < StyleContext > get_style_context ()
Returns the style context associated to widget . More...

Glib::RefPtr < Gtk::StyleContext > get_style_context () const
Returns the style context associated to widget . More...

Gdk::ModifierType get_modifier_mask ( Gdk::ModifierIntent intent)
Returns the modifier mask the widget’s windowing system backend uses for a particular purpose. More...

void insert_action_group (const Glib::ustring & name, const Glib::RefPtr < Gio::ActionGroup >& group)
Inserts group into widget . More...

void remove_action_group (const Glib::ustring & name)
Removes a group from the widget. More...

Glib::RefPtr < Gio::ActionGroup > get_action_group (const Glib::ustring & prefix)
Retrieves the ActionGroup that was registered using prefix . More...

Glib::RefPtr < const Gio::ActionGroup > get_action_group (const Glib::ustring & prefix) const
Retrieves the ActionGroup that was registered using prefix . More...

std::vector < Glib::ustring > list_action_prefixes () const
Retrieves a nullptr -terminated array of strings containing the prefixes of ActionGroup 's available to widget . More...

void set_font_map (const Glib::RefPtr < Pango::FontMap >& font_map)
Sets the font map to use for Pango rendering. More...

Glib::RefPtr < Pango::FontMap > get_font_map ()
Gets the font map that has been set with set_font_map() . More...

Glib::RefPtr < const Pango::FontMap > get_font_map () const
Gets the font map that has been set with set_font_map() . More...

Glib::SignalProxy < void > signal_show ()
Glib::SignalProxy < void > signal_hide ()
Glib::SignalProxy < void > signal_map ()
Emitted on mapping of a widget to the screen. More...

Glib::SignalProxy < void > signal_unmap ()
Glib::SignalProxy < void > signal_realize ()
Emitted on realization of a widget. More...

Glib::SignalProxy < void > signal_unrealize ()
Glib::SignalProxy < void, Allocation & > signal_size_allocate ()
Glib::SignalProxy < void, Gtk::StateType > signal_state_changed ()
Glib::SignalProxy < void, Gtk::StateFlags > signal_state_flags_changed ()
Glib::SignalProxy < void, Widget * > signal_parent_changed ()
Informs objects that their parent changed. More...

Glib::SignalProxy < void, Widget * > signal_hierarchy_changed ()
Glib::SignalProxy < void > signal_style_updated ()
Glib::SignalProxy < void, TextDirection > signal_direction_changed ()
Glib::SignalProxy < void, bool > signal_grab_notify ()
Glib::SignalProxy < void, GParamSpec* > signal_child_notify ()
Glib::SignalProxy < bool, bool > signal_mnemonic_activate ()
Glib::SignalProxy < void > signal_grab_focus ()
Glib::SignalProxy < bool, DirectionType > signal_focus ()
Glib::SignalProxy < bool, GdkEvent* > signal_event ()
Glib::SignalProxy < void, GdkEvent* > signal_event_after ()
Glib::SignalProxy < bool, GdkEventButton* > signal_button_press_event ()
Event triggered by user pressing button. More...

Glib::SignalProxy < bool, GdkEventButton* > signal_button_release_event ()
Event triggered by user releasing button. More...

Glib::SignalProxy < bool, GdkEventScroll* > signal_scroll_event ()
Glib::SignalProxy < bool, GdkEventMotion* > signal_motion_notify_event ()
Event triggered by user moving pointer. More...

Glib::SignalProxy < bool, GdkEventAny* > signal_delete_event ()
Glib::SignalProxy < bool, const :: Cairo::RefPtr < :: Cairo::Context >& > signal_draw ()
Glib::SignalProxy < bool, GdkEventKey* > signal_key_press_event ()
Event triggered by a key press will widget has focus. More...

Glib::SignalProxy < bool, GdkEventKey* > signal_key_release_event ()
Event triggered by a key release will widget has focus. More...

Glib::SignalProxy < bool, GdkEventCrossing* > signal_enter_notify_event ()
Event triggered by pointer entering widget area. More...

Glib::SignalProxy < bool, GdkEventCrossing* > signal_leave_notify_event ()
Event triggered by pointer leaving widget area. More...

Glib::SignalProxy < bool, GdkEventConfigure* > signal_configure_event ()
Event triggered by a window resizing. More...

Glib::SignalProxy < bool, GdkEventFocus* > signal_focus_in_event ()
Glib::SignalProxy < bool, GdkEventFocus* > signal_focus_out_event ()
Glib::SignalProxy < bool, GdkEventAny* > signal_map_event ()
Glib::SignalProxy < bool, GdkEventAny* > signal_unmap_event ()
Glib::SignalProxy < bool, GdkEventProperty* > signal_property_notify_event ()
Glib::SignalProxy < bool, GdkEventSelection* > signal_selection_clear_event ()
Glib::SignalProxy < bool, GdkEventSelection* > signal_selection_request_event ()
Glib::SignalProxy < bool, GdkEventSelection* > signal_selection_notify_event ()
Glib::SignalProxy < bool, GdkEventProximity* > signal_proximity_in_event ()
Glib::SignalProxy < bool, GdkEventProximity* > signal_proximity_out_event ()
Glib::SignalProxy < bool, GdkEventVisibility* > signal_visibility_notify_event ()
Glib::SignalProxy < bool, GdkEventWindowState* > signal_window_state_event ()
Glib::SignalProxy < void, SelectionData &, guint, guint > signal_selection_get ()
Glib::SignalProxy < void, const SelectionData &, guint > signal_selection_received ()
Glib::SignalProxy < void, const Glib::RefPtr < Gdk::DragContext >& > signal_drag_begin ()
Glib::SignalProxy < void, const Glib::RefPtr < Gdk::DragContext >& > signal_drag_end ()
Glib::SignalProxy < void, const Glib::RefPtr < Gdk::DragContext >&, SelectionData &, guint, guint > signal_drag_data_get ()
Glib::SignalProxy < void, const Glib::RefPtr < Gdk::DragContext >& > signal_drag_data_delete ()
Glib::SignalProxy < bool, const Glib::RefPtr < Gdk::DragContext >&, DragResult > signal_drag_failed ()
Glib::SignalProxy < void, const Glib::RefPtr < Gdk::DragContext >&, guint > signal_drag_leave ()
Glib::SignalProxy < bool, const Glib::RefPtr < Gdk::DragContext >&, int, int, guint > signal_drag_motion ()
Glib::SignalProxy < bool, const Glib::RefPtr < Gdk::DragContext >&, int, int, guint > signal_drag_drop ()
Glib::SignalProxy < void, const Glib::RefPtr < Gdk::DragContext >&, int, int, const SelectionData &, guint, guint > signal_drag_data_received ()
Glib::SignalProxy < void, const Glib::RefPtr < Gdk::Screen >& > signal_screen_changed ()
Glib::SignalProxy < void > signal_composited_changed ()
Glib::SignalProxy < bool > signal_popup_menu ()
Glib::SignalProxy < bool, int, int, bool, const Glib::RefPtr < Tooltip >& > signal_query_tooltip ()
Glib::SignalProxy < bool, GdkEventGrabBroken* > signal_grab_broken_event ()
Glib::SignalProxy < bool, GdkEventExpose* > signal_damage_event ()
Glib::SignalProxy < bool, GdkEventTouch* > signal_touch_event ()
Glib::PropertyProxy < Glib::ustring > property_name ()
The name of the widget. More...

Glib::PropertyProxy_ReadOnly < Glib::ustring > property_name () const
The name of the widget. More...

Glib::PropertyProxy < Container * > property_parent ()
The parent widget of this widget. More...

Glib::PropertyProxy_ReadOnly < Container * > property_parent () const
The parent widget of this widget. More...

Glib::PropertyProxy < int > property_width_request ()
Override for width request of the widget, or -1 if natural request should be used. More...

Glib::PropertyProxy_ReadOnly < int > property_width_request () const
Override for width request of the widget, or -1 if natural request should be used. More...

Glib::PropertyProxy < int > property_height_request ()
Override for height request of the widget, or -1 if natural request should be used. More...

Glib::PropertyProxy_ReadOnly < int > property_height_request () const
Override for height request of the widget, or -1 if natural request should be used. More...

Glib::PropertyProxy < bool > property_visible ()
Whether the widget is visible. More...

Glib::PropertyProxy_ReadOnly < bool > property_visible () const
Whether the widget is visible. More...

Glib::PropertyProxy < bool > property_sensitive ()
Whether the widget responds to input. More...

Glib::PropertyProxy_ReadOnly < bool > property_sensitive () const
Whether the widget responds to input. More...

Glib::PropertyProxy < bool > property_app_paintable ()
Whether the application will paint directly on the widget. More...

Glib::PropertyProxy_ReadOnly < bool > property_app_paintable () const
Whether the application will paint directly on the widget. More...

Glib::PropertyProxy < bool > property_can_focus ()
Whether the widget can accept the input focus. More...

Glib::PropertyProxy_ReadOnly < bool > property_can_focus () const
Whether the widget can accept the input focus. More...

Glib::PropertyProxy < bool > property_has_focus ()
Whether the widget has the input focus. More...

Glib::PropertyProxy_ReadOnly < bool > property_has_focus () const
Whether the widget has the input focus. More...

Glib::PropertyProxy < bool > property_is_focus ()
Whether the widget is the focus widget within the toplevel. More...

Glib::PropertyProxy_ReadOnly < bool > property_is_focus () const
Whether the widget is the focus widget within the toplevel. More...

Glib::PropertyProxy < bool > property_focus_on_click ()
Whether the widget should grab focus when it is clicked with the mouse. More...

Glib::PropertyProxy_ReadOnly < bool > property_focus_on_click () const
Whether the widget should grab focus when it is clicked with the mouse. More...

Glib::PropertyProxy < bool > property_can_default ()
Whether the widget can be the default widget. More...

Glib::PropertyProxy_ReadOnly < bool > property_can_default () const
Whether the widget can be the default widget. More...

Glib::PropertyProxy < bool > property_has_default ()
Whether the widget is the default widget. More...

Glib::PropertyProxy_ReadOnly < bool > property_has_default () const
Whether the widget is the default widget. More...

Glib::PropertyProxy < bool > property_receives_default ()
If TRUE, the widget will receive the default action when it is focused. More...

Glib::PropertyProxy_ReadOnly < bool > property_receives_default () const
If TRUE, the widget will receive the default action when it is focused. More...

Glib::PropertyProxy_ReadOnly < bool > property_composite_child () const
Whether the widget is part of a composite widget. More...

Glib::PropertyProxy < Glib::RefPtr < Style > > property_style ()
The style of the widget, which contains information about how it will look (colors etc). More...

Glib::PropertyProxy_ReadOnly < Glib::RefPtr < Style > > property_style () const
The style of the widget, which contains information about how it will look (colors etc). More...

Glib::PropertyProxy < Gdk::EventMask > property_events ()
The event mask that decides what kind of GdkEvents this widget gets. More...

Glib::PropertyProxy_ReadOnly < Gdk::EventMask > property_events () const
The event mask that decides what kind of GdkEvents this widget gets. More...

Glib::PropertyProxy < bool > property_has_tooltip ()
Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget . More...

Glib::PropertyProxy_ReadOnly < bool > property_has_tooltip () const
Enables or disables the emission of Gtk::Widget::signal_query_tooltip() on widget . More...

Glib::PropertyProxy < Glib::ustring > property_tooltip_markup ()
Sets the text of tooltip to be the given string, which is marked up with the [ Pango text markup language][PangoMarkupFormat]. More...

Glib::PropertyProxy_ReadOnly < Glib::ustring > property_tooltip_markup () const
Sets the text of tooltip to be the given string, which is marked up with the [ Pango text markup language][PangoMarkupFormat]. More...

Glib::PropertyProxy < Glib::ustring > property_tooltip_text ()
Sets the text of tooltip to be the given string. More...

Glib::PropertyProxy_ReadOnly < Glib::ustring > property_tooltip_text () const
Sets the text of tooltip to be the given string. More...

Glib::PropertyProxy_ReadOnly < Glib::RefPtr < Gdk::Window > > property_window () const
The widget's window if it is realized, nullptr otherwise. More...

Glib::PropertyProxy < bool > property_no_show_all ()
Whether gtk_widget_show_all() should not affect this widget. More...

Glib::PropertyProxy_ReadOnly < bool > property_no_show_all () const
Whether gtk_widget_show_all() should not affect this widget. More...

Glib::PropertyProxy < bool > property_double_buffered ()
Whether the widget is double buffered. More...

Glib::PropertyProxy_ReadOnly < bool > property_double_buffered () const
Whether the widget is double buffered. More...

Glib::PropertyProxy < Align > property_halign ()
How to distribute horizontal space if widget gets extra space, see Gtk::Align . More...

Glib::PropertyProxy_ReadOnly < Align > property_halign () const
How to distribute horizontal space if widget gets extra space, see Gtk::Align . More...

Glib::PropertyProxy < Align > property_valign ()
How to distribute vertical space if widget gets extra space, see Gtk::Align . More...

Glib::PropertyProxy_ReadOnly < Align > property_valign () const
How to distribute vertical space if widget gets extra space, see Gtk::Align . More...

Glib::PropertyProxy < int > property_margin_left ()
Margin on left side of widget. More...

Glib::PropertyProxy_ReadOnly < int > property_margin_left () const
Margin on left side of widget. More...

Glib::PropertyProxy < int > property_margin_right ()
Margin on right side of widget. More...

Glib::PropertyProxy_ReadOnly < int > property_margin_right () const
Margin on right side of widget. More...

Glib::PropertyProxy < int > property_margin_start ()
Margin on start of widget, horizontally. More...

Glib::PropertyProxy_ReadOnly < int > property_margin_start () const
Margin on start of widget, horizontally. More...

Glib::PropertyProxy < int > property_margin_end ()
Margin on end of widget, horizontally. More...

Glib::PropertyProxy_ReadOnly < int > property_margin_end () const
Margin on end of widget, horizontally. More...

Glib::PropertyProxy < int > property_margin_top ()
Margin on top side of widget. More...

Glib::PropertyProxy_ReadOnly < int > property_margin_top () const
Margin on top side of widget. More...

Glib::PropertyProxy < int > property_margin_bottom ()
Margin on bottom side of widget. More...

Glib::PropertyProxy_ReadOnly < int > property_margin_bottom () const
Margin on bottom side of widget. More...

Glib::PropertyProxy < int > property_margin ()
Sets all four sides' margin at once. More...

Glib::PropertyProxy_ReadOnly < int > property_margin () const
Sets all four sides' margin at once. More...

Glib::PropertyProxy < bool > property_hexpand ()
Whether to expand horizontally. More...

Glib::PropertyProxy_ReadOnly < bool > property_hexpand () const
Whether to expand horizontally. More...

Glib::PropertyProxy < bool > property_hexpand_set ()
Whether to use the Gtk::Widget::property_hexpand() property. More...

Glib::PropertyProxy_ReadOnly < bool > property_hexpand_set () const
Whether to use the Gtk::Widget::property_hexpand() property. More...

Glib::PropertyProxy < bool > property_vexpand ()
Whether to expand vertically. More...

Glib::PropertyProxy_ReadOnly < bool > property_vexpand () const
Whether to expand vertically. More...

Glib::PropertyProxy < bool > property_vexpand_set ()
Whether to use the Gtk::Widget::property_vexpand() property. More...

Glib::PropertyProxy_ReadOnly < bool > property_vexpand_set () const
Whether to use the Gtk::Widget::property_vexpand() property. More...

Glib::PropertyProxy < bool > property_expand ()
Whether to expand in both directions. More...

Glib::PropertyProxy_ReadOnly < bool > property_expand () const
Whether to expand in both directions. More...

Glib::PropertyProxy < double > property_opacity ()
The requested opacity of the widget. More...

Glib::PropertyProxy_ReadOnly < double > property_opacity () const
The requested opacity of the widget. More...

Glib::PropertyProxy_ReadOnly < int > property_scale_factor () const
The scale factor of the widget. More...

- Public Member Functions inherited from Gtk::Object
Object ( Object && src) noexcept
Object & operator= ( Object && src) noexcept
~Object () noexceptoverride
GObject* gobj ()
Provides access to the underlying C GtkObject. More...

const GObject* gobj () const
Provides access to the underlying C GtkObject. More...

- Public Member Functions inherited from Glib::Object
Object (const Object &)=delete
Object & operator= (const Object &)=delete
Object ( Object &&src) noexcept
Object & operator= ( Object &&src) noexcept
void * get_data (const QueryQuark &key)
void set_data (const Quark &key, void *data)
void set_data (const Quark &key, void *data, DestroyNotify notify)
void remove_data (const QueryQuark &quark)
void * steal_data (const QueryQuark &quark)
Glib::RefPtr < Glib::Object > wrap (GObject *object, bool take_copy=false)
- Public Member Functions inherited from Glib::ObjectBase
ObjectBase (const ObjectBase &)=delete
ObjectBase & operator= (const ObjectBase &)=delete
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
void set_property (const Glib::ustring &property_name, const PropertyType &value)
void get_property (const Glib::ustring &property_name, PropertyType &value) const
void connect_property_changed (const Glib::ustring &property_name, const sigc::slot < void > &slot)
void connect_property_changed (const Glib::ustring &property_name, sigc::slot < void > &&slot)
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot < void > &slot)
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, sigc::slot < void > &&slot)
void freeze_notify ()
void thaw_notify ()
virtual void reference () const
virtual void unreference () const
GObject * gobj ()
const GObject * gobj () const
GObject * gobj_copy () const
- Public Member Functions inherited from sigc::trackable
trackable () noexcept
trackable (const trackable &src) noexcept
trackable ( trackable &&src)
~trackable ()
void add_destroy_notify_callback (void *data, func_destroy_notify func) const
void notify_callbacks ()
trackable & operator= (const trackable &src)
trackable & operator= ( trackable &&src)
void remove_destroy_notify_callback (void *data) const
- Public Member Functions inherited from Gtk::Buildable
Buildable ( Buildable && src) noexcept
Buildable & operator= ( Buildable && src) noexcept
~Buildable () noexceptoverride
GtkBuildable* gobj ()
Provides access to the underlying C GObject. More...

const GtkBuildable* gobj () const
Provides access to the underlying C GObject. More...

void set_name (const Glib::ustring & name)
Sets the name of the buildable object. More...

Glib::ustring get_name () const
Gets the name of the buildable object. More...

- Public Member Functions inherited from Glib::Interface
Interface ()
Interface ( Interface &&src) noexcept
Interface & operator= ( Interface &&src) noexcept
Interface (const Glib::Interface_Class &interface_class)
Interface (GObject *castitem)
~Interface () noexceptoverride
Interface (const Interface &)=delete
Interface & operator= (const Interface &)=delete
GObject * gobj ()
const GObject * gobj () const
- Public Member Functions inherited from Atk::Implementor
Implementor ( Implementor &&src) noexcept
Implementor & operator= ( Implementor &&src) noexcept
virtual ~Implementor () noexcept
AtkImplementor * gobj ()
const AtkImplementor * gobj () const
Glib::RefPtr < Atk::Implementor > wrap (AtkImplementor *object, bool take_copy=false)

Static Public Member Functions

static GType get_type ()
Get the GType for this class, for use with the underlying GObject type system. More...

- Static Public Member Functions inherited from Gtk::Container
static GType get_type ()
Get the GType for this class, for use with the underlying GObject type system. More...

- Static Public Member Functions inherited from Gtk::Widget
static GType get_type ()
Get the GType for this class, for use with the underlying GObject type system. More...

static Widget * get_current_modal_grab ()
Retrieve the widget which is currently grabbing all events. More...

static void push_composite_child ()
Makes all newly-created widgets as composite children until the corresponding pop_composite_child() call. More...

static void pop_composite_child ()
Cancels the effect of a previous call to push_composite_child() . More...

static void set_default_direction ( TextDirection dir)
Sets the default reading direction for widgets where the direction has not been explicitly set by set_direction() . More...

static TextDirection get_default_direction ()
Obtains the current default reading direction. More...

static Widget * drag_get_source_widget (const Glib::RefPtr < Gdk::DragContext >& context)
- Static Public Member Functions inherited from Gtk::Buildable
static void add_interface (GType gtype_implementer)
static GType get_type ()
Get the GType for this class, for use with the underlying GObject type system. More...

- Static Public Member Functions inherited from Atk::Implementor
static void add_interface (GType gtype_implementer)
static GType get_type ()

Protected Member Functions

virtual void on_switch_page ( Widget * page, guint page_number)
This is a default handler for the signal signal_switch_page() . More...

- 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
Implements child_type() . More...

virtual void forall_vfunc (gboolean include_internals, GtkCallback callback, gpointer callback_data)
Invokes a callback on all children of the container. More...

virtual char* composite_name_vfunc (GtkWidget* child)
Returns the composite name of a child widget. More...

virtual void set_child_property_vfunc (GtkWidget* child, guint property_id, const GValue* value, GParamSpec* pspec)
Sets a child property for this container and its child. More...

virtual void get_child_property_vfunc (GtkWidget* child, guint property_id, GValue* value, GParamSpec* pspec) const
Returns a child property for this container and its child. More...

Glib::PropertyProxy < guint > property_border_width ()
The width of the empty border outside the containers children. More...

Glib::PropertyProxy_ReadOnly < guint > property_border_width () const
The width of the empty border outside the containers children. More...

Glib::PropertyProxy < ResizeMode > property_resize_mode ()
Specify how resize events are handled. More...

Glib::PropertyProxy_ReadOnly < ResizeMode > property_resize_mode () const
Specify how resize events are handled. More...

Glib::PropertyProxy_WriteOnly < Widget * > property_child ()
Can be used to add a new child to the container. More...

- Protected Member Functions inherited from Gtk::Widget
virtual void on_show ()
This is a default handler for the signal signal_show() . More...

virtual void on_hide ()
This is a default handler for the signal signal_hide() . More...

virtual void on_map ()
This is a default handler for the signal signal_map() . More...

virtual void on_unmap ()
This is a default handler for the signal signal_unmap() . More...

virtual void on_realize ()
This is a default handler for the signal signal_realize() . More...

virtual void on_unrealize ()
This is a default handler for the signal signal_unrealize() . More...

virtual void on_size_allocate ( Allocation & allocation)
This is a default handler for the signal signal_size_allocate() . More...

virtual void on_state_changed ( Gtk::StateType previous_state)
This is a default handler for the signal signal_state_changed() . More...

virtual void on_parent_changed ( Widget * previous_parent)
This is a default handler for the signal signal_parent_changed() . More...

virtual void on_hierarchy_changed ( Widget * previous_toplevel)
This is a default handler for the signal signal_hierarchy_changed() . More...

virtual void on_style_updated ()
This is a default handler for the signal signal_style_updated() . More...

virtual void on_direction_changed ( TextDirection direction)
This is a default handler for the signal signal_direction_changed() . More...

virtual void on_grab_notify (bool was_grabbed)
This is a default handler for the signal signal_grab_notify() . More...

virtual void on_child_notify (GParamSpec* pspec)
This is a default handler for the signal signal_child_notify() . More...

virtual bool on_mnemonic_activate (bool group_cycling)
This is a default handler for the signal signal_mnemonic_activate() . More...

virtual void on_grab_focus ()
This is a default handler for the signal signal_grab_focus() . More...

virtual bool on_focus ( DirectionType direction)
This is a default handler for the signal signal_focus() . More...

virtual bool on_event (GdkEvent* gdk_event)
This is a default handler for the signal signal_event() . More...

virtual bool on_button_press_event (GdkEventButton* button_event)
This is a default handler for the signal signal_button_press_event() . More...

virtual bool on_button_release_event (GdkEventButton* release_event)
This is a default handler for the signal signal_button_release_event() . More...

virtual bool on_scroll_event (GdkEventScroll* scroll_event)
This is a default handler for the signal signal_scroll_event() . More...

virtual bool on_motion_notify_event (GdkEventMotion* motion_event)
This is a default handler for the signal signal_motion_notify_event() . More...

virtual bool on_delete_event (GdkEventAny* any_event)
This is a default handler for the signal signal_delete_event() . More...

virtual bool on_draw (const :: Cairo::RefPtr < :: Cairo::Context >& cr)
This is a default handler for the signal signal_draw() . More...

virtual bool on_key_press_event (GdkEventKey* key_event)
This is a default handler for the signal signal_key_press_event() . More...

virtual bool on_key_release_event (GdkEventKey* key_event)
This is a default handler for the signal signal_key_release_event() . More...

virtual bool on_enter_notify_event (GdkEventCrossing* crossing_event)
This is a default handler for the signal signal_enter_notify_event() . More...

virtual bool on_leave_notify_event (GdkEventCrossing* crossing_event)
This is a default handler for the signal signal_leave_notify_event() . More...

virtual bool on_configure_event (GdkEventConfigure* configure_event)
This is a default handler for the signal signal_configure_event() . More...

virtual bool on_focus_in_event (GdkEventFocus* focus_event)
This is a default handler for the signal signal_focus_in_event() . More...

virtual bool on_focus_out_event (GdkEventFocus* gdk_event)
This is a default handler for the signal signal_focus_out_event() . More...

virtual bool on_map_event (GdkEventAny* any_event)
This is a default handler for the signal signal_map_event() . More...

virtual bool on_unmap_event (GdkEventAny* any_event)
This is a default handler for the signal signal_unmap_event() . More...

virtual bool on_property_notify_event (GdkEventProperty* property_event)
This is a default handler for the signal signal_property_notify_event() . More...

virtual bool on_selection_clear_event (GdkEventSelection* selection_event)
This is a default handler for the signal signal_selection_clear_event() . More...

virtual bool on_selection_request_event (GdkEventSelection* selection_event)
This is a default handler for the signal signal_selection_request_event() . More...

virtual bool on_selection_notify_event (GdkEventSelection* selection_event)
This is a default handler for the signal signal_selection_notify_event() . More...

virtual bool on_proximity_in_event (GdkEventProximity* proximity_event)
This is a default handler for the signal signal_proximity_in_event() . More...

virtual bool on_proximity_out_event (GdkEventProximity* proximity_event)
This is a default handler for the signal signal_proximity_out_event() . More...

virtual bool on_visibility_notify_event (GdkEventVisibility* visibility_event)
This is a default handler for the signal signal_visibility_notify_event() . More...

virtual bool on_window_state_event (GdkEventWindowState* window_state_event)
This is a default handler for the signal signal_window_state_event() . More...

virtual void on_selection_get ( SelectionData & selection_data, guint info, guint time)
This is a default handler for the signal signal_selection_get() . More...

virtual void on_selection_received (const SelectionData & selection_data, guint time)
This is a default handler for the signal signal_selection_received() . More...

virtual void on_drag_begin (const Glib::RefPtr < Gdk::DragContext >& context)
This is a default handler for the signal signal_drag_begin() . More...

virtual void on_drag_end (const Glib::RefPtr < Gdk::DragContext >& context)
This is a default handler for the signal signal_drag_end() . More...

virtual void on_drag_data_get (const Glib::RefPtr < Gdk::DragContext >& context, SelectionData & selection_data, guint info, guint time)
This is a default handler for the signal signal_drag_data_get() . More...

virtual void on_drag_data_delete (const Glib::RefPtr < Gdk::DragContext >& context)
This is a default handler for the signal signal_drag_data_delete() . More...

virtual void on_drag_leave (const Glib::RefPtr < Gdk::DragContext >& context, guint time)
This is a default handler for the signal signal_drag_leave() . More...

virtual bool on_drag_motion (const Glib::RefPtr < Gdk::DragContext >& context, int x, int y, guint time)
This is a default handler for the signal signal_drag_motion() . More...

virtual bool on_drag_drop (const Glib::RefPtr < Gdk::DragContext >& context, int x, int y, guint time)
This is a default handler for the signal signal_drag_drop() . More...

virtual void on_drag_data_received (const Glib::RefPtr < Gdk::DragContext >& context, int x, int y, const SelectionData & selection_data, guint info, guint time)
This is a default handler for the signal signal_drag_data_received() . More...

virtual void on_screen_changed (const Glib::RefPtr < Gdk::Screen >& previous_screen)
This is a default handler for the signal signal_screen_changed() . More...

virtual void dispatch_child_properties_changed_vfunc (guint p1, GParamSpec** p2)
virtual void show_all_vfunc ()
virtual Glib::RefPtr < Atk::Object > get_accessible_vfunc ()
virtual SizeRequestMode get_request_mode_vfunc () const
virtual void get_preferred_width_vfunc (int& minimum_width, int& natural_width) const
virtual void get_preferred_height_for_width_vfunc (int width, int& minimum_height, int& natural_height) const
virtual void get_preferred_height_vfunc (int& minimum_height, int& natural_height) const
virtual void get_preferred_width_for_height_vfunc (int height, int& minimum_width, int& natural_width) const
Widget ()
void realize ()
Creates the GDK (windowing system) resources associated with a widget. More...

void unrealize ()
This function is only useful in widget implementations. More...

void draw (const :: Cairo::RefPtr < :: Cairo::Context >& cr)
Draws widget to cr . More...

void set_mapped (bool mapped=true)
Marks the widget as being realized. More...

void set_realized (bool realized=true)
Marks the widget as being realized. More...

void set_has_window (bool has_window=true)
Specifies whether widget has a Gdk::Window of its own. More...

void set_window (const Glib::RefPtr < Gdk::Window >& window)
Sets a widget's window. More...

void transform_cairo_context_to_window (const :: Cairo::RefPtr < :: Cairo::Context >& cr, const Glib::RefPtr < const Gdk::Window >& window)
Transforms the given cairo context cr from widget-relative coordinates to window-relative coordinates. More...

Requisition get_requisition () const
Retrieves the widget's requisition. More...

void get_style_property_value (const Glib::ustring & the_property_name, Glib::ValueBase & value) const
Gets the value of a style property of widget . More...

void realize_if_needed ()
- Protected Member Functions inherited from Glib::Object
Object ()
Object (const Glib::ConstructParams &construct_params)
Object (GObject *castitem)
~Object () noexceptoverride
- Protected Member Functions inherited from Glib::ObjectBase
ObjectBase ()
ObjectBase (const char *custom_type_name)
ObjectBase (const std::type_info &custom_type_info)
ObjectBase ( ObjectBase &&src) noexcept
ObjectBase & operator= ( ObjectBase &&src) noexcept
virtual ~ObjectBase () noexcept=0
void initialize (GObject *castitem)
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
- Protected Member Functions inherited from Gtk::Buildable
Buildable ()
You should derive from this class to use it. More...

- Protected Member Functions inherited from Atk::Implementor
Implementor ()
virtual Glib::RefPtr < Object > ref_accessibile_vfunc ()

Related Functions

(Note that these are not member functions.)

Gtk::Notebook * wrap (GtkNotebook* object, bool take_copy=false)
A Glib::wrap() method for this object. More...

Additional Inherited Members

- Public Types inherited from Gtk::Container
typedef sigc::slot < void, Widget & > ForeachSlot
For instance, void on_foreach(Gtk::Widget* widget);. More...

- Public Types inherited from Glib::Object
typedef void(*)(gpointer data DestroyNotify )
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
- Static Protected Member Functions inherited from Gtk::Widget
static bool should_draw_window (const :: Cairo::RefPtr < const :: Cairo::Context >& cr, const Glib::RefPtr < const Gdk::Window >& window)
This function is supposed to be called in Gtk::Widget::signal_draw() implementations for widgets that support multiple windows. More...

Detailed Description

Container which shows one of its children at a time, in tabbed windows.

The Gtk::Notebook widget is a Gtk::Container whose children are pages that can be switched between using tab labels along one edge.

A Notebook widget looks like this:

notebook1.png

Constructor & Destructor Documentation

Gtk::Notebook::Notebook ( Notebook && src )
noexcept
Gtk::Notebook::Notebook ( const Notebook & )
delete
Gtk::Notebook::~Notebook ( )
override noexcept
Gtk::Notebook::Notebook ( )

Member Function Documentation

int Gtk::Notebook::append_page ( Widget & child ,
Widget & tab_label
)

Appends a page to notebook .

Parameters
child The Gtk::Widget to use as the contents of the page.
tab_label The Gtk::Widget to be used as the label for the page.
int Gtk::Notebook::append_page ( Widget & child )
int Gtk::Notebook::append_page ( Widget & child ,
const Glib::ustring & tab_label ,
bool use_mnemonic = false
)
int Gtk::Notebook::append_page ( Widget & child ,
Widget & tab_label ,
Widget & menu_label
)

Appends a page to notebook , specifying the widget to use as the label in the popup menu.

Parameters
child The Gtk::Widget to use as the contents of the page.
tab_label The Gtk::Widget to be used as the label for the page.
menu_label The widget to use as a label for the page-switch menu.
int Gtk::Notebook::append_page ( Widget & child ,
const Glib::ustring & tab_label ,
const Glib::ustring & menu_label ,
bool use_mnemonic = false
)
Gtk::ChildPropertyProxy < bool > Gtk::Notebook::child_property_detachable ( Gtk::Widget & child )

Whether the tab is detachable.

Returns
A ChildPropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy_ReadOnly < bool > Gtk::Notebook::child_property_detachable ( const Gtk::Widget & child ) const

Whether the tab is detachable.

Returns
A ChildPropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy < Glib::ustring > Gtk::Notebook::child_property_menu_label ( Gtk::Widget & child )

The string displayed in the child's menu entry.

Returns
A ChildPropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy_ReadOnly < Glib::ustring > Gtk::Notebook::child_property_menu_label ( const Gtk::Widget & child ) const

The string displayed in the child's menu entry.

Returns
A ChildPropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy < int > Gtk::Notebook::child_property_position ( Gtk::Widget & child )

The index of the child in the parent.

Returns
A ChildPropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy_ReadOnly < int > Gtk::Notebook::child_property_position ( const Gtk::Widget & child ) const

The index of the child in the parent.

Returns
A ChildPropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy < bool > Gtk::Notebook::child_property_reorderable ( Gtk::Widget & child )

Whether the tab is reorderable by user action.

Returns
A ChildPropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy_ReadOnly < bool > Gtk::Notebook::child_property_reorderable ( const Gtk::Widget & child ) const

Whether the tab is reorderable by user action.

Returns
A ChildPropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy < bool > Gtk::Notebook::child_property_tab_expand ( Gtk::Widget & child )

Whether to expand the child's tab.

Returns
A ChildPropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy_ReadOnly < bool > Gtk::Notebook::child_property_tab_expand ( const Gtk::Widget & child ) const

Whether to expand the child's tab.

Returns
A ChildPropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy < bool > Gtk::Notebook::child_property_tab_fill ( Gtk::Widget & child )

Whether the child's tab should fill the allocated area.

Returns
A ChildPropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy_ReadOnly < bool > Gtk::Notebook::child_property_tab_fill ( const Gtk::Widget & child ) const

Whether the child's tab should fill the allocated area.

Returns
A ChildPropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy < Glib::ustring > Gtk::Notebook::child_property_tab_label ( Gtk::Widget & child )

The string displayed on the child's tab label.

Returns
A ChildPropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Gtk::ChildPropertyProxy_ReadOnly < Glib::ustring > Gtk::Notebook::child_property_tab_label ( const Gtk::Widget & child ) const

The string displayed on the child's tab label.

Returns
A ChildPropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::Notebook::detach_tab ( Widget & child )

Removes the child from the notebook.

This function is very similar to Gtk::Container::remove() , but additionally informs the notebook that the removal is happening as part of a tab DND operation, which should not be cancelled.

Since gtkmm 3.16:
Parameters
child A child.
Widget * Gtk::Notebook::get_action_widget ( PackType pack_type = PACK_START )

Gets one of the action widgets.

See set_action_widget() .

Since gtkmm 2.20:
Parameters
pack_type Pack type of the action widget to receive.
Returns
The action widget with the given pack_type or nullptr when this action widget has not been set.
int Gtk::Notebook::get_current_page ( ) const

Returns the page number of the current page.

Returns
The index (starting from 0) of the current page in the notebook. If the notebook has no pages, then -1 will be returned.
Glib::ustring Gtk::Notebook::get_group_name ( ) const

Gets the current group name for notebook .

Since gtkmm 2.24:
Returns
The group name, or nullptr if none is set.
Widget * Gtk::Notebook::get_menu_label ( Widget & child )

Retrieves the menu label widget of the page containing child .

Parameters
child A widget contained in a page of notebook .
Returns
The menu label, or nullptr if the notebook page does not have a menu label other than the default (the tab label).
const Widget * Gtk::Notebook::get_menu_label ( Widget & child ) const

Retrieves the menu label widget of the page containing child .

Parameters
child A widget contained in a page of notebook .
Returns
The menu label, or nullptr if the notebook page does not have a menu label other than the default (the tab label).
Glib::ustring Gtk::Notebook::get_menu_label_text ( Widget & child ) const

Retrieves the text of the menu label for the page containing child .

Parameters
child The child widget of a page of the notebook.
Returns
The text of the tab label.
int Gtk::Notebook::get_n_pages ( ) const

Gets the number of pages in a notebook.

Since gtkmm 2.2:
Returns
The number of pages in the notebook.
Widget * Gtk::Notebook::get_nth_page ( int page_number )

Returns the child widget contained in page number page_number .

Parameters
page_number The index of a page in the notebook, or -1 to get the last page.
Returns
The child widget, or nullptr if page_number is out of bounds.
const Widget * Gtk::Notebook::get_nth_page ( int page_number ) const

Returns the child widget contained in page number page_number .

Parameters
page_number The index of a page in the notebook, or -1 to get the last page.
Returns
The child widget, or nullptr if page_number is out of bounds.
bool Gtk::Notebook::get_scrollable ( ) const

Returns whether the tab label area has arrows for scrolling.

See set_scrollable() .

Returns
true if arrows for scrolling are present.
bool Gtk::Notebook::get_show_border ( ) const

Returns whether a bevel will be drawn around the notebook pages.

See set_show_border() .

Returns
true if the bevel is drawn.
bool Gtk::Notebook::get_show_tabs ( ) const

Returns whether the tabs of the notebook are shown.

See set_show_tabs() .

Returns
true if the tabs are shown.
bool Gtk::Notebook::get_tab_detachable ( Widget & child ) const

Returns whether the tab contents can be detached from notebook .

Since gtkmm 2.10:
Parameters
child A child Gtk::Widget .
Returns
true if the tab is detachable.
guint16 Gtk::Notebook::get_tab_hborder ( ) const

Returns the horizontal width of a tab border.

Since gtkmm 2.22:

Deprecated: 3.4: this function returns zero

Deprecated:
This method now returns zero.
Returns
Horizontal width of a tab border.
Widget * Gtk::Notebook::get_tab_label ( Widget & child )

Returns the tab label widget for the page child .

nullptr is returned if child is not in notebook or if no tab label has specifically been set for child .

Parameters
child The page.
Returns
The tab label.
const Widget * Gtk::Notebook::get_tab_label ( Widget & child ) const

Returns the tab label widget for the page child .

nullptr is returned if child is not in notebook or if no tab label has specifically been set for child .

Parameters
child The page.
Returns
The tab label.
Glib::ustring Gtk::Notebook::get_tab_label_text ( Widget & child ) const

Retrieves the text of the tab label for the page containing child .

Parameters
child A widget contained in a page of notebook .
Returns
The text of the tab label.
PositionType Gtk::Notebook::get_tab_pos ( ) const

Gets the edge at which the tabs for switching pages in the notebook are drawn.

Returns
The edge at which the tabs are drawn.
bool Gtk::Notebook::get_tab_reorderable ( Widget & child ) const

Gets whether the tab can be reordered via drag and drop or not.

Since gtkmm 2.10:
Parameters
child A child Gtk::Widget .
Returns
true if the tab is reorderable.
guint16 Gtk::Notebook::get_tab_vborder ( ) const

Returns the vertical width of a tab border.

Since gtkmm 2.22:

Deprecated: 3.4: this function returns zero

Deprecated:
This method now returns zero.
Returns
Vertical width of a tab border.
static GType Gtk::Notebook::get_type ( )
static

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

GtkNotebook* Gtk::Notebook::gobj ( )
inline

Provides access to the underlying C GtkObject.

const GtkNotebook* Gtk::Notebook::gobj ( ) const
inline

Provides access to the underlying C GtkObject.

int Gtk::Notebook::insert_page ( Widget & child ,
Widget & tab_label ,
int position
)

Insert a page into notebook at the given position.

Parameters
child The Gtk::Widget to use as the contents of the page.
tab_label The Gtk::Widget to be used as the label for the page.
position The index (starting at 0) at which to insert the page, or -1 to append the page after all other pages.
int Gtk::Notebook::insert_page ( Widget & child ,
int position
)
int Gtk::Notebook::insert_page ( Widget & child ,
const Glib::ustring & tab_label ,
int position ,
bool use_mnemonic = false
)
int Gtk::Notebook::insert_page ( Widget & child ,
Widget & tab_label ,
Widget & menu_label ,
int position
)

Insert a page into notebook at the given position, specifying the widget to use as the label in the popup menu.

Parameters
child The Gtk::Widget to use as the contents of the page.
tab_label The Gtk::Widget to be used as the label for the page..
menu_label The widget to use as a label for the page-switch menu.
position The index (starting at 0) at which to insert the page, or -1 to append the page after all other pages.
int Gtk::Notebook::insert_page ( Widget & child ,
const Glib::ustring & tab_label ,
const Glib::ustring & menu_label ,
int position ,
bool use_mnemonic = false
)
void Gtk::Notebook::next_page ( )

Switches to the next page.

Nothing happens if the current page is the last page.

virtual void Gtk::Notebook::on_switch_page ( Widget * page ,
guint page_number
)
protected virtual

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

Notebook & Gtk::Notebook::operator= ( Notebook && src )
noexcept
Notebook & Gtk::Notebook::operator= ( const Notebook & )
delete
int Gtk::Notebook::page_num ( const Widget & child ) const

Finds the index of the page which contains the given child widget.

Parameters
child A Gtk::Widget .
Returns
The index of the page containing child , or -1 if child is not in the notebook.
void Gtk::Notebook::popup_disable ( )

Disables the popup menu.

void Gtk::Notebook::popup_enable ( )

Enables the popup menu: if the user clicks with the right mouse button on the tab labels, a menu with all the pages will be popped up.

int Gtk::Notebook::prepend_page ( Widget & child ,
Widget & tab_label
)

Prepends a page to notebook .

Parameters
child The Gtk::Widget to use as the contents of the page.
tab_label The Gtk::Widget to be used as the label for the page.
int Gtk::Notebook::prepend_page ( Widget & child )
int Gtk::Notebook::prepend_page ( Widget & child ,
const Glib::ustring & tab_label ,
bool use_mnemonic = false
)
int Gtk::Notebook::prepend_page ( Widget & child ,
Widget & tab_label ,
Widget & menu_label
)

Prepends a page to notebook , specifying the widget to use as the label in the popup menu.

Parameters
child The Gtk::Widget to use as the contents of the page.
tab_label The Gtk::Widget to be used as the label for the page.
menu_label The widget to use as a label for the page-switch menu.
int Gtk::Notebook::prepend_page ( Widget & child ,
const Glib::ustring & tab_label ,
const Glib::ustring & menu_label ,
bool use_mnemonic
)
void Gtk::Notebook::prev_page ( )

Switches to the previous page.

Nothing happens if the current page is the first page.

Glib::PropertyProxy < bool > Gtk::Notebook::property_enable_popup ( )

If TRUE, pressing the right mouse button on the notebook pops up a menu that you can use to go to a page.

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.
Glib::PropertyProxy_ReadOnly < bool > Gtk::Notebook::property_enable_popup ( ) const

If TRUE, pressing the right mouse button on the notebook pops up a menu that you can use to go to a page.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy < Glib::ustring > Gtk::Notebook::property_group_name ( )

Group name for tab drag and drop.

Since gtkmm 2.24:
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.
Glib::PropertyProxy_ReadOnly < Glib::ustring > Gtk::Notebook::property_group_name ( ) const

Group name for tab drag and drop.

Since gtkmm 2.24:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy < int > Gtk::Notebook::property_page ( )

The index of the current page.

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.
Glib::PropertyProxy_ReadOnly < int > Gtk::Notebook::property_page ( ) const

The index of the current page.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy < bool > Gtk::Notebook::property_scrollable ( )

If TRUE, scroll arrows are added if there are too many tabs to fit.

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.
Glib::PropertyProxy_ReadOnly < bool > Gtk::Notebook::property_scrollable ( ) const

If TRUE, scroll arrows are added if there are too many tabs to fit.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy < bool > Gtk::Notebook::property_show_border ( )

Whether the border should be shown.

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.
Glib::PropertyProxy_ReadOnly < bool > Gtk::Notebook::property_show_border ( ) const

Whether the border should be shown.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy < bool > Gtk::Notebook::property_show_tabs ( )

Whether tabs should be shown.

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.
Glib::PropertyProxy_ReadOnly < bool > Gtk::Notebook::property_show_tabs ( ) const

Whether tabs should be shown.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy < PositionType > Gtk::Notebook::property_tab_pos ( )

Which side of the notebook holds the tabs.

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.
Glib::PropertyProxy_ReadOnly < PositionType > Gtk::Notebook::property_tab_pos ( ) const

Which side of the notebook holds the tabs.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::Notebook::remove_page ( int page_number = 0 )

Removes a page from the notebook given its index in the notebook.

Parameters
page_number The index of a notebook page, starting from 0. If -1, the last page will be removed.
void Gtk::Notebook::remove_page ( Widget & child )
void Gtk::Notebook::reorder_child ( Widget & child ,
int position
)

Reorders the page containing child , so that it appears in position position .

If position is greater than or equal to the number of children in the list or negative, child will be moved to the end of the list.

Parameters
child The child to move.
position The new position, or -1 to move to the end.
void Gtk::Notebook::set_action_widget ( Widget * widget ,
PackType pack_type = PACK_START
)

Sets widget as one of the action widgets.

Depending on the pack type the widget will be placed before or after the tabs. You can use a Gtk::Box if you need to pack more than one widget on the same side.

Note that action widgets are “internal” children of the notebook and thus not included in the list returned from Gtk::Container::foreach() .

Since gtkmm 2.20:
Parameters
widget A Gtk::Widget .
pack_type Pack type of the action widget.
void Gtk::Notebook::set_current_page ( int page_number )

Switches to the page number page_number .

Note that due to historical reasons, GtkNotebook refuses to switch to a page unless the child widget is visible. Therefore, it is recommended to show child widgets before adding them to a notebook.

Parameters
page_number Index of the page to switch to, starting from 0. If negative, the last page will be used. If greater than the number of pages in the notebook, nothing will be done.
void Gtk::Notebook::set_group_name ( const Glib::ustring & group_name )

Sets a group name for notebook .

Notebooks with the same name will be able to exchange tabs via drag and drop. A notebook with a nullptr group name will not be able to exchange tabs with any other notebook.

Since gtkmm 2.24:
Parameters
group_name The name of the notebook group, or nullptr to unset it.
void Gtk::Notebook::set_menu_label ( Widget & child ,
Widget & menu_label
)

Changes the menu label for the page containing child .

Parameters
child The child widget.
menu_label The menu label, or nullptr for default.
void Gtk::Notebook::set_menu_label_text ( Widget & child ,
const Glib::ustring & menu_text
)

Creates a new label and sets it as the menu label of child .

Parameters
child The child widget.
menu_text The label text.
void Gtk::Notebook::set_scrollable ( bool scrollable = true )

Sets whether the tab label area will have arrows for scrolling if there are too many tabs to fit in the area.

Parameters
scrollable true if scroll arrows should be added.
void Gtk::Notebook::set_show_border ( bool show_border = true )

Sets whether a bevel will be drawn around the notebook pages.

This only has a visual effect when the tabs are not shown. See set_show_tabs() .

Parameters
show_border true if a bevel should be drawn around the notebook.
void Gtk::Notebook::set_show_tabs ( bool show_tabs = true )

Sets whether to show the tabs for the notebook or not.

Parameters
show_tabs true if the tabs should be shown.
void Gtk::Notebook::set_tab_detachable ( Widget & child ,
bool detachable = true
)

Sets whether the tab can be detached from notebook to another notebook or widget.

Note that 2 notebooks must share a common group identificator (see set_group_name() ) to allow automatic tabs interchange between them.

If you want a widget to interact with a notebook through DnD (i.e.: accept dragged tabs from it) it must be set as a drop destination and accept the target “GTK_NOTEBOOK_TAB”. The notebook will fill the selection with a GtkWidget** pointing to the child widget that corresponds to the dropped tab.

Note that you should use detach_tab() instead of Gtk::Container::remove() if you want to remove the tab from the source notebook as part of accepting a drop. Otherwise, the source notebook will think that the dragged tab was removed from underneath the ongoing drag operation, and will initiate a drag cancel animation.

[C example ellipted]

If you want a notebook to accept drags from other widgets, you will have to set your own DnD code to do it.

Since gtkmm 2.10:
Parameters
child A child Gtk::Widget .
detachable Whether the tab is detachable or not.
void Gtk::Notebook::set_tab_label ( Widget & child ,
Widget & tab_label
)

Changes the tab label for child .

If nullptr is specified for tab_label , then the page will have the label “page N”.

Parameters
child The page.
tab_label The tab label widget to use, or nullptr for default tab label.
void Gtk::Notebook::set_tab_label_text ( Widget & child ,
const Glib::ustring & tab_text
)

Creates a new label and sets it as the tab label for the page containing child .

Parameters
child The page.
tab_text The label text.
void Gtk::Notebook::set_tab_pos ( PositionType pos )

Sets the edge at which the tabs for switching pages in the notebook are drawn.

Parameters
pos The edge to draw the tabs at.
void Gtk::Notebook::set_tab_reorderable ( Widget & child ,
bool reorderable = true
)

Sets whether the notebook tab can be reordered via drag and drop or not.

Since gtkmm 2.10:
Parameters
child A child Gtk::Widget .
reorderable Whether the tab is reorderable or not.
Glib::SignalProxy < void, Widget *,guint > Gtk::Notebook::signal_page_added ( )
Slot Prototype:
void on_my_page_added(Widget* page, guint page_num)

the signal_page_added() signal is emitted in the notebook right after a page is added to the notebook.

Since gtkmm 2.10:
Parameters
page The child Gtk::Widget affected.
page_num The new page number for page .
Glib::SignalProxy < void, Widget *,guint > Gtk::Notebook::signal_page_removed ( )
Slot Prototype:
void on_my_page_removed(Widget* page, guint page_num)

the signal_page_removed() signal is emitted in the notebook right after a page is removed from the notebook.

Since gtkmm 2.10:
Parameters
page The child Gtk::Widget affected.
page_num The page page number.
Glib::SignalProxy < void, Widget *,guint > Gtk::Notebook::signal_page_reordered ( )
Slot Prototype:
void on_my_page_reordered(Widget* page, guint page_num)

the signal_page_reordered() signal is emitted in the notebook right after a page has been reordered.

Since gtkmm 2.10:
Parameters
page The child Gtk::Widget affected.
page_num The new page number for page .
Glib::SignalProxy < void, Widget *,guint > Gtk::Notebook::signal_switch_page ( )
Slot Prototype:
void on_my_switch_page(Widget* page, guint page_number)

Emitted when the user or a function changes the current page.

Parameters
page The new current page.
page_number The index of the page.

Friends And Related Function Documentation

Gtk::Notebook * wrap ( GtkNotebook * object ,
bool take_copy = false
)
related

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

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