class GncOptionGtkUIItem Gtk-specific Interface class for Option Widget More...

#include <gnc-option-gtk-ui.hpp>

Inheritance diagram for GncOptionGtkUIItem:

Public Member Functions
	GncOptionGtkUIItem (GtkWidget *widget, GncOptionUIType type)

	GncOptionGtkUIItem (const GncOptionGtkUIItem &item)

	GncOptionGtkUIItem (GncOptionGtkUIItem &&)=default

virtual void	set_selectable (bool) const noexcept override
	Control wether the widget is sensitive.

void	clear_ui_item () override
	Clear the data from the widget.

void	set_widget (GtkWidget *widget)

virtual GtkWidget *	get_widget () const

virtual SCM	get_widget_scm_value (const GncOption &) const

Public Member Functions inherited from GncOptionUIItem
	GncOptionUIItem (GncOptionUIType type)

GncOptionUIType	get_ui_type () const noexcept

virtual void	set_dirty (bool status) noexcept

virtual bool	get_dirty () const noexcept

virtual void	set_ui_item_from_option (GncOption &option) noexcept=0

virtual void	set_option_from_ui_item (GncOption &option) noexcept=0

Detailed Description

class GncOptionGtkUIItem Gtk-specific Interface class for Option Widget

Definition at line 74 of file gnc-option-gtk-ui.hpp.

Constructor & Destructor Documentation

◆ GncOptionGtkUIItem() [1/2]

GncOptionGtkUIItem::GncOptionGtkUIItem	(	GtkWidget *	widget,
		GncOptionUIType	type
	)

Definition at line 80 of file gnc-option-gtk-ui.cpp.

                                                             :
    GncOptionUIItem{type},
    m_widget{static_cast<GtkWidget*>(g_object_ref(widget))} {}

◆ GncOptionGtkUIItem() [2/2]

GncOptionGtkUIItem::GncOptionGtkUIItem ( const GncOptionGtkUIItem & item )

Definition at line 85 of file gnc-option-gtk-ui.cpp.

                                                                     :
    GncOptionUIItem{item.get_ui_type()},
    m_widget{static_cast<GtkWidget*>(g_object_ref(item.get_widget()))} {}

◆ ~GncOptionGtkUIItem()

GncOptionGtkUIItem::~GncOptionGtkUIItem ( )

overridevirtual

Definition at line 89 of file gnc-option-gtk-ui.cpp.

{
    if (m_widget)
        g_object_unref(m_widget);
}

Member Function Documentation

◆ clear_ui_item()

void GncOptionGtkUIItem::clear_ui_item ( )

overridevirtual

Clear the data from the widget.

Implements GncOptionUIItem.

Definition at line 103 of file gnc-option-gtk-ui.cpp.

{
    if (m_widget)
        g_object_unref(m_widget);
    m_widget = nullptr;
}

◆ get_widget()

virtual GtkWidget * GncOptionGtkUIItem::get_widget ( ) const

inlinevirtual

Definition at line 86 of file gnc-option-gtk-ui.hpp.

86{ return m_widget; }

◆ get_widget_scm_value()

SCM GncOptionGtkUIItem::get_widget_scm_value ( const GncOption & option ) const

virtual

Definition at line 126 of file gnc-option-gtk-ui.cpp.

{
    return SCM_BOOL_F;
}

◆ set_selectable()

void GncOptionGtkUIItem::set_selectable ( bool selectable ) const

overridevirtualnoexcept

Control wether the widget is sensitive.

Implements GncOptionUIItem.

Definition at line 96 of file gnc-option-gtk-ui.cpp.

{
    if (m_widget)
        gtk_widget_set_sensitive (m_widget, selectable);
}

◆ set_widget()

void GncOptionGtkUIItem::set_widget ( GtkWidget * widget )

Definition at line 111 of file gnc-option-gtk-ui.cpp.

{
    if (get_ui_type() == GncOptionUIType::INTERNAL)
    {
        std::string error{"INTERNAL option, setting the UI item forbidden."};
        throw std::logic_error(error);
    }
 
    if (m_widget)
        g_object_unref(m_widget);
 
    m_widget = static_cast<GtkWidget*>(g_object_ref(widget));
}

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

Public Member Functions