glibmm 2.78.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gio::DBus::ObjectManager Class Reference

Base type for D-Bus object managers. More...

#include <giomm/dbusobjectmanager.h>

Inheritance diagram for Gio::DBus::ObjectManager:
Inheritance graph
[legend]

Public Member Functions

 ObjectManager (ObjectManager && src) noexcept
 
ObjectManageroperator= (ObjectManager && src) noexcept
 
 ~ObjectManager () noexcept override
 
GDBusObjectManager * gobj ()
 Provides access to the underlying C GObject. More...
 
const GDBusObjectManager * gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::ustring get_object_path () const
 Gets the object path that manager is for. More...
 
std::vector< Glib::RefPtr< Gio::DBus::Object > > get_objects ()
 Gets all DBusObject objects known to manager. More...
 
std::vector< Glib::RefPtr< const Gio::DBus::Object > > get_objects () const
 Gets all DBusObject objects known to manager. More...
 
Glib::RefPtr< Gio::DBus::Objectget_object (const Glib::ustring & object_path)
 Gets the DBusObject at object_path, if any. More...
 
Glib::RefPtr< const Gio::DBus::Objectget_object (const Glib::ustring & object_path) const
 Gets the DBusObject at object_path, if any. More...
 
Glib::RefPtr< Gio::DBus::Interfaceget_interface (const Glib::ustring & object_path, const Glib::ustring & interface_name)
 Gets the interface proxy for interface_name at object_path, if any. More...
 
Glib::RefPtr< const Gio::DBus::Interfaceget_interface (const Glib::ustring & object_path, const Glib::ustring & interface_name) const
 Gets the interface proxy for interface_name at object_path, if any. More...
 
Glib::SignalProxy< void(const Glib::RefPtr< Gio::DBus::Object > &)> signal_object_added ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Gio::DBus::Object > &)> signal_object_removed ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Gio::DBus::Object > &, const Glib::RefPtr< Gio::DBus::Interface > &)> signal_interface_added ()
 
Glib::SignalProxy< void(const Glib::RefPtr< Gio::DBus::Object > &, const Glib::RefPtr< Gio::DBus::Interface > &)> signal_interface_removed ()
 
- Public Member Functions inherited from Glib::Interface
 Interface ()
 A Default constructor. More...
 
 Interface (Interface && src) noexcept
 
Interfaceoperator= (Interface && src) noexcept
 
 Interface (const Glib::Interface_Class & interface_class)
 Called by constructors of derived classes. More...
 
 Interface (GObject * castitem)
 Called by constructors of derived classes. More...
 
 ~Interface () noexcept override
 
 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)
 You probably want to use a specific property_*() accessor method instead. More...
 
void get_property_value (const Glib::ustring & property_name, Glib::ValueBase & value) const
 You probably want to use a specific property_*() accessor method instead. More...
 
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. More...
 
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. More...
 
template<class PropertyType >
PropertyType get_property (const Glib::ustring & property_name) const
 You probably want to use a specific property_*() accessor method instead. More...
 
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. More...
 
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. More...
 
void freeze_notify ()
 Increases the freeze count on object. More...
 
void thaw_notify ()
 Reverts the effect of a previous call to freeze_notify(). More...
 
virtual void reference () const
 Increment the reference count for this object. More...
 
virtual void unreference () const
 Decrement the reference count for this object. More...
 
GObject * gobj ()
 Provides access to the underlying C GObject. More...
 
const GObject * gobj () const
 Provides access to the underlying C GObject. More...
 
GObject * gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access. More...
 

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

 ObjectManager ()
 You should derive from this class to use it. More...
 
virtual Glib::ustring get_object_path_vfunc () const
 
virtual std::vector< Glib::RefPtr< Gio::DBus::Object > > get_objects_vfunc () const
 
virtual Glib::RefPtr< Gio::DBus::Objectget_object_vfunc (const Glib::ustring & object_path) const
 
virtual Glib::RefPtr< Gio::DBus::Interfaceget_interface_vfunc (const Glib::ustring & object_path, const Glib::ustring & interface_name) const
 
virtual void on_object_added (const Glib::RefPtr< Gio::DBus::Object > & object)
 This is a default handler for the signal signal_object_added(). More...
 
