gtkmm  4.12.0
Public Member Functions | Static Public Member Functions | Related Functions | List of all members
Gtk::StackPage Class Reference

Holds properties of a Gtk::Stack page. More...

#include <gtkmm/stackpage.h>

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

Public Member Functions

 StackPage (StackPage&& src) noexcept
 
StackPageoperator= (StackPage&& src) noexcept
 
 ~StackPage () noexcept override
 
GtkStackPage* gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkStackPage* gobj () const
 Provides access to the underlying C GObject. More...
 
GtkStackPage* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Widgetget_child ()
 Returns the stack child to which self belongs. More...
 
const Widgetget_child () const
 Returns the stack child to which self belongs. More...
 
bool get_visible () const
 Returns whether page is visible in its Gtk::Stack. More...
 
void set_visible (bool visible=true)
 Sets whether page is visible in its Gtk::Stack. More...
 
bool get_needs_attention () const
 Returns whether the page is marked as “needs attention”. More...
 
void set_needs_attention (bool setting=true)
 Sets whether the page is marked as “needs attention”. More...
 
bool get_use_underline () const
 Gets whether underlines in the page title indicate mnemonics. More...
 
void set_use_underline (bool setting=true)
 Sets whether underlines in the page title indicate mnemonics. More...
 
Glib::ustring get_name () const
 Returns the name of the page. More...
 
void set_name (const Glib::ustring& setting)
 Sets the name of the page. More...
 
Glib::ustring get_title () const
 Gets the page title. More...
 
void set_title (const Glib::ustring& setting)
 Sets the page title. More...
 
Glib::ustring get_icon_name () const
 Returns the icon name of the page. More...
 
void set_icon_name (const Glib::ustring& setting)
 Sets the icon name of the page. More...
 
Glib::PropertyProxy_ReadOnly< Widget* > property_child () const
 The child that this page is for. More...
 
Glib::PropertyProxy< Glib::ustring > property_name ()
 The name of the child page. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_name () const
 The name of the child page. More...
 
Glib::PropertyProxy< Glib::ustring > property_title ()
 The title of the child page. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_title () const
 The title of the child page. More...
 
Glib::PropertyProxy< Glib::ustring > property_icon_name ()
 The icon name of the child page. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_icon_name () const
 The icon name of the child page. More...
 
Glib::PropertyProxy< bool > property_needs_attention ()
 Whether the page requires the user attention. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_needs_attention () const
 Whether the page requires the user attention. More...
 
Glib::PropertyProxy< bool > property_visible ()
 Whether this page is visible. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 Whether this page is visible. More...
 
Glib::PropertyProxy< bool > property_use_underline ()
 If set, an underline in the title indicates a mnemonic. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_use_underline () const
 If set, an underline in the title indicates a mnemonic. More...
 
- Public Member Functions inherited from Gtk::Accessible
 Accessible (Accessible&& src) noexcept
 
Accessibleoperator= (Accessible&& src) noexcept
 
 ~Accessible () noexcept override
 
GtkAccessible* gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkAccessible* gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::RefPtr< ATContextget_at_context ()
 Retrieves the accessible implementation for the given Gtk::Accessible. More...
 
Glib::RefPtr< const ATContextget_at_context () const
 Retrieves the accessible implementation for the given Gtk::Accessible. More...
 
bool get_platform_state (PlatformState state) const
 Query a platform state, such as focus. More...
 
Glib::RefPtr< Accessibleget_accessible_parent ()
 Retrieves the accessible parent for an accessible object. More...
 
Glib::RefPtr< const Accessibleget_accessible_parent () const
 Retrieves the accessible parent for an accessible object. More...
 
void set_accessible_parent (const Glib::RefPtr< Accessible >& parent, const Glib::RefPtr< Accessible >& next_sibling)
 Sets the parent and sibling of an accessible object. More...
 
Glib::RefPtr< Accessibleget_first_accessible_child ()
 Retrieves the first accessible child of an accessible object. More...
 
Glib::RefPtr< const Accessibleget_first_accessible_child () const
 Retrieves the first accessible child of an accessible object. More...
 
Glib::RefPtr< Accessibleget_next_accessible_sibling ()
 Retrieves the next accessible sibling of an accessible object. More...
 
Glib::RefPtr< const Accessibleget_next_accessible_sibling () const
 Retrieves the next accessible sibling of an accessible object. More...
 
void update_next_accessible_sibling (const Glib::RefPtr< Accessible >& new_sibling)
 Updates the next accessible sibling of self. More...
 
bool get_bounds (int& x, int& y, int& width, int& height) const
 Queries the coordinates and dimensions of this accessible. More...
 
Role get_accessible_role () const
 Retrieves the accessible role of an accessible object. More...
 
void update_state (State state, const Glib::ValueBase& value)
 Updates an accessible state. More...
 
