// Generated by gmmproc 2.54.1 -- DO NOT MODIFY!
#ifndef _GIOMM_DBUSINTERFACESKELETON_H
#define _GIOMM_DBUSINTERFACESKELETON_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* Copyright (C) 2013 The giomm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <glibmm/object.h>
#include <giomm/dbusinterface.h>
//For the GDBusMethodInvocation type in the *_p.h file.
#ifndef DOXYGEN_SHOULD_SKIP_THIS
using GDBusInterfaceSkeleton = struct _GDBusInterfaceSkeleton;
using GDBusInterfaceSkeletonClass = struct _GDBusInterfaceSkeletonClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Gio
{
namespace DBus
{ class InterfaceSkeleton_Class; } // namespace DBus
} // namespace Gio
#endif //DOXYGEN_SHOULD_SKIP_THIS
namespace Gio
{
namespace DBus
{
/** @addtogroup giommEnums giomm Enums and Flags */
/**
* @var InterfaceSkeletonFlags DBUS_INTERFACE_SKELETON_FLAGS_NONE
* No flags set.
*
* @var InterfaceSkeletonFlags DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD
* Each method invocation is handled in
* a thread dedicated to the invocation. This means that the method implementation can use blocking IO
* without blocking any other part of the process. It also means that the method implementation must
* use locking to access data structures used by other threads.
*
* @enum InterfaceSkeletonFlags
*
* Flags describing the behavior of a DBusInterfaceSkeleton instance.
*
* @newin{2,30}
*
* @ingroup giommEnums
* @par Bitwise operators:
* <tt>%InterfaceSkeletonFlags operator|(InterfaceSkeletonFlags, InterfaceSkeletonFlags)</tt><br>
* <tt>%InterfaceSkeletonFlags operator&(InterfaceSkeletonFlags, InterfaceSkeletonFlags)</tt><br>
* <tt>%InterfaceSkeletonFlags operator^(InterfaceSkeletonFlags, InterfaceSkeletonFlags)</tt><br>
* <tt>%InterfaceSkeletonFlags operator~(InterfaceSkeletonFlags)</tt><br>
* <tt>%InterfaceSkeletonFlags& operator|=(InterfaceSkeletonFlags&, InterfaceSkeletonFlags)</tt><br>
* <tt>%InterfaceSkeletonFlags& operator&=(InterfaceSkeletonFlags&, InterfaceSkeletonFlags)</tt><br>
* <tt>%InterfaceSkeletonFlags& operator^=(InterfaceSkeletonFlags&, InterfaceSkeletonFlags)</tt><br>
*/
enum InterfaceSkeletonFlags
{
DBUS_INTERFACE_SKELETON_FLAGS_NONE = 0x0,
DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD = (1<<0)
};
/** @ingroup giommEnums */
inline InterfaceSkeletonFlags operator|(InterfaceSkeletonFlags lhs, InterfaceSkeletonFlags rhs)
{ return static_cast<InterfaceSkeletonFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline InterfaceSkeletonFlags operator&(InterfaceSkeletonFlags lhs, InterfaceSkeletonFlags rhs)
{ return static_cast<InterfaceSkeletonFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline InterfaceSkeletonFlags operator^(InterfaceSkeletonFlags lhs, InterfaceSkeletonFlags rhs)
{ return static_cast<InterfaceSkeletonFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
/** @ingroup giommEnums */
inline InterfaceSkeletonFlags operator~(InterfaceSkeletonFlags flags)
{ return static_cast<InterfaceSkeletonFlags>(~static_cast<unsigned>(flags)); }
/** @ingroup giommEnums */
inline InterfaceSkeletonFlags& operator|=(InterfaceSkeletonFlags& lhs, InterfaceSkeletonFlags rhs)
{ return (lhs = static_cast<InterfaceSkeletonFlags>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline InterfaceSkeletonFlags& operator&=(InterfaceSkeletonFlags& lhs, InterfaceSkeletonFlags rhs)
{ return (lhs = static_cast<InterfaceSkeletonFlags>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
/** @ingroup giommEnums */
inline InterfaceSkeletonFlags& operator^=(InterfaceSkeletonFlags& lhs, InterfaceSkeletonFlags rhs)
{ return (lhs = static_cast<InterfaceSkeletonFlags>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
class InterfaceInfo;
class Connection;
class MethodInvocation;
/** Abstract base class for D-Bus interfaces on the service side.
* @newin{2,38}
*/
class InterfaceSkeleton
: public Glib::Object,
public Interface
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
using CppObjectType = InterfaceSkeleton;
using CppClassType = InterfaceSkeleton_Class;
using BaseObjectType = GDBusInterfaceSkeleton;
using BaseClassType = GDBusInterfaceSkeletonClass;
// noncopyable
InterfaceSkeleton(const InterfaceSkeleton&) = delete;
InterfaceSkeleton& operator=(const InterfaceSkeleton&) = delete;
private: friend class InterfaceSkeleton_Class;
static CppClassType interfaceskeleton_class_;
protected:
explicit InterfaceSkeleton(const Glib::ConstructParams& construct_params);
explicit InterfaceSkeleton(GDBusInterfaceSkeleton* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
InterfaceSkeleton(InterfaceSkeleton&& src) noexcept;
InterfaceSkeleton& operator=(InterfaceSkeleton&& src) noexcept;
~InterfaceSkeleton() noexcept override;
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
GDBusInterfaceSkeleton* gobj() { return reinterpret_cast<GDBusInterfaceSkeleton*>(gobject_); }
///Provides access to the underlying C GObject.
const GDBusInterfaceSkeleton* gobj() const { return reinterpret_cast<GDBusInterfaceSkeleton*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
GDBusInterfaceSkeleton* gobj_copy();
private:
public:
/** If @a interface has outstanding changes, request for these changes to be
* emitted immediately.
*
* For example, an exported D-Bus interface may queue up property
* changes and emit the
* `org.freedesktop.DBus.Properties.PropertiesChanged`
* signal later (e.g. in an idle handler). This technique is useful
* for collapsing multiple property changes into one.
*
* @newin{2,30}
*/
void flush();
/** Gets D-Bus introspection information for the D-Bus interface
* implemented by @a interface.
*
* @newin{2,30}
*
* @return A DBusInterfaceInfo (never <tt>nullptr</tt>). Do not free.
*/
Glib::RefPtr<InterfaceInfo> get_info();
/** Gets D-Bus introspection information for the D-Bus interface
* implemented by @a interface.
*
* @newin{2,30}
*
* @return A DBusInterfaceInfo (never <tt>nullptr</tt>). Do not free.
*/
Glib::RefPtr<const InterfaceInfo> get_info() const;
//TODO: _WRAP_METHOD(GDBusInterfaceVTable* get_vtable(), g_dbus_interface_skeleton_get_vtable)
/** Gets all D-Bus properties for @a interface.
*
* @newin{2,30}
*
* @return A Variant of type
* ['a{sv}'][G-VARIANT-TYPE-VARDICT:CAPS].
* Free with Glib::variant_unref().
*/
Glib::VariantBase get_properties() const;
/** Exports @a interface at @a object_path on @a connection.
*
* This can be called multiple times to export the same @a interface
* onto multiple connections however the @a object_path provided must be
* the same for all connections.
*
* Use g_dbus_interface_skeleton_unexport() to unexport the object.
*
* @newin{2,30}
*
* @param connection A DBusConnection to export @a interface on.
* @param object_path The path to export the interface at.
*
* @throws Glib::Error
*/
void export_interface_skeleton(const Glib::RefPtr<Connection>& connection, const Glib::ustring& object_path);
/** Stops exporting @a interface on all connections it is exported on.
*
* To unexport @a interface from only a single connection, use
* g_dbus_interface_skeleton_unexport_from_connection()
*
* @newin{2,30}
*/
void unexport();
/** Stops exporting @a interface on @a connection.
*
* To stop exporting on all connections the interface is exported on,
* use g_dbus_interface_skeleton_unexport().
*
* @newin{2,32}
*
* @param connection A DBusConnection.
*/
void unexport_from_connection(const Glib::RefPtr<Connection>& connection);
/** Gets the first connection that @a interface is exported on, if any.
*
* @newin{2,30}
*
* @return A DBusConnection or <tt>nullptr</tt> if @a interface is
* not exported anywhere. Do not free, the object belongs to @a interface.
*/
Glib::RefPtr<Connection> get_connection();
/** Gets the first connection that @a interface is exported on, if any.
*
* @newin{2,30}
*
* @return A DBusConnection or <tt>nullptr</tt> if @a interface is
* not exported anywhere. Do not free, the object belongs to @a interface.
*/
Glib::RefPtr<const Connection> get_connection() const;
/** Gets a list of the connections that @a interface is exported on.
*
* @newin{2,32}
*
* @return A list of
* all the connections that @a interface is exported on.
*/
std::vector< Glib::RefPtr<Connection> > get_connections();
/** Gets a list of the connections that @a interface is exported on.
*
* @newin{2,32}
*
* @return A list of
* all the connections that @a interface is exported on.
*/
std::vector< Glib::RefPtr<const Connection> > get_connections() const;
/** Checks if @a interface is exported on @a connection.
*
* @newin{2,32}
*
* @param connection A DBusConnection.
* @return <tt>true</tt> if @a interface is exported on @a connection, <tt>false</tt> otherwise.
*/
bool has_connection(const Glib::RefPtr<const Connection>& connection) const;
/** Gets the object path that @a interface is exported on, if any.
*
* @newin{2,30}
*
* @return A string owned by @a interface or <tt>nullptr</tt> if @a interface is not exported
* anywhere. Do not free, the string belongs to @a interface.
*/
Glib::ustring get_object_path() const;
/** Gets the DBusInterfaceSkeletonFlags that describes what the behavior
* of @a interface
*
* @newin{2,30}
*
* @return One or more flags from the DBusInterfaceSkeletonFlags enumeration.
*/
InterfaceSkeletonFlags get_flags() const;
/** Sets flags describing what the behavior of @a skeleton should be.
*
* @newin{2,30}
*
* @param flags Flags from the DBusInterfaceSkeletonFlags enumeration.
*/
void set_flags(InterfaceSkeletonFlags flags);
/** Flags from the DBusInterfaceSkeletonFlags enumeration.
*
* @newin{2,30}
*
* Default value: DBUS_INTERFACE_SKELETON_FLAGS_NONE
*
* @return 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< InterfaceSkeletonFlags > property_g_flags() ;
/** Flags from the DBusInterfaceSkeletonFlags enumeration.
*
* @newin{2,30}
*
* Default value: DBUS_INTERFACE_SKELETON_FLAGS_NONE
*
* @return A PropertyProxy_ReadOnly that allows you to get the value of the property,
* or receive notification when the value of the property changes.
*/
Glib::PropertyProxy_ReadOnly< InterfaceSkeletonFlags > property_g_flags() const;
/**
* @par Slot Prototype:
* <tt>bool on_my_%authorize_method(const Glib::RefPtr<MethodInvocation>& invocation)</tt>
*
* Flags: Run Last
*
* Emitted when a method is invoked by a remote caller and used to
* determine if the method call is authorized.
*
* Note that this signal is emitted in a thread dedicated to
* handling the method call so handlers are allowed to perform
* blocking IO. This means that it is appropriate to call e.g.
* [polkit_authority_check_authorization_sync()](http://hal.freedesktop.org/docs/polkit/PolkitAuthority.html#polkit-authority-check-authorization-sync)
* with the
* [POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION](http://hal.freedesktop.org/docs/polkit/PolkitAuthority.htmlP::OLKIT-CHECK-AUTHORIZATION-FLAGS-ALLOW-USER-INTERACTION:CAPS)
* flag set.
*
* If <tt>false</tt> is returned then no further handlers are run and the
* signal handler must take a reference to @a invocation and finish
* handling the call (e.g. return an error via
* g_dbus_method_invocation_return_error()).
*
* Otherwise, if <tt>true</tt> is returned, signal emission continues. If no
* handlers return <tt>false</tt>, then the method is dispatched. If
* @a interface has an enclosing DBusObjectSkeleton, then the
* DBusObjectSkeleton::signal_authorize_method() signal handlers run before
* the handlers for this signal.
*
* The default class handler just returns <tt>true</tt>.
*
* Please note that the common case is optimized: if no signals
* handlers are connected and the default class handler isn't
* overridden (for both @a interface and the enclosing
* DBusObjectSkeleton, if any) and DBusInterfaceSkeleton::property_g_flags() does
* not have the
* DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD
* flags set, no dedicated thread is ever used and the call will be
* handled in the same thread as the object that @a interface belongs
* to was exported in.
*
* @newin{2,30}
*
* @param invocation A DBusMethodInvocation.
* @return <tt>true</tt> if the call is authorized, <tt>false</tt> otherwise.
*/
Glib::SignalProxy< bool,const Glib::RefPtr<MethodInvocation>& > signal_authorize_method();
//TODO: The virtual functions.
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
/// This is a default handler for the signal signal_authorize_method().
virtual bool on_authorize_method(const Glib::RefPtr<MethodInvocation>& invocation);
};
} // namespace DBus
} // namespace Gio
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Gio::DBus::InterfaceSkeleton
*/
Glib::RefPtr<Gio::DBus::InterfaceSkeleton> wrap(GDBusInterfaceSkeleton* object, bool take_copy = false);
}
#endif /* _GIOMM_DBUSINTERFACESKELETON_H */