virtual void on_object_removed (const Glib::RefPtr< Gio::DBus::Object > & object)
 This is a default handler for the signal signal_object_removed(). More...
 
virtual void on_interface_added (const Glib::RefPtr< Gio::DBus::Object > & object, const Glib::RefPtr< Gio::DBus::Interface > & iface)
 This is a default handler for the signal signal_interface_added(). More...
 
virtual void on_interface_removed (const Glib::RefPtr< Gio::DBus::Object > & object, const Glib::RefPtr< Gio::DBus::Interface > & iface)
 This is a default handler for the signal signal_interface_removed(). More...
 
- 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. More...
 
 ObjectBase (const char * custom_type_name)
 A derived constructor always overrides this choice. More...
 
 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. More...
 
 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< Gio::DBus::ObjectManagerwrap (GDBusObjectManager * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

Base type for D-Bus object managers.

The Gio::DBus::ObjectManager type is the base type for service- and client-side implementations of the standardized org.freedesktop.DBus.ObjectManager interface.

See Gio::DBus::ObjectManagerClient for the client-side implementation and Gio::DBus::ObjectManagerServer for the service-side implementation.

Since glibmm 2.62:

Constructor & Destructor Documentation

◆ ObjectManager() [1/2]

Gio::DBus::ObjectManager::ObjectManager ( )
protected

You should derive from this class to use it.

◆ ObjectManager() [2/2]

Gio::DBus::ObjectManager::ObjectManager ( ObjectManager &&  src)
noexcept

◆ ~ObjectManager()

Gio::DBus::ObjectManager::~ObjectManager ( )
overridenoexcept

Member Function Documentation

◆ add_interface()

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

◆ get_interface() [1/2]

Glib::RefPtr< Gio::DBus::Interface > Gio::DBus::ObjectManager::get_interface ( const Glib::ustring object_path,
const Glib::ustring interface_name 
)

Gets the interface proxy for interface_name at object_path, if any.

Since glibmm 2.30:
Parameters
object_pathObject path to look up.
interface_nameD-Bus interface name to look up.
Returns
A DBusInterface instance or nullptr. Free with Glib::object_unref().

◆ get_interface() [2/2]

Glib::RefPtr< const Gio::DBus::Interface > Gio::DBus::ObjectManager::get_interface ( const Glib::ustring object_path,
const Glib::ustring interface_name 
) const

Gets the interface proxy for interface_name at object_path, if any.

Since glibmm 2.30:
Parameters
object_pathObject path to look up.
interface_nameD-Bus interface name to look up.
Returns
A DBusInterface instance or nullptr. Free with Glib::object_unref().

◆ get_interface_vfunc()

virtual Glib::RefPtr< Gio::DBus::Interface > Gio::DBus::ObjectManager::get_interface_vfunc ( const Glib::ustring object_path,
const Glib::ustring interface_name 
) const
protectedvirtual

◆ get_object() [1/2]

Glib::RefPtr< Gio::DBus::Object > Gio::DBus::ObjectManager::get_object ( const Glib::ustring object_path)

Gets the DBusObject at object_path, if any.

Since glibmm 2.30:
Parameters
object_pathObject path to look up.
Returns
A DBusObject or nullptr. Free with Glib::object_unref().

◆ get_object() [2/2]

Glib::RefPtr< const Gio::DBus::Object > Gio::DBus::ObjectManager::get_object ( const Glib::ustring object_path) const

Gets the DBusObject at object_path, if any.

Since glibmm 2.30:
Parameters
object_pathObject path to look up.
Returns
A DBusObject or nullptr. Free with Glib::object_unref().

◆ get_object_path()

Glib::ustring Gio::DBus::ObjectManager::get_object_path ( ) const

Gets the object path that manager is for.

Since glibmm 2.30:
Returns
A string owned by manager. Do not free.

◆ get_object_path_vfunc()

virtual Glib::ustring Gio::DBus::ObjectManager::get_object_path_vfunc ( ) const
protectedvirtual

◆ get_object_vfunc()

virtual Glib::RefPtr< Gio::DBus::Object > Gio::DBus::ObjectManager::get_object_vfunc ( const Glib::ustring object_path) const
protectedvirtual

◆ get_objects() [1/2]

std::vector< Glib::RefPtr< Gio::DBus::Object > > Gio::DBus::ObjectManager::get_objects ( )

Gets all DBusObject objects known to manager.

Since glibmm 2.30:
Returns
A list of DBusObject objects.

◆ get_objects() [2/2]

std::vector< Glib::RefPtr< const Gio::DBus::Object > > Gio::DBus::ObjectManager::get_objects ( ) const

Gets all DBusObject objects known to manager.

Since glibmm 2.30:
Returns
A list of DBusObject objects.

◆ get_objects_vfunc()

virtual std::vector< Glib::RefPtr< Gio::DBus::Object > > Gio::DBus::ObjectManager::get_objects_vfunc ( ) const
protectedvirtual

◆ get_type()

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

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

◆ gobj() [1/2]

GDBusObjectManager * Gio::DBus::ObjectManager::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GDBusObjectManager * Gio::DBus::ObjectManager::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ on_interface_added()

virtual void Gio::DBus::ObjectManager::on_interface_added ( const Glib::RefPtr< Gio::DBus::Object > &  object,
const Glib::RefPtr< Gio::DBus::Interface > &  iface 
)
protectedvirtual

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

◆ on_interface_removed()

virtual void Gio::DBus::ObjectManager::on_interface_removed ( const Glib::RefPtr< Gio::DBus::Object > &  object,
const Glib::RefPtr< Gio::DBus::Interface > &  iface 
)
protectedvirtual

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

◆ on_object_added()

virtual void Gio::DBus::ObjectManager::on_object_added ( const Glib::RefPtr< Gio::DBus::Object > &  object)
protectedvirtual

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

◆ on_object_removed()

virtual void Gio::DBus::ObjectManager::on_object_removed ( const Glib::RefPtr< Gio::DBus::Object > &  object)
protectedvirtual

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

◆ operator=()

ObjectManager & Gio::DBus::ObjectManager::operator= ( ObjectManager &&  src)
noexcept

◆ signal_interface_added()

Glib::SignalProxy< void(const Glib::RefPtr< Gio::DBus::Object > &, const Glib::RefPtr< Gio::DBus::Interface > &)> Gio::DBus::ObjectManager::signal_interface_added ( )
Slot Prototype:
void on_my_interface_added(const Glib::RefPtr<Gio::DBus::Object>& object, const Glib::RefPtr<Gio::DBus::Interface>& iface)

Flags: Run Last

Emitted when iface is added to object.

This signal exists purely as a convenience to avoid having to connect signals to all objects managed by manager.

Since glibmm 2.30:
Parameters
objectThe DBusObject on which an interface was added.
ifaceThe DBusInterface that was added.

◆ signal_interface_removed()

Glib::SignalProxy< void(const Glib::RefPtr< Gio::DBus::Object > &, const Glib::RefPtr< Gio::DBus::Interface > &)> Gio::DBus::ObjectManager::signal_interface_removed ( )
Slot Prototype:
void on_my_interface_removed(const Glib::RefPtr<Gio::DBus::Object>& object, const Glib::RefPtr<Gio::DBus::Interface>& iface)

Flags: Run Last

Emitted when iface has been removed from object.

This signal exists purely as a convenience to avoid having to connect signals to all objects managed by manager.

Since glibmm 2.30:
Parameters
objectThe DBusObject on which an interface was removed.
ifaceThe DBusInterface that was removed.

◆ signal_object_added()

Glib::SignalProxy< void(const Glib::RefPtr< Gio::DBus::Object > &)> Gio::DBus::ObjectManager::signal_object_added ( )
Slot Prototype:
void on_my_object_added(const Glib::RefPtr<Gio::DBus::Object>& object)

Flags: Run Last

Emitted when object is added to manager.

Since glibmm 2.30:
Parameters
objectThe DBusObject that was added.

◆ signal_object_removed()

Glib::SignalProxy< void(const Glib::RefPtr< Gio::DBus::Object > &)> Gio::DBus::ObjectManager::signal_object_removed ( )
Slot Prototype:
void on_my_object_removed(const Glib::RefPtr<Gio::DBus::Object>& object)

Flags: Run Last

Emitted when object is removed from manager.

Since glibmm 2.30:
Parameters
objectThe DBusObject that was removed.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gio::DBus::ObjectManager > wrap ( GDBusObjectManager *  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.