~ubuntu-branches/ubuntu/maverick/telepathy-glib/maverick

enum <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinFlags" title="enum TpDBusPropertiesMixinFlags">TpDBusPropertiesMixinFlags</a>;

#define <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TP-TYPE-DBUS-PROPERTIES-MIXIN-FLAGS:CAPS" title="TP_TYPE_DBUS_PROPERTIES_MIXIN_FLAGS">TP_TYPE_DBUS_PROPERTIES_MIXIN_FLAGS</a>

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinIfaceInfo" title="TpDBusPropertiesMixinIfaceInfo">TpDBusPropertiesMixinIfaceInfo</a>;

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropInfo" title="TpDBusPropertiesMixinPropInfo">TpDBusPropertiesMixinPropInfo</a>;

void <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-svc-interface-set-dbus-properties-info" title="tp_svc_interface_set_dbus_properties_info ()">tp_svc_interface_set_dbus_properties_info</a>

(<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> g_interface,

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinIfaceInfo" title="TpDBusPropertiesMixinIfaceInfo">TpDBusPropertiesMixinIfaceInfo</a> *info);

(<code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType">GType</a> g_interface</code>,

<code><a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinIfaceInfo" title="TpDBusPropertiesMixinIfaceInfo">TpDBusPropertiesMixinIfaceInfo</a> *info</code>);

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinClass" title="TpDBusPropertiesMixinClass">TpDBusPropertiesMixinClass</a>;

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinIfaceImpl" title="TpDBusPropertiesMixinIfaceImpl">TpDBusPropertiesMixinIfaceImpl</a>;

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropImpl" title="TpDBusPropertiesMixinPropImpl">TpDBusPropertiesMixinPropImpl</a>;

void (<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinGetter" title="TpDBusPropertiesMixinGetter ()">*TpDBusPropertiesMixinGetter</a>) (<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> iface,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> name,

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *value,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> getter_data);

void (<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinGetter" title="TpDBusPropertiesMixinGetter ()">*TpDBusPropertiesMixinGetter</a>) (<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> iface</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> name</code>,

<code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> getter_data</code>);

void <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-getter-gobject-properties" title="tp_dbus_properties_mixin_getter_gobject_properties ()">tp_dbus_properties_mixin_getter_gobject_properties</a>

(<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> iface,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> name,

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *value,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> getter_data);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> (<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinSetter" title="TpDBusPropertiesMixinSetter ()">*TpDBusPropertiesMixinSetter</a>) (<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> iface,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> name,

const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *value,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> setter_data,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-setter-gobject-properties" title="tp_dbus_properties_mixin_setter_gobject_properties ()">tp_dbus_properties_mixin_setter_gobject_properties</a>

(<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> iface,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> name,

const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *value,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> setter_data,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error);

void <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-class-init" title="tp_dbus_properties_mixin_class_init ()">tp_dbus_properties_mixin_class_init</a> (<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a> *cls,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> offset);

(<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> iface</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> name</code>,

<code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> getter_data</code>);

<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> (<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinSetter" title="TpDBusPropertiesMixinSetter ()">*TpDBusPropertiesMixinSetter</a>) (<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> iface</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> name</code>,

<code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> setter_data</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);

<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-setter-gobject-properties" title="tp_dbus_properties_mixin_setter_gobject_properties ()">tp_dbus_properties_mixin_setter_gobject_properties</a>

(<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> iface</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> name</code>,

<code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> setter_data</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);

void <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-class-init" title="tp_dbus_properties_mixin_class_init ()">tp_dbus_properties_mixin_class_init</a> (<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a> *cls</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize">gsize</a> offset</code>);

void <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-implement-interface" title="tp_dbus_properties_mixin_implement_interface ()">tp_dbus_properties_mixin_implement_interface</a>

(<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a> *cls,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> iface,

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinGetter" title="TpDBusPropertiesMixinGetter ()">TpDBusPropertiesMixinGetter</a> getter,

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinSetter" title="TpDBusPropertiesMixinSetter ()">TpDBusPropertiesMixinSetter</a> setter,

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropImpl" title="TpDBusPropertiesMixinPropImpl">TpDBusPropertiesMixinPropImpl</a> *props);

void <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-iface-init" title="tp_dbus_properties_mixin_iface_init ()">tp_dbus_properties_mixin_iface_init</a> (<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> g_iface,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> iface_data);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-get" title="tp_dbus_properties_mixin_get ()">tp_dbus_properties_mixin_get</a> (<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> *self,

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *interface_name,

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *property_name,

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *value,

<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error);

<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable">GHashTable</a> * <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-make-properties-hash" title="tp_dbus_properties_mixin_make_properties_hash ()">tp_dbus_properties_mixin_make_properties_hash</a>

100

(<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object,

101

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *first_interface,

102

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *first_property,

103

...);

(<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a> *cls</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> iface</code>,

<code><a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinGetter" title="TpDBusPropertiesMixinGetter ()">TpDBusPropertiesMixinGetter</a> getter</code>,

<code><a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinSetter" title="TpDBusPropertiesMixinSetter ()">TpDBusPropertiesMixinSetter</a> setter</code>,

<code><a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropImpl" title="TpDBusPropertiesMixinPropImpl">TpDBusPropertiesMixinPropImpl</a> *props</code>);

void <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-iface-init" title="tp_dbus_properties_mixin_iface_init ()">tp_dbus_properties_mixin_iface_init</a> (<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> g_iface</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> iface_data</code>);

<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-get" title="tp_dbus_properties_mixin_get ()">tp_dbus_properties_mixin_get</a> (<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *self</code>,

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *interface_name</code>,

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *property_name</code>,

<code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

<code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);

<a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable">GHashTable</a> * <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-make-properties-hash" title="tp_dbus_properties_mixin_make_properties_hash ()">tp_dbus_properties_mixin_make_properties_hash</a>

(<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object</code>,

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *first_interface</code>,

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *first_property</code>,

<code>...</code>);

104

</pre>

105

</div>

106

100

128

122

To use this mixin as the implementation of <a class="link" href="telepathy-glib-svc-generic.html#TpSvcDBusProperties">TpSvcDBusProperties</a>,

129

123

call <code class="literal">G_IMPLEMENT_INTERFACE (TP_TYPE_SVC_DBUS_PROPERTIES,

130

124

tp_dbus_properties_mixin_iface_init)</code> in the fourth argument to

131

<code class="literal">G_DEFINE_TYPE_WITH_CODE</code>.

125

<code class="literal">G_DEFINE_TYPE_WITH_CODE</code>.

126

132

127

</div>

133

128

134

129

<a name="telepathy-glib-dbus-properties-mixin.details"></a><h2>Details</h2>

135

130

136

131

<a name="TpDBusPropertiesMixinFlags"></a><h3>enum TpDBusPropertiesMixinFlags</h3>

137

<pre class="programlisting">typedef enum {

132

<pre class="programlisting">typedef enum { /*< flags >*/

138

133

TP_DBUS_PROPERTIES_MIXIN_FLAG_READ = 1,

139

134

TP_DBUS_PROPERTIES_MIXIN_FLAG_WRITE = 2

140

135

} TpDBusPropertiesMixinFlags;

141

136

</pre>

142

137

143

Bitfield representing allowed access to a property.

138

Bitfield representing allowed access to a property.

139

140

141

Since 0.11.UNRELEASED, there is a corresponding <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass">GFlagsClass</a> type,

142

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TP-TYPE-DBUS-PROPERTIES-MIXIN-FLAGS:CAPS" title="TP_TYPE_DBUS_PROPERTIES_MIXIN_FLAGS"><code class="literal">TP_TYPE_DBUS_PROPERTIES_MIXIN_FLAGS</code></a>.

143

144

145

146

<tbody>

147

<tr>

148

<td><a name="TP-DBUS-PROPERTIES-MIXIN-FLAG-READ:CAPS"></a><code class="literal">TP_DBUS_PROPERTIES_MIXIN_FLAG_READ</code></td>

149

<td> The property can be read using Get and

149

<td>The property can be read using Get and

150

GetAll

151

</td>

152

</tr>

153

<tr>

154

<td><a name="TP-DBUS-PROPERTIES-MIXIN-FLAG-WRITE:CAPS"></a><code class="literal">TP_DBUS_PROPERTIES_MIXIN_FLAG_WRITE</code></td>

155

<td> The property can be written using Set

155

<td>The property can be written using Set

156

</td>

157

</tr>

158

</tbody>

160

Since 0.7.3

161

</div>

162

<hr>

163

164

<a name="TP-TYPE-DBUS-PROPERTIES-MIXIN-FLAGS:CAPS"></a><h3>TP_TYPE_DBUS_PROPERTIES_MIXIN_FLAGS</h3>

165

<pre class="programlisting">#define TP_TYPE_DBUS_PROPERTIES_MIXIN_FLAGS (tp_dbus_properties_mixin_flags_get_type ())

166

</pre>

167

168

The <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html#GFlagsClass">GFlagsClass</a> type of <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinFlags" title="enum TpDBusPropertiesMixinFlags">TpDBusPropertiesMixinFlags</a>.

169

170

Since 0.11.UNRELEASED

171

</div>

172

<hr>

163

173

164

174

<a name="TpDBusPropertiesMixinIfaceInfo"></a><h3>TpDBusPropertiesMixinIfaceInfo</h3>

165

175

<pre class="programlisting">typedef struct {

180

190

181

191

182

192

In addition to the documented members, there are two private pointers

183

for future expansion, which must always be initialized to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

193

for future expansion, which must always be initialized to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

194

184

195

185

196

186

197

<tbody>

187

198

<tr>

188

<td><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> <code><a name="TpDBusPropertiesMixinIfaceInfo.dbus-interface"></a>dbus_interface</code>;</td>

189

<td> Quark representing the interface's name

199

<td><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> <code><a name="TpDBusPropertiesMixinIfaceInfo.dbus-interface"></a>dbus_interface</code>;</td>

200

<td>Quark representing the interface's name

190

201

</td>

191

202

</tr>

192

203

<tr>

193

204

<td><a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropInfo" title="TpDBusPropertiesMixinPropInfo">TpDBusPropertiesMixinPropInfo</a> *<code><a name="TpDBusPropertiesMixinIfaceInfo.props"></a>props</code>;</td>

194

<td> Array of property descriptions, terminated by one with

195

205

<td>Array of property descriptions, terminated by one with

206

196

207

</td>

197

208

</tr>

198

209

</tbody>

216

227

217

228

218

229

In addition to the documented members, there are two private pointers

219

for future expansion, which must always be initialized to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

230

for future expansion, which must always be initialized to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

231

220

232

221

233

222

234

<tbody>

223

235

<tr>

224

<td><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> <code><a name="TpDBusPropertiesMixinPropInfo.name"></a>name</code>;</td>

225

<td> Quark representing the property's name

236

<td><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> <code><a name="TpDBusPropertiesMixinPropInfo.name"></a>name</code>;</td>

237

<td>Quark representing the property's name

226

238

</td>

227

239

</tr>

228

240

<tr>

229

241

<td><a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinFlags" title="enum TpDBusPropertiesMixinFlags">TpDBusPropertiesMixinFlags</a> <code><a name="TpDBusPropertiesMixinPropInfo.flags"></a>flags</code>;</td>

230

<td> Flags representing read/write access to the property

231

</td>

232

</tr>

233

<tr>

234

<td><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *<code><a name="TpDBusPropertiesMixinPropInfo.dbus-signature"></a>dbus_signature</code>;</td>

235

<td> The D-Bus signature of the property

236

</td>

237

</tr>

238

<tr>

239

<td><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> <code><a name="TpDBusPropertiesMixinPropInfo.type"></a>type</code>;</td>

240

<td> The GType used in a GValue to implement the property

242

<td>Flags representing read/write access to the property

243

</td>

244

</tr>

245

<tr>

246

<td><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *<code><a name="TpDBusPropertiesMixinPropInfo.dbus-signature"></a>dbus_signature</code>;</td>

247

<td>The D-Bus signature of the property

248

</td>

249

</tr>

250

<tr>

251

<td><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType">GType</a> <code><a name="TpDBusPropertiesMixinPropInfo.type"></a>type</code>;</td>

252

<td>The GType used in a GValue to implement the property

241

253

</td>

242

254

</tr>

243

255

</tbody>

248

260

249

261

<a name="tp-svc-interface-set-dbus-properties-info"></a><h3>tp_svc_interface_set_dbus_properties_info ()</h3>

250

262

<pre class="programlisting">void tp_svc_interface_set_dbus_properties_info

251

(<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> g_interface,

252

263

(<code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType">GType</a> g_interface</code>,

264

253

265

254

266

Declare that <code>g_interface</code> implements the given D-Bus interface, with the

255

267

given properties. This may only be called once per GInterface, usually from

256

a section of its base_init function that only runs once.

268

a section of its base_init function that only runs once.

269

257

270

258

271

259

272

<tbody>

260

273

<tr>

261

274

<td><code>g_interface</code> :</td>

262

<td> The <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType">GType</a> of a service interface

275

<td>The <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType">GType</a> of a service interface

263

276

</td>

264

277

</tr>

265

278

<tr>

266

279

267

<td> an interface description

280

<td>an interface description

268

281

</td>

269

282

</tr>

270

283

</tbody>

284

297

285

298

286

299

In addition to the documented fields, there are 7 pointers reserved for

287

future use, which must be initialized to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

300

future use, which must be initialized to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

301

288

302

289

303

290

304

291

305

<td><a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinIfaceImpl" title="TpDBusPropertiesMixinIfaceImpl">TpDBusPropertiesMixinIfaceImpl</a> *<code><a name="TpDBusPropertiesMixinClass.interfaces"></a>interfaces</code>;</td>

292

<td> An array of interface implementations, terminated by one with

293

<code>name</code> equal to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

306

<td>An array of interface implementations, terminated by one with

307

<code>name</code> equal to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

294

308

</td>

295

309

</tr></tbody>

296

310

</table></div>

311

325

312

326

313

327

In addition to the documented fields, there are four pointers which must

314

be initialized to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

328

be initialized to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

315

329

316

330

317

331

This structure must either be statically allocated, or duplicated and never

318

freed, so it always remains valid.

332

freed, so it always remains valid.

333

319

334

320

335

321

336

<tbody>

322

337

<tr>

323

<td>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *<code><a name="TpDBusPropertiesMixinIfaceImpl.name"></a>name</code>;</td>

324

<td> The name of the interface

338

<td>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *<code><a name="TpDBusPropertiesMixinIfaceImpl.name"></a>name</code>;</td>

339

<td>The name of the interface

325

340

</td>

326

341

</tr>

327

342

<tr>

328

343

<td><a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinGetter" title="TpDBusPropertiesMixinGetter ()">TpDBusPropertiesMixinGetter</a> <code><a name="TpDBusPropertiesMixinIfaceImpl.getter"></a>getter</code>;</td>

329

<td> A callback to get the current value of the property, to which

344

<td>A callback to get the current value of the property, to which

330

345

the <code>getter_data</code> from each property implementation will be passed

331

346

</td>

332

347

</tr>

333

348

<tr>

334

349

<td><a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinSetter" title="TpDBusPropertiesMixinSetter ()">TpDBusPropertiesMixinSetter</a> <code><a name="TpDBusPropertiesMixinIfaceImpl.setter"></a>setter</code>;</td>

335

<td> A callback to set a new value for the property, to which

350

<td>A callback to set a new value for the property, to which

336

351

the <code>setter_data</code> from each property implementation will be passed

337

352

</td>

338

353

</tr>

339

354

<tr>

340

355

<td><a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropImpl" title="TpDBusPropertiesMixinPropImpl">TpDBusPropertiesMixinPropImpl</a> *<code><a name="TpDBusPropertiesMixinIfaceImpl.props"></a>props</code>;</td>

341

<td> An array of property implementations, terminated by one with

342

<code>name</code> equal to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

356

<td>An array of property implementations, terminated by one with

357

<code>name</code> equal to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

343

358

</td>

344

359

</tr>

345

360

</tbody>

360

375

361

376

362

377

In addition to the documented fields, there are three pointers which must

363

be initialized to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

378

be initialized to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

364

379

365

380

366

381

This structure must either be statically allocated, or duplicated and never

367

freed, so it always remains valid.

382

freed, so it always remains valid.

383

368

384

369

385

370

386

<tbody>

371

387

<tr>

372

<td>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *<code><a name="TpDBusPropertiesMixinPropImpl.name"></a>name</code>;</td>

373

<td> The name of the property as it appears on D-Bus

374

</td>

375

</tr>

376

<tr>

377

<td><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> <code><a name="TpDBusPropertiesMixinPropImpl.getter-data"></a>getter_data</code>;</td>

378

<td> Arbitrary user-supplied data for the getter function

379

</td>

380

</tr>

381

<tr>

382

<td><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> <code><a name="TpDBusPropertiesMixinPropImpl.setter-data"></a>setter_data</code>;</td>

383

<td> Arbitrary user-supplied data for the setter function

388

<td>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *<code><a name="TpDBusPropertiesMixinPropImpl.name"></a>name</code>;</td>

389

<td>The name of the property as it appears on D-Bus

390

</td>

391

</tr>

392

<tr>

393

<td><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> <code><a name="TpDBusPropertiesMixinPropImpl.getter-data"></a>getter_data</code>;</td>

394

<td>Arbitrary user-supplied data for the getter function

395

</td>

396

</tr>

397

<tr>

398

<td><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> <code><a name="TpDBusPropertiesMixinPropImpl.setter-data"></a>setter_data</code>;</td>

399

<td>Arbitrary user-supplied data for the setter function

384

400

</td>

385

401

</tr>

386

402

</tbody>

390

406

<hr>

391

407

392

408

<a name="TpDBusPropertiesMixinGetter"></a><h3>TpDBusPropertiesMixinGetter ()</h3>

393

<pre class="programlisting">void (*TpDBusPropertiesMixinGetter) (<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object,

394

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> iface,

395

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> name,

396

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *value,

397

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> getter_data);</pre>

409

<pre class="programlisting">void (*TpDBusPropertiesMixinGetter) (<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object</code>,

410

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> iface</code>,

411

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> name</code>,

412

<code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

413

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> getter_data</code>);</pre>

398

414

399

415

Signature of a callback used to get the value of a property.

400

416

401

417

402

418

For simplicity, in this mixin we don't allow getting a property to fail;

403

implementations must always be prepared to return *something*.

419

implementations must always be prepared to return *something*.

420

404

421

405

422

406

423

<tbody>

407

424

<tr>

408

425

<td><code>object</code> :</td>

409

<td> The exported object with the properties

426

<td>The exported object with the properties

410

427

</td>

411

428

</tr>

412

429

<tr>

413

430

<td><code>iface</code> :</td>

414

<td> A quark representing the D-Bus interface name

431

<td>A quark representing the D-Bus interface name

415

432

</td>

416

433

</tr>

417

434

<tr>

418

435

419

<td> A quark representing the D-Bus property name

436

<td>A quark representing the D-Bus property name

420

437

</td>

421

438

</tr>

422

439

<tr>

423

440

<td><code>value</code> :</td>

424

<td> A GValue pre-initialized to the right type, into which to put

441

<td>A GValue pre-initialized to the right type, into which to put

425

442

the value

426

443

</td>

427

444

</tr>

428

445

<tr>

429

446

<td><code>getter_data</code> :</td>

430

<td> The getter_data from the <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropImpl" title="TpDBusPropertiesMixinPropImpl">TpDBusPropertiesMixinPropImpl</a>

447

<td>The getter_data from the <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropImpl" title="TpDBusPropertiesMixinPropImpl">TpDBusPropertiesMixinPropImpl</a>

431

448

</td>

432

449

</tr>

433

450

</tbody>

437

454

438

455

<a name="tp-dbus-properties-mixin-getter-gobject-properties"></a><h3>tp_dbus_properties_mixin_getter_gobject_properties ()</h3>

439

456

<pre class="programlisting">void tp_dbus_properties_mixin_getter_gobject_properties

440

(<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object,

441

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> iface,

442

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> name,

443

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *value,

444

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> getter_data);</pre>

457

(<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object</code>,

458

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> iface</code>,

459

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> name</code>,

460

<code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

461

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> getter_data</code>);</pre>

445

462

446

463

An implementation of <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinGetter" title="TpDBusPropertiesMixinGetter ()">TpDBusPropertiesMixinGetter</a> which assumes that

447

the <code>getter_data</code> is the name of a readable <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> property of an

448

appropriate type, and uses it for the value of the D-Bus property.

464

the <code>getter_data</code> is the name of a readable <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> property of an

465

appropriate type, and uses it for the value of the D-Bus property.

466

449

467

450

468

451

469

<tbody>

452

470

<tr>

453

471

<td><code>object</code> :</td>

454

<td> The exported object with the properties

472

<td>The exported object with the properties

455

473

</td>

456

474

</tr>

457

475

<tr>

458

476

<td><code>iface</code> :</td>

459

<td> A quark representing the D-Bus interface name

477

<td>A quark representing the D-Bus interface name

460

478

</td>

461

479

</tr>

462

480

<tr>

463

481

464

<td> A quark representing the D-Bus property name

482

<td>A quark representing the D-Bus property name

465

483

</td>

466

484

</tr>

467

485

<tr>

468

486

<td><code>value</code> :</td>

469

<td> A GValue pre-initialized to the right type, into which to put

487

<td>A GValue pre-initialized to the right type, into which to put

470

488

the value

471

489

</td>

472

490

</tr>

473

491

<tr>

474

492

<td><code>getter_data</code> :</td>

475

493

<td>The getter_data from the <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropImpl" title="TpDBusPropertiesMixinPropImpl">TpDBusPropertiesMixinPropImpl</a>,

476

494

which must be a string containing the GObject property's name

477

495

</td>

478

496

</tr>

482

500

<hr>

483

501

484

502

<a name="TpDBusPropertiesMixinSetter"></a><h3>TpDBusPropertiesMixinSetter ()</h3>

485

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> (*TpDBusPropertiesMixinSetter) (<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object,

486

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> iface,

487

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> name,

488

const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *value,

489

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> setter_data,

490

<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error);</pre>

503

<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> (*TpDBusPropertiesMixinSetter) (<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object</code>,

504

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> iface</code>,

505

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> name</code>,

506

<code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

507

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> setter_data</code>,

508

<code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

491

509

492

Signature of a callback used to get the value of a property.

510

Signature of a callback used to get the value of a property.

511

493

512

494

513

495

514

<tbody>

496

515

<tr>

497

516

<td><code>object</code> :</td>

498

<td> The exported object with the properties

517

<td>The exported object with the properties

499

518

</td>

500

519

</tr>

501

520

<tr>

502

521

<td><code>iface</code> :</td>

503

<td> A quark representing the D-Bus interface name

522

<td>A quark representing the D-Bus interface name

504

523

</td>

505

524

</tr>

506

525

<tr>

507

526

508

<td> A quark representing the D-Bus property name

527

<td>A quark representing the D-Bus property name

509

528

</td>

510

529

</tr>

511

530

<tr>

512

531

<td><code>value</code> :</td>

513

<td> The new value for the property

532

<td>The new value for the property

514

533

</td>

515

534

</tr>

516

535

<tr>

517

536

<td><code>setter_data</code> :</td>

518

<td> The setter_data from the <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropImpl" title="TpDBusPropertiesMixinPropImpl">TpDBusPropertiesMixinPropImpl</a>

537

<td>The setter_data from the <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropImpl" title="TpDBusPropertiesMixinPropImpl">TpDBusPropertiesMixinPropImpl</a>

519

538

</td>

520

539

</tr>

521

540

<tr>

522

541

<td><code>error</code> :</td>

523

<td> Used to return an error on failure

542

<td>Used to return an error on failure

524

543

</td>

525

544

</tr>

526

545

<tr>

527

546

<td>Returns :</td>

528

<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> (setting <code>error</code>) on failure

547

<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> (setting <code>error</code>) on failure

529

548

</td>

530

549

</tr>

531

550

</tbody>

534

553

<hr>

535

554

536

555

<a name="tp-dbus-properties-mixin-setter-gobject-properties"></a><h3>tp_dbus_properties_mixin_setter_gobject_properties ()</h3>

537

538

(<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object,

539

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> iface,

540

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> name,

541

const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *value,

542

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> setter_data,

543

<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error);</pre>

556

<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> tp_dbus_properties_mixin_setter_gobject_properties

557

(<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object</code>,

558

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> iface</code>,

559

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> name</code>,

560

<code>const <a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

561

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> setter_data</code>,

562

<code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

544

563

545

564

An implementation of <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinSetter" title="TpDBusPropertiesMixinSetter ()">TpDBusPropertiesMixinSetter</a> which assumes that the

546

<code>setter_data</code> is the name of a writable <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> property of an appropriate

547

type, and sets that property to the given value.

565

<code>setter_data</code> is the name of a writable <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> property of an appropriate

566

type, and sets that property to the given value.

567

548

568

549

569

550

570

<tbody>

551

571

<tr>

552

572

<td><code>object</code> :</td>

553

<td> The exported object with the properties

573

<td>The exported object with the properties

554

574

</td>

555

575

</tr>

556

576

<tr>

557

577

<td><code>iface</code> :</td>

558

<td> A quark representing the D-Bus interface name

578

<td>A quark representing the D-Bus interface name

559

579

</td>

560

580

</tr>

561

581

<tr>

562

582

563

<td> A quark representing the D-Bus property name

583

<td>A quark representing the D-Bus property name

564

584

</td>

565

585

</tr>

566

586

<tr>

567

587

<td><code>value</code> :</td>

568

<td> The new value for the property

588

<td>The new value for the property

569

589

</td>

570

590

</tr>

571

591

<tr>

572

592

<td><code>setter_data</code> :</td>

573

593

<td>The setter_data from the <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropImpl" title="TpDBusPropertiesMixinPropImpl">TpDBusPropertiesMixinPropImpl</a>,

574

594

which must be a string containing the GObject property's name

575

595

</td>

576

596

</tr>

577

597

<tr>

578

598

<td><code>error</code> :</td>

579

<td> Not used

599

<td>Not used

580

600

</td>

581

601

</tr>

582

602

<tr>

583

603

<td>Returns :</td>

584

604

585

605

</td>

586

606

</tr>

587

607

</tbody>

590

610

<hr>

591

611

592

612

<a name="tp-dbus-properties-mixin-class-init"></a><h3>tp_dbus_properties_mixin_class_init ()</h3>

593

<pre class="programlisting">void tp_dbus_properties_mixin_class_init (<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a> *cls,

594

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gsize">gsize</a> offset);</pre>

613

<pre class="programlisting">void tp_dbus_properties_mixin_class_init (<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a> *cls</code>,

614

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize">gsize</a> offset</code>);</pre>

595

615

596

616

Initialize the class <code>cls</code> to use the D-Bus Properties mixin.

597

617

The given struct member, of size sizeof(TpDBusPropertiesMixinClass),

605

625

606

626

Before calling this function, the array <code>interfaces</code> must have been

607

627

placed in the <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinClass" title="TpDBusPropertiesMixinClass">TpDBusPropertiesMixinClass</a> structure; if it would be empty,

608

it may instead be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

628

it may instead be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

609

629

610

630

611

631

This function should be called from the class_init callback in such a way

612

632

that it will only be called once, even if the class is subclassed.

613

633

614

634

615

Changed in 0.7.9: TpDBusPropertiesMixinClass::interfaces may now be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,

635

Changed in 0.7.9: TpDBusPropertiesMixinClass::interfaces may now be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,

616

636

which means that only interfaces whose properties are set up using

617

637

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-implement-interface" title="tp_dbus_properties_mixin_implement_interface ()"><code class="function">tp_dbus_properties_mixin_implement_interface()</code></a> will be used.

618

638

620

640

Changed in 0.7.15: <code>offset</code> may now be 0, in which case the

621

641

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinClass" title="TpDBusPropertiesMixinClass">TpDBusPropertiesMixinClass</a> can be omitted from <code>cls</code>. It is treated as if

622

642

it were present, but with all fields (including

623

TpDBusPropertiesMixinClass::interfaces) being <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, so only interfaces

643

TpDBusPropertiesMixinClass::interfaces) being <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, so only interfaces

624

644

whose properties are set using

625

645

646

626

647

627

648

628

649

<tbody>

629

650

<tr>

630

651

631

<td> a subclass of <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a>

652

<td>a subclass of <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a>

632

653

</td>

633

654

</tr>

634

655

<tr>

635

656

<td><code>offset</code> :</td>

636

<td> the offset within <code>cls</code> of a TpDBusPropertiesMixinClass structure

657

<td>the offset within <code>cls</code> of a TpDBusPropertiesMixinClass structure

637

658

</td>

638

659

</tr>

639

660

</tbody>

644

665

645

666

<a name="tp-dbus-properties-mixin-implement-interface"></a><h3>tp_dbus_properties_mixin_implement_interface ()</h3>

646

667

<pre class="programlisting">void tp_dbus_properties_mixin_implement_interface

647

(<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a> *cls,

648

<a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark">GQuark</a> iface,

649

650

651

668

(<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a> *cls</code>,

669

<code><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark">GQuark</a> iface</code>,

670

671

672

652

673

653

674

Declare that, in addition to any interfaces set in

654

675

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-class-init" title="tp_dbus_properties_mixin_class_init ()"><code class="function">tp_dbus_properties_mixin_class_init()</code></a>, the given class (and its subclasses)

674

695

interface, only the implementations from the subclass S will be used,

675

696

regardless of whether the implementations in C and/or S were set up by

676

697

this function or via the array <code>interfaces</code> in the

677

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinClass" title="TpDBusPropertiesMixinClass">TpDBusPropertiesMixinClass</a>.

698

<a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinClass" title="TpDBusPropertiesMixinClass">TpDBusPropertiesMixinClass</a>.

699

678

700

679

701

680

702

<tbody>

681

703

<tr>

682

704

683

<td> a subclass of <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a>

705

<td>a subclass of <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass">GObjectClass</a>

684

706

</td>

685

707

</tr>

686

708

<tr>

687

709

<td><code>iface</code> :</td>

688

<td> a quark representing the the name of the interface to implement

710

<td>a quark representing the the name of the interface to implement

689

711

</td>

690

712

</tr>

691

713

<tr>

692

714

<td><code>getter</code> :</td>

693

<td> a callback to get properties on this interface, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if they

715

<td>a callback to get properties on this interface, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if they

694

716

are all write-only

695

717

</td>

696

718

</tr>

697

719

<tr>

698

720

<td><code>setter</code> :</td>

699

<td> a callback to set properties on this interface, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if they

721

<td>a callback to set properties on this interface, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if they

700

722

are all read-only

701

723

</td>

702

724

</tr>

703

725

<tr>

704

726

<td><code>props</code> :</td>

705

<td> an array of <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropImpl" title="TpDBusPropertiesMixinPropImpl">TpDBusPropertiesMixinPropImpl</a> representing individual

706

properties, terminated by one with <code>name</code> == <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

727

<td>an array of <a class="link" href="telepathy-glib-dbus-properties-mixin.html#TpDBusPropertiesMixinPropImpl" title="TpDBusPropertiesMixinPropImpl">TpDBusPropertiesMixinPropImpl</a> representing individual

728

properties, terminated by one with <code>name</code> == <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>

707

729

</td>

708

730

</tr>

709

731

</tbody>

712

734

<hr>

713

735

714

736

<a name="tp-dbus-properties-mixin-iface-init"></a><h3>tp_dbus_properties_mixin_iface_init ()</h3>

715

<pre class="programlisting">void tp_dbus_properties_mixin_iface_init (<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> g_iface,

716

<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer">gpointer</a> iface_data);</pre>

737

<pre class="programlisting">void tp_dbus_properties_mixin_iface_init (<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> g_iface</code>,

738

<code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer">gpointer</a> iface_data</code>);</pre>

717

739

718

740

Declare that the DBus.Properties interface represented by <code>g_iface</code>

719

is implemented using this mixin.

741

is implemented using this mixin.

742

720

743

721

744

722

745

<tbody>

723

746

<tr>

724

747

<td><code>g_iface</code> :</td>

725

<td> a pointer to a <a class="link" href="telepathy-glib-svc-generic.html#TpSvcDBusPropertiesClass" title="TpSvcDBusPropertiesClass">TpSvcDBusPropertiesClass</a> structure

748

<td>a pointer to a <a class="link" href="telepathy-glib-svc-generic.html#TpSvcDBusPropertiesClass" title="TpSvcDBusPropertiesClass">TpSvcDBusPropertiesClass</a> structure

726

749

</td>

727

750

</tr>

728

751

<tr>

729

752

<td><code>iface_data</code> :</td>

730

<td> ignored

753

<td>ignored

731

754

</td>

732

755

</tr>

733

756

</tbody>

736

759

<hr>

737

760

738

761

<a name="tp-dbus-properties-mixin-get"></a><h3>tp_dbus_properties_mixin_get ()</h3>

739

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a> tp_dbus_properties_mixin_get (<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> *self,

740

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *interface_name,

741

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *property_name,

742

<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue">GValue</a> *value,

743

<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError">GError</a> **error);</pre>

762

<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> tp_dbus_properties_mixin_get (<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *self</code>,

763

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *interface_name</code>,

764

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *property_name</code>,

765

<code><a href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue">GValue</a> *value</code>,

766

<code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error</code>);</pre>

744

767

745

768

Initialize <code>value</code> with the type of the property <code>property_name</code> on

746

769

<code>interface_name</code>, and write the value of that property into it as if

748

771

749

772

750

773

If Get would return a D-Bus error, <code>value</code> remains unset and <code>error</code>

751

is filled in instead.

774

is filled in instead.

775

752

776

753

777

754

778

<tbody>

755

779

<tr>

756

780

757

<td> an object with this mixin

781

<td>an object with this mixin

758

782

</td>

759

783

</tr>

760

784

<tr>

761

785

<td><code>interface_name</code> :</td>

762

<td> a D-Bus interface name

786

<td>a D-Bus interface name

763

787

</td>

764

788

</tr>

765

789

<tr>

766

790

<td><code>property_name</code> :</td>

767

<td> a D-Bus property name

791

<td>a D-Bus property name

768

792

</td>

769

793

</tr>

770

794

<tr>

771

795

<td><code>value</code> :</td>

772

<td> an unset GValue (initialized to all zeroes)

796

<td>an unset GValue (initialized to all zeroes)

773

797

</td>

774

798

</tr>

775

799

<tr>

776

800

<td><code>error</code> :</td>

777

<td> used to return an error on failure

801

<td>used to return an error on failure

778

802

</td>

779

803

</tr>

780

804

<tr>

781

805

<td>Returns :</td>

782

<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> (filling <code>value</code>) on success, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> (setting <code>error</code>)

806

<td> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> (filling <code>value</code>) on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> (setting <code>error</code>)

783

807

on failure

784

808

</td>

785

809

</tr>

790

814

<hr>

791

815

792

816

<a name="tp-dbus-properties-mixin-make-properties-hash"></a><h3>tp_dbus_properties_mixin_make_properties_hash ()</h3>

793

<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable">GHashTable</a> * tp_dbus_properties_mixin_make_properties_hash

794

(<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object,

795

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *first_interface,

796

const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar">gchar</a> *first_property,

797

...);</pre>

817

<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable">GHashTable</a> * tp_dbus_properties_mixin_make_properties_hash

818

(<code><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> *object</code>,

819

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *first_interface</code>,

820

<code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar">gchar</a> *first_property</code>,

821

798

822

799

823

Retrieves the values of several D-Bus properties from an object, and builds

800

824

a hash mapping the fully-qualified name of the property to its value. This

801

825

is equivalent to calling <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-get" title="tp_dbus_properties_mixin_get ()"><code class="function">tp_dbus_properties_mixin_get()</code></a> for each property

802

826

and building the table yourself, with the proviso that this function will

803

<a href="http://library.gnome.org/devel/glib/unstable/glib-Testing.html#g-assert"><code class="function">g_assert()</code></a> if retrieving a property fails (for instance, because it does not

827

<a href="/usr/share/gtk-doc/html/glib/glib-Testing.html#g-assert"><code class="function">g_assert()</code></a> if retrieving a property fails (for instance, because it does not

804

828

exist).

805

829

806

830

807

831

Additional keys and values can be inserted into the returned hash table;

808

832

if this is done, the inserted keys and values will be freed when the

809

hash table is destroyed. The keys must be allocated with <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strdup"><code class="function">g_strdup()</code></a> or

833

hash table is destroyed. The keys must be allocated with <a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#g-strdup"><code class="function">g_strdup()</code></a> or

810

834

equivalent, and the values must be slice-allocated (for instance with

811

835

<a class="link" href="telepathy-glib-util.html#tp-g-value-slice-new-string" title="tp_g_value_slice_new_string ()"><code class="function">tp_g_value_slice_new_string()</code></a> or a similar function).

812

836

813

837

814

838

Note that in particular, <a class="link" href="telepathy-glib-asv.html#tp-asv-set-string" title="tp_asv_set_string ()"><code class="function">tp_asv_set_string()</code></a> and similar functions should

815

not be used with this hash table.

839

not be used with this hash table.

840

816

841

817

842

818

843

<tbody>

819

844

<tr>

820

845

<td><code>object</code> :</td>

821

<td> an object which uses the D-Bus properties mixin

846

<td>an object which uses the D-Bus properties mixin

822

847

</td>

823

848

</tr>

824

849

<tr>

825

850

<td><code>first_interface</code> :</td>

826

<td> the interface of the first property to be retrieved

851

<td>the interface of the first property to be retrieved

827

852

</td>

828

853

</tr>

829

854

<tr>

830

855

<td><code>first_property</code> :</td>

831

<td> the name of the first property to be retrieved

856

<td>the name of the first property to be retrieved

832

857

</td>

833

858

</tr>

834

859

<tr>

835

860

836

<td> more (interface name, property name) pairs, terminated by <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

861

<td>more (interface name, property name) pairs, terminated by <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.

837

862

</td>

838

863

</tr>

839

864

<tr>

854

879

</div>

855

880

856

881

<hr>

857

Generated by GTK-Doc V1.13</div>

882

Generated by GTK-Doc V1.14</div>

858

883

</body>

859

884

</html>

b'\\ No newline at end of file'

Older »