Gtk::StackPage Class Reference

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

#include <gtkmm/stackpage.h>

Inheritance diagram for Gtk::StackPage:

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

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
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.

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gtk::StackPage >	wrap (GtkStackPage *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gtk::Accessible
Glib::RefPtr< Gtk::Accessible >	wrap (GtkAccessible *object, bool take_copy=false)
	A Glib::wrap() method for this object.

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

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

StackPage()

Gtk::StackPage::StackPage ( StackPage &&  src )

noexcept

~StackPage()

Gtk::StackPage::~StackPage ( )

overridenoexcept

Member Function Documentation

get_child() [1/2]

Widget * Gtk::StackPage::get_child

(

)

Returns the stack child to which self belongs.

Returns

The child to which self belongs.

get_child() [2/2]

const Widget * Gtk::StackPage::get_child

(

)

const

Returns the stack child to which self belongs.

Returns

The child to which self belongs.

get_icon_name()

Glib::ustring Gtk::StackPage::get_icon_name

(

)

const

Returns the icon name of the page.

Returns

The value of the property_icon_name() property.

get_name()

Glib::ustring Gtk::StackPage::get_name

(

)

const

Returns the name of the page.

Returns

The value of the property_name() property.

get_needs_attention()

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.

get_title()

Glib::ustring Gtk::StackPage::get_title

(

)

const

Gets the page title.

Returns

The value of the property_title() property.

get_type()

static GType Gtk::StackPage::get_type ( )

static

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

get_use_underline()

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.

get_visible()

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.

gobj() [1/2]

GtkStackPage * Gtk::StackPage::gobj ( )

inline

Provides access to the underlying C GObject.

gobj() [2/2]

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

inline

Provides access to the underlying C GObject.

gobj_copy()

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.

operator=()

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

noexcept

property_child()

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.

property_icon_name() [1/2]

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.

property_icon_name() [2/2]

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.

property_name() [1/2]

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.

property_name() [2/2]

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.

property_needs_attention() [1/2]

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.

property_needs_attention() [2/2]

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.

property_title() [1/2]

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.

property_title() [2/2]

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.

property_use_underline() [1/2]

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.

property_use_underline() [2/2]

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.

property_visible() [1/2]

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.

property_visible() [2/2]

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.

set_icon_name()

void Gtk::StackPage::set_icon_name

(

const Glib::ustring &

setting

)

Sets the icon name of the page.

Parameters

setting

The new value to set.

set_name()

void Gtk::StackPage::set_name

(

const Glib::ustring &

setting

)

Sets the name of the page.

Parameters

setting

The new value to set.

set_needs_attention()

void Gtk::StackPage::set_needs_attention

(

bool

setting = true

)

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

Parameters

setting

The new value to set.

set_title()

void Gtk::StackPage::set_title

(

const Glib::ustring &

setting

)

Sets the page title.

Parameters

setting

The new value to set.

set_use_underline()

void Gtk::StackPage::set_use_underline

(

bool

setting = true

)

Sets whether underlines in the page title indicate mnemonics.

Parameters

setting

The new value to set.

set_visible()

void Gtk::StackPage::set_visible

(

bool

visible = true

)

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

Parameters

visible

The new property value.

Friends And Related Symbol Documentation

wrap()

Glib::RefPtr< Gtk::StackPage > wrap ( GtkStackPage *  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.