glibmm: Gio::DBus::Interface Class Reference

Interface - Base type for D-Bus interfaces. More...

#include <giomm/dbusinterface.h>

Inheritance diagram for Gio::DBus::Interface:

[legend]

Public Member Functions
	Interface (Interface &&src) noexcept

Interface &	operator= (Interface &&src) noexcept

	~Interface () noexcept override

GDBusInterface *	gobj ()
	Provides access to the underlying C GObject.

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

Glib::RefPtr< InterfaceInfo >	get_info ()
	Gets D-Bus introspection information for the D-Bus interface implemented by interface.

Glib::RefPtr< const InterfaceInfo >	get_info () const
	Gets D-Bus introspection information for the D-Bus interface implemented by interface.

Glib::RefPtr< Gio::DBus::Object >	get_object ()
	Gets the DBusObject that interface belongs to, if any.

Glib::RefPtr< const Gio::DBus::Object >	get_object () const
	Gets the DBusObject that interface belongs to, if any.

Glib::RefPtr< Gio::DBus::Object >	dup_object ()
	Gets the DBusObject that interface belongs to, if any.

Glib::RefPtr< const Gio::DBus::Object >	dup_object () const
	Gets the DBusObject that interface belongs to, if any.

void	set_object (const Glib::RefPtr< Gio::DBus::Object > &object)
	Sets the DBusObject for interface to object.

Public Member Functions inherited from Glib::Interface
	Interface ()
	A Default constructor.

	Interface (Interface &&src) noexcept

Interface &	operator= (Interface &&src) noexcept

	Interface (const Glib::Interface_Class &interface_class)
	Called by constructors of derived classes.

	Interface (GObject *castitem)
	Called by constructors of derived classes.

	~Interface () noexcept override

	Interface (const Interface &)=delete

Interface &	operator= (const Interface &)=delete

GObject *	gobj ()

const GObject *	gobj () const

Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete

ObjectBase &	operator= (const ObjectBase &)=delete

void	set_property_value (const Glib::ustring & property_name, const Glib::ValueBase & value)
	You probably want to use a specific property_*() accessor method instead.

void	get_property_value (const Glib::ustring & property_name, Glib::ValueBase & value) const
	You probably want to use a specific property_*() accessor method instead.

template<class PropertyType >
void	set_property (const Glib::ustring & property_name, const PropertyType & value)
	You probably want to use a specific property_*() accessor method instead.

template<class PropertyType >
void	get_property (const Glib::ustring & property_name, PropertyType & value) const
	You probably want to use a specific property_*() accessor method instead.

template<class PropertyType >
PropertyType	get_property (const Glib::ustring & property_name) const
	You probably want to use a specific property_*() accessor method instead.

sigc::connection	connect_property_changed (const Glib::ustring & property_name, const sigc::slot< void()> &slot)
	You can use the signal_changed() signal of the property proxy instead.

sigc::connection	connect_property_changed (const Glib::ustring & property_name, sigc::slot< void()> &&slot)
	You can use the signal_changed() signal of the property proxy instead.

void	freeze_notify ()
	Increases the freeze count on object.

void	thaw_notify ()
	Reverts the effect of a previous call to freeze_notify().

virtual void	reference () const
	Increment the reference count for this object.

virtual void	unreference () const
	Decrement the reference count for this object.

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

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

GObject *	gobj_copy () const
	Give a ref-ed copy to someone. Use for direct struct access.

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.

Protected Member Functions
	Interface ()
	You should derive from this class to use it.

virtual Glib::RefPtr< InterfaceInfo >	get_info_vfunc () const

virtual Glib::RefPtr< Gio::DBus::Object >	get_object_vfunc () const

virtual void	set_object_vfunc (const Glib::RefPtr< Gio::DBus::Object > &object)

virtual Glib::RefPtr< Gio::DBus::Object >	dup_object_vfunc () const

Protected Member Functions inherited from Glib::ObjectBase
	ObjectBase ()
	This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor.

	ObjectBase (const char *custom_type_name)
	A derived constructor always overrides this choice.

	ObjectBase (const std::type_info &custom_type_info)
	This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually.

	ObjectBase (ObjectBase &&src) noexcept

ObjectBase &	operator= (ObjectBase &&src) noexcept

virtual	~ObjectBase () noexcept=0

void	initialize (GObject *castitem)

