gtkmm: Gtk::CellEditable Class Reference

Interface for widgets which are used for editing cells. More...

#include <gtkmm/celleditable.h>

Inheritance diagram for Gtk::CellEditable:

Public Member Functions

 CellEditable (CellEditable&& src) noexcept
 
CellEditableoperator= (CellEditable&& src) noexcept
 
 ~CellEditable () noexceptoverride
 
GtkCellEditable* gobj ()
 Provides access to the underlying C GObject. More...

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

 
void start_editing (GdkEvent* event)
 Begins editing on a cell_editable. More...

 
void editing_done ()
 Emits the Gtk::CellEditable::signal_editing_done() signal. More...

 
void remove_widget ()
 Emits the Gtk::CellEditable::signal_remove_widget() signal. More...

 
Glib::SignalProxy< void > signal_editing_done ()
 
Glib::SignalProxy< void > signal_remove_widget ()
 
Glib::PropertyProxy< bool > property_editing_canceled ()
 Indicates whether editing on the cell has been canceled. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_editing_canceled () const
 Indicates whether editing on the cell has been canceled. More...

 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 
 Interface (Interface &&src) noexcept
 
Interfaceoperator= (Interface &&src) noexcept
 
 Interface (const Glib::Interface_Class &interface_class)
 
 Interface (GObject *castitem)
 
 ~Interface () noexceptoverride
 
 Interface (const Interface &)=delete
 
Interfaceoperator= (const Interface &)=delete
 
GObject * gobj ()
 
const GObject * gobj () const
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (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 ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src)
 
void remove_destroy_notify_callback (void *data) const
 

Static Public Member Functions

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...

 

Protected Member Functions

 CellEditable ()
 You should derive from this class to use it. More...

 
virtual void start_editing_vfunc (GdkEvent* event)
 
virtual void on_editing_done ()
 This is a default handler for the signal signal_editing_done(). More...

 
virtual void on_remove_widget ()
 This is a default handler for the signal signal_remove_widget(). More...

 
- 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
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 

Related Functions

(Note that these are not member functions.)

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

 

Additional Inherited Members

- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 

Detailed Description

Interface for widgets which are used for editing cells.

The CellEditable interface must be implemented for widgets to be usable when editing the contents of a TreeView cell.

Constructor & Destructor Documentation

Gtk::CellEditable::CellEditable ( )
protected

You should derive from this class to use it.

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

Member Function Documentation

static void Gtk::CellEditable::add_interface ( GType  gtype_implementer)
static
void Gtk::CellEditable::editing_done ( )
static GType Gtk::CellEditable::get_type ( )
static

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

GtkCellEditable* Gtk::CellEditable::gobj ( )
inline

Provides access to the underlying C GObject.

const GtkCellEditable* Gtk::CellEditable::gobj ( ) const
inline

Provides access to the underlying C GObject.

virtual void Gtk::CellEditable::on_editing_done ( )
protectedvirtual

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

virtual void Gtk::CellEditable::on_remove_widget ( )
protectedvirtual

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

CellEditable& Gtk::CellEditable::operator= ( CellEditable&&  src)
noexcept
Glib::PropertyProxy< bool > Gtk::CellEditable::property_editing_canceled ( )

Indicates whether editing on the cell has been canceled.

Since gtkmm 2.20:
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::CellEditable::property_editing_canceled ( ) const

Indicates whether editing on the cell has been canceled.

Since gtkmm 2.20:
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::CellEditable::remove_widget ( )
Glib::SignalProxy< void > Gtk::CellEditable::signal_editing_done ( )
Slot Prototype:
void on_my_editing_done()

This signal is a sign for the cell renderer to update its value from the cell_editable.

Implementations of Gtk::CellEditable are responsible for emitting this signal when they are done editing, e.g. Gtk::Entry is emitting it when the user presses Enter.

Gtk::CellEditable::editing_done() is a convenience method for emitting Gtk::CellEditable::signal_editing_done().

Glib::SignalProxy< void > Gtk::CellEditable::signal_remove_widget ( )
Slot Prototype:
void on_my_remove_widget()

This signal is meant to indicate that the cell is finished editing, and the widget may now be destroyed.

Implementations of Gtk::CellEditable are responsible for emitting this signal when they are done editing. It must be emitted after the Gtk::CellEditable::signal_editing_done() signal, to give the cell renderer a chance to update the cell's value before the widget is removed.

Gtk::CellEditable::remove_widget() is a convenience method for emitting Gtk::CellEditable::signal_remove_widget().

void Gtk::CellEditable::start_editing ( GdkEvent *  event)

Begins editing on a cell_editable.

event is the Gdk::Event that began the editing process. It may be nullptr, in the instance that editing was initiated through programatic means.

Parameters
eventA Gdk::Event, or nullptr.
virtual void Gtk::CellEditable::start_editing_vfunc ( GdkEvent *  event)
protectedvirtual

Friends And Related Function Documentation

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