void update_property (Property property, const Glib::ValueBase& value)
 Updates an accessible property. More...
 
void update_relation (Relation relation, const Glib::ValueBase& value)
 Updates an accessible relation. More...
 
void reset_state (State state)
 Resets the accessible state to its default value. More...
 
void reset_property (Property property)
 Resets the accessible property to its default value. More...
 
void reset_relation (Relation relation)
 Resets the accessible relation to its default value. More...
 
Glib::PropertyProxy< Roleproperty_accessible_role ()
 The accessible role of the given Gtk::Accessible implementation. More...
 
Glib::PropertyProxy_ReadOnly< Roleproperty_accessible_role () const
 The accessible role of the given Gtk::Accessible implementation. More...
 

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::Accessible
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gtk::StackPagewrap (GtkStackPage* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

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

Detailed Description

Holds properties of a Gtk::Stack page.

Use Gtk::Stack::get_page() to get a pointer to an StackPage object.

See also
Stack
Since gtkmm 3.96:

Constructor & Destructor Documentation

Gtk::StackPage::StackPage ( StackPage&&  src)
noexcept
Gtk::StackPage::~StackPage ( )
overridenoexcept

Member Function Documentation

Widget* Gtk::StackPage::get_child ( )

Returns the stack child to which self belongs.

Returns
The child to which self belongs.
const Widget* Gtk::StackPage::get_child ( ) const

Returns the stack child to which self belongs.

Returns
The child to which self belongs.
Glib::ustring Gtk::StackPage::get_icon_name ( ) const

Returns the icon name of the page.

Returns
The value of the property_icon_name() property.
Glib::ustring Gtk::StackPage::get_name ( ) const

Returns the name of the page.

Returns
The value of the property_name() property.
bool Gtk::StackPage::get_needs_attention ( ) const

Returns whether the page is marked as “needs attention”.

Returns
The value of the property_needs_attention() property.
Glib::ustring Gtk::StackPage::get_title ( ) const

Gets the page title.

Returns
The value of the property_title() property.
static GType Gtk::StackPage::get_type ( )
static

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

bool Gtk::StackPage::get_use_underline ( ) const

Gets whether underlines in the page title indicate mnemonics.

Returns
The value of the property_use_underline() property.
bool Gtk::StackPage::get_visible ( ) const

Returns whether page is visible in its Gtk::Stack.

This is independent from the Gtk::Widget::property_visible() property of its widget.

Returns
true if page is visible.
GtkStackPage* Gtk::StackPage::gobj ( )
inline

Provides access to the underlying C GObject.

const GtkStackPage* Gtk::StackPage::gobj ( ) const
inline

Provides access to the underlying C GObject.

GtkStackPage* Gtk::StackPage::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

StackPage& Gtk::StackPage::operator= ( StackPage&&  src)
noexcept
Glib::PropertyProxy_ReadOnly< Widget* > Gtk::StackPage::property_child ( ) const

The child that this page is for.

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::StackPage::property_icon_name ( )

The icon name of the child page.

Default value: ""

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

The icon name of the child page.

Default value: ""

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

The name of the child page.

Default value: ""

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

The name of the child page.

Default value: ""

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

Whether the page requires the user attention.

This is used by the Gtk::StackSwitcher to change the appearance of the corresponding button when a page needs attention and it is not the current one.

Default value: false

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

Whether the page requires the user attention.

This is used by the Gtk::StackSwitcher to change the appearance of the corresponding button when a page needs attention and it is not the current one.

Default value: false

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

The title of the child page.

Default value: ""

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

The title of the child page.

Default value: ""

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

If set, an underline in the title indicates a mnemonic.

Default value: false

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

If set, an underline in the title indicates a mnemonic.

Default value: false

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

Whether this page is visible.

Default value: true

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

Whether this page is visible.

Default value: true

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::StackPage::set_icon_name ( const Glib::ustring &  setting)

Sets the icon name of the page.

Parameters
settingThe new value to set.
void Gtk::StackPage::set_name ( const Glib::ustring &  setting)

Sets the name of the page.

Parameters
settingThe new value to set.
void Gtk::StackPage::set_needs_attention ( bool  setting = true)

Sets whether the page is marked as “needs attention”.

Parameters
settingThe new value to set.
void Gtk::StackPage::set_title ( const Glib::ustring &  setting)

Sets the page title.

Parameters
settingThe new value to set.
void Gtk::StackPage::set_use_underline ( bool  setting = true)

Sets whether underlines in the page title indicate mnemonics.

Parameters
settingThe new value to set.
void Gtk::StackPage::set_visible ( bool  visible = true)

Sets whether page is visible in its Gtk::Stack.

Parameters
visibleThe new property value.

Friends And Related Function Documentation

Glib::RefPtr< Gtk::StackPage > wrap ( GtkStackPage *  object,
bool  take_copy = false 
)
related

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

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