gtkmm  3.5.13
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions
Gtk::TextChildAnchor Class Reference

A TextChildAnchor is a spot in the buffer where child widgets can be "anchored" (inserted inline, as if they were characters). More...

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

List of all members.

Public Member Functions

virtual ~TextChildAnchor ()
GtkTextChildAnchor* gobj ()
 Provides access to the underlying C GObject.
const GtkTextChildAnchor* gobj () const
 Provides access to the underlying C GObject.
GtkTextChildAnchor* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
std::vector< Widget* > get_widgets ()
 Gets a list of all widgets anchored at this child anchor.
std::vector< const Widget* > get_widgets () const
 Gets a list of all widgets anchored at this child anchor.
bool get_deleted () const
 Determines whether a child anchor has been deleted from the buffer.
- Public Member Functions inherited from Glib::Object
void * get_data (const QueryQuark &key)
void set_data (const Quark &key, void *data)
void set_data (const Quark &key, void *data, DestroyNotify notify)
void remove_data (const QueryQuark &quark)
void * steal_data (const QueryQuark &quark)
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)
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
void freeze_notify ()
void thaw_notify ()
virtual void reference () const
virtual void unreference () const
GObject * gobj_copy () const
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
static Glib::RefPtr
< TextChildAnchor
create ()

Protected Member Functions

 TextChildAnchor ()
- Protected Member Functions inherited from Glib::Object
 Object ()
 Object (const Glib::ConstructParams &construct_params)
 Object (GObject *castitem)
virtual ~Object ()
 ObjectBase ()
 ObjectBase (const char *custom_type_name)
 ObjectBase (const std::type_info &custom_type_info)
virtual ~ObjectBase ()=0
void initialize (GObject *castitem)

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Public Types inherited from Glib::Object
typedef void(* DestroyNotify )(gpointer data)

Detailed Description

A TextChildAnchor is a spot in the buffer where child widgets can be "anchored" (inserted inline, as if they were characters).

The anchor can have multiple widgets anchored, to allow for multiple views.

Typedefed as Gtk::TextBuffer::ChildAnchor.


Constructor & Destructor Documentation

virtual Gtk::TextChildAnchor::~TextChildAnchor ( )
virtual
Gtk::TextChildAnchor::TextChildAnchor ( )
protected

Member Function Documentation

static Glib::RefPtr<TextChildAnchor> Gtk::TextChildAnchor::create ( )
static
bool Gtk::TextChildAnchor::get_deleted ( ) const

Determines whether a child anchor has been deleted from the buffer.

Keep in mind that the child anchor will be unreferenced when removed from the buffer, so you need to hold your own reference (with Glib::object_ref()) if you plan to use this function — otherwise all deleted child anchors will also be finalized.

Returns:
true if the child anchor has been deleted from its buffer.
static GType Gtk::TextChildAnchor::get_type ( )
static

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

std::vector<Widget*> Gtk::TextChildAnchor::get_widgets ( )

Gets a list of all widgets anchored at this child anchor.

Returns:
List of widgets anchored at anchor.
std::vector<const Widget*> Gtk::TextChildAnchor::get_widgets ( ) const

Gets a list of all widgets anchored at this child anchor.

Returns:
List of widgets anchored at anchor.
GtkTextChildAnchor* Gtk::TextChildAnchor::gobj ( )
inline

Provides access to the underlying C GObject.

Reimplemented from Glib::Object.

const GtkTextChildAnchor* Gtk::TextChildAnchor::gobj ( ) const
inline

Provides access to the underlying C GObject.

Reimplemented from Glib::Object.

GtkTextChildAnchor* Gtk::TextChildAnchor::gobj_copy ( )

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


Friends And Related Function Documentation

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

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