void	initialize_move (GObject castitem, Glib::ObjectBase previous_wrapper)

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gio::DBus::Interface >	wrap (GDBusInterface *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

Interface - Base type for D-Bus interfaces.

The Interface type is the base type for D-Bus interfaces both on the service side (see InterfaceSkeleton) and client side (see Proxy).

Since glibmm 2.34:

Constructor & Destructor Documentation

◆ Interface() [1/2]

Gio::DBus::Interface::Interface ( )

protected

You should derive from this class to use it.

◆ Interface() [2/2]

Gio::DBus::Interface::Interface ( Interface && src )

noexcept

◆ ~Interface()

Gio::DBus::Interface::~Interface ( )

overridenoexcept

Member Function Documentation

◆ add_interface()

static void Gio::DBus::Interface::add_interface ( GType gtype_implementer )

static

◆ dup_object() [1/2]

Glib::RefPtr< Gio::DBus::Object > Gio::DBus::Interface::dup_object ( )

Gets the DBusObject that interface belongs to, if any.

Since glibmm 2.32:

Returns: A DBusObject or nullptr. The returned reference should be freed with Glib::object_unref().

◆ dup_object() [2/2]

Glib::RefPtr< const Gio::DBus::Object > Gio::DBus::Interface::dup_object ( ) const

Gets the DBusObject that interface belongs to, if any.

Since glibmm 2.32:

Returns: A DBusObject or nullptr. The returned reference should be freed with Glib::object_unref().

◆ dup_object_vfunc()

virtual Glib::RefPtr< Gio::DBus::Object > Gio::DBus::Interface::dup_object_vfunc ( ) const

protectedvirtual

◆ get_info() [1/2]

Glib::RefPtr< InterfaceInfo > Gio::DBus::Interface::get_info ( )

Gets D-Bus introspection information for the D-Bus interface implemented by interface.

Since glibmm 2.30:

Returns: A Gio::DBus::InterfaceInfo. Do not free.

◆ get_info() [2/2]

Glib::RefPtr< const InterfaceInfo > Gio::DBus::Interface::get_info ( ) const

Gets D-Bus introspection information for the D-Bus interface implemented by interface.

Since glibmm 2.30:

Returns: A Gio::DBus::InterfaceInfo. Do not free.

◆ get_info_vfunc()

virtual Glib::RefPtr< InterfaceInfo > Gio::DBus::Interface::get_info_vfunc ( ) const

protectedvirtual

◆ get_object() [1/2]

Glib::RefPtr< Gio::DBus::Object > Gio::DBus::Interface::get_object ( )

Gets the DBusObject that interface belongs to, if any.

It is not safe to use the returned object if interface or the returned object is being used from other threads. See g_dbus_interface_dup_object() for a thread-safe alternative.

Since glibmm 2.30:

Returns: A DBusObject or nullptr. The returned reference belongs to interface and should not be freed.

◆ get_object() [2/2]

Glib::RefPtr< const Gio::DBus::Object > Gio::DBus::Interface::get_object ( ) const

Gets the DBusObject that interface belongs to, if any.

It is not safe to use the returned object if interface or the returned object is being used from other threads. See g_dbus_interface_dup_object() for a thread-safe alternative.

Since glibmm 2.30:

Returns: A DBusObject or nullptr. The returned reference belongs to interface and should not be freed.

◆ get_object_vfunc()

virtual Glib::RefPtr< Gio::DBus::Object > Gio::DBus::Interface::get_object_vfunc ( ) const

protectedvirtual

◆ get_type()

static GType Gio::DBus::Interface::get_type ( )

static

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

◆ gobj() [1/2]

GDBusInterface * Gio::DBus::Interface::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GDBusInterface * Gio::DBus::Interface::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ operator=()

Interface & Gio::DBus::Interface::operator= ( Interface && src )

noexcept

◆ set_object()

void Gio::DBus::Interface::set_object ( const Glib::RefPtr< Gio::DBus::Object > & object )

Sets the DBusObject for interface to object.

Note that interface will hold a weak reference to object.

Since glibmm 2.30:

Parameters

object A DBusObject or nullptr.

◆ set_object_vfunc()

virtual void Gio::DBus::Interface::set_object_vfunc ( const Glib::RefPtr< Gio::DBus::Object > & object )

protectedvirtual

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gio::DBus::Interface > wrap	(	GDBusInterface *	object,
		bool	take_copy = `false`
	)

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.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ Interface() [1/2]

◆ Interface() [2/2]

◆ ~Interface()

Member Function Documentation

◆ add_interface()

◆ dup_object() [1/2]

◆ dup_object() [2/2]

◆ dup_object_vfunc()

◆ get_info() [1/2]

◆ get_info() [2/2]

◆ get_info_vfunc()

◆ get_object() [1/2]

◆ get_object() [2/2]

◆ get_object_vfunc()

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ operator=()

◆ set_object()

◆ set_object_vfunc()

Friends And Related Symbol Documentation

◆ wrap()