gtkmm  4.8.0
Public Types | Public Member Functions | Static Public Member Functions | Related Functions | List of all members
Gtk::AssistantPage Class Reference

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

#include <gtkmm/assistantpage.h>

Inherits Glib::Object.

Public Types

enum class  Type {
  CONTENT ,
  INTRO ,
  CONFIRM ,
  SUMMARY ,
  PROGRESS ,
  CUSTOM
}
 Determines the page role inside a Gtk::Assistant. More...
 

Public Member Functions

 AssistantPage (AssistantPage && src) noexcept
 
AssistantPageoperator= (AssistantPage && src) noexcept
 
 ~AssistantPage () noexcept override
 
GtkAssistantPage * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkAssistantPage * gobj () const
 Provides access to the underlying C GObject. More...
 
GtkAssistantPage * 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 child to which page belongs. More...
 
const Widgetget_child () const
 Returns the child to which page belongs. More...
 
Glib::PropertyProxy< Typeproperty_page_type ()
 The type of the assistant page. More...
 
Glib::PropertyProxy_ReadOnly< Typeproperty_page_type () const
 The type of the assistant page. More...
 
Glib::PropertyProxy< Glib::ustring > property_title ()
 The title of the page. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_title () const
 The title of the page. More...
 
Glib::PropertyProxy< bool > property_complete ()
 Whether all required fields are filled in. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_complete () const
 Whether all required fields are filled in. More...
 
Glib::PropertyProxy_ReadOnly< Widget * > property_child () const
 The child widget. More...
 

Static Public Member Functions

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

Related Functions

(Note that these are not member functions.)

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

Detailed Description

Holds properties of a Gtk::Assistant page.

Use Gtk::Assistant::get_page() to get a pointer to an AssistantPage object.

See also
Assistant
Since gtkmm 3.96:

Constructor & Destructor Documentation

◆ AssistantPage()

Gtk::AssistantPage::AssistantPage ( AssistantPage &&  src)
noexcept

◆ ~AssistantPage()

Gtk::AssistantPage::~AssistantPage ( )
overridenoexcept

Member Function Documentation

◆ get_child() [1/2]

Widget* Gtk::AssistantPage::get_child ( )

Returns the child to which page belongs.

Returns
The child to which page belongs.

◆ get_child() [2/2]

const Widget* Gtk::AssistantPage::get_child ( ) const

Returns the child to which page belongs.

Returns
The child to which page belongs.

◆ get_type()

static GType Gtk::AssistantPage::get_type ( )
static

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

◆ gobj() [1/2]

GtkAssistantPage* Gtk::AssistantPage::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkAssistantPage* Gtk::AssistantPage::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkAssistantPage* Gtk::AssistantPage::gobj_copy ( )

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

◆ operator=()

AssistantPage& Gtk::AssistantPage::operator= ( AssistantPage &&  src)
noexcept

◆ property_child()

Glib::PropertyProxy_ReadOnly< Widget* > Gtk::AssistantPage::property_child ( ) const

The child widget.

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_complete() [1/2]

Glib::PropertyProxy< bool > Gtk::AssistantPage::property_complete ( )

Whether all required fields are filled in.

GTK uses this information to control the sensitivity of the navigation buttons.

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_complete() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::AssistantPage::property_complete ( ) const

Whether all required fields are filled in.

GTK uses this information to control the sensitivity of the navigation buttons.

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_page_type() [1/2]

Glib::PropertyProxy< Type > Gtk::AssistantPage::property_page_type ( )

The type of the assistant page.

Default value: Gtk::AssistantPage::Type::CONTENT

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_page_type() [2/2]

Glib::PropertyProxy_ReadOnly< Type > Gtk::AssistantPage::property_page_type ( ) const

The type of the assistant page.

Default value: Gtk::AssistantPage::Type::CONTENT

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::AssistantPage::property_title ( )

The title of the 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::AssistantPage::property_title ( ) const

The title of the 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.

Friends And Related Function Documentation

◆ wrap()

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