docs/reference/gobject/tmpl/gobject-unused.sgml

   1 <!-- ##### SECTION ./tmpl/param_specs.sgml:Long_Description ##### -->
   2 <para>
   3
   4 </para>
   5
   6
   7 <!-- ##### SECTION ./tmpl/param_specs.sgml:See_Also ##### -->
   8 <para>
   9
  10 </para>
  11
  12
  13 <!-- ##### SECTION ./tmpl/param_specs.sgml:Short_Description ##### -->
  14
  15
  16
  17 <!-- ##### SECTION ./tmpl/param_specs.sgml:Title ##### -->
  18 Parameter Specifications
  19
  20
  21 <!-- ##### STRUCT GBoxed ##### -->
  22 <para>
  23
  24 </para>
  25
  26
  27 <!-- ##### USER_FUNCTION GBoxedInitFunc ##### -->
  28 <para>
  29
  30 </para>
  31
  32 @Returns:
  33
  34 <!-- ##### STRUCT GObjectConstructParam ##### -->
  35 <para>
  36
  37 </para>
  38
  39 @pspec:
  40 @value:
  41
  42 <!-- ##### STRUCT GParamSpecClosure ##### -->
  43 <para>
  44
  45 </para>
  46
  47 @parent_instance:
  48
  49 <!-- ##### ENUM GTypeFundamentals ##### -->
  50 <para>
  51 The predefined identifiers of the reserved fundamental types.
  52 </para>
  53
  54 @G_TYPE_INVALID:                Usually a return value indicating an error.
  55 @G_TYPE_NONE:                   A synonym for the "void" type in C.
  56 @G_TYPE_INTERFACE:              Root type of all interface types.
  57 @G_TYPE_CHAR:                   Identifier for the built-in type "gchar".
  58 @G_TYPE_UCHAR:                  Identifier for the built-in type "guchar".
  59 @G_TYPE_BOOLEAN:                Identifier for the built-in type "gboolean".
  60 @G_TYPE_INT:                    Identifier for the built-in type "gint".
  61 @G_TYPE_UINT:                   Identifier for the built-in type "guint".
  62 @G_TYPE_LONG:                   Identifier for the built-in type "glong".
  63 @G_TYPE_ULONG:                  Identifier for the built-in type "gulong".
  64 @G_TYPE_INT64:
  65 @G_TYPE_UINT64:
  66 @G_TYPE_ENUM:                   Identifier for the "#GEnum" type.
  67 @G_TYPE_FLAGS:                  Identifier for the "#GFlags" type.
  68 @G_TYPE_FLOAT:                  Identifier for the built-in type "gfloat".
  69 @G_TYPE_DOUBLE:                 Identifier for the built-in type "gdouble".
  70 @G_TYPE_STRING:                 Identifier for a pointer to a null-terminated string "gchar*".
  71 @G_TYPE_POINTER:                Identifier for anonymous pointers "void*".
  72 @G_TYPE_BOXED:                  Identifier for the "#GBoxed" type.
  73 @G_TYPE_PARAM:                  Identifier for the "#GParam" type.
  74 @G_TYPE_OBJECT:                 Identifier for the "#GObject" type.
  75 @G_TYPE_RESERVED_BSE_FIRST:     First fundamental type ID reserved for BSE.
  76 @G_TYPE_RESERVED_BSE_LAST:      Last fundamental type ID reserved for BSE.
  77 @G_TYPE_RESERVED_LAST_FUNDAMENTAL:
  78 @G_TYPE_CONSTANT_TYPES:
  79 @G_TYPE_CLOSURE:
  80 @G_TYPE_VALUE:
  81 @G_TYPE_VALUE_ARRAY:
  82 @G_TYPE_GSTRING:
  83 @G_TYPE_PARAM_CHAR:
  84 @G_TYPE_PARAM_UCHAR:
  85 @G_TYPE_PARAM_BOOLEAN:
  86 @G_TYPE_PARAM_INT:
  87 @G_TYPE_PARAM_UINT:
  88 @G_TYPE_PARAM_LONG:
  89 @G_TYPE_PARAM_ULONG:
  90 @G_TYPE_PARAM_INT64:
  91 @G_TYPE_PARAM_UINT64:
  92 @G_TYPE_PARAM_UNICHAR:
  93 @G_TYPE_PARAM_ENUM:
  94 @G_TYPE_PARAM_FLAGS:
  95 @G_TYPE_PARAM_FLOAT:
  96 @G_TYPE_PARAM_DOUBLE:
  97 @G_TYPE_PARAM_STRING:
  98 @G_TYPE_PARAM_PARAM:
  99 @G_TYPE_PARAM_BOXED:
 100 @G_TYPE_PARAM_POINTER:
 101 @G_TYPE_PARAM_VALUE_ARRAY:
 102 @G_TYPE_PARAM_CLOSURE:
 103 @G_TYPE_PARAM_OBJECT:
 104
 105 <!-- ##### MACRO G_IS_PARAM_SPEC_CLOSURE ##### -->
 106 <para>
 107
 108 </para>
 109
 110 @pspec:
 111
 112 <!-- ##### MACRO G_PARAM_SPEC_CLOSURE ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @pspec:
 118
 119 <!-- ##### MACRO G_TYPE_FUNDAMENTAL_LAST ##### -->
 120 <para>
 121
 122 </para>
 123
 124
 125 <!-- ##### FUNCTION g_closure_add_fnotify ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @closure:
 131 @notify_data:
 132 @notify_func:
 133
 134 <!-- ##### FUNCTION g_closure_add_inotify ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @closure:
 140 @notify_data:
 141 @notify_func:
 142
 143 <!-- ##### FUNCTION g_closure_remove_fnotify ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @closure:
 149 @notify_data:
 150 @notify_func:
 151
 152 <!-- ##### FUNCTION g_closure_remove_inotify ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @closure:
 158 @notify_data:
 159 @notify_func:
 160
 161 <!-- ##### FUNCTION g_param_spec_closure ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @name:
 167 @nick:
 168 @blurb:
 169 @flags:
 170 @Returns:
 171
 172 <!-- ##### FUNCTION g_param_spec_string_c ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @name:
 178 @nick:
 179 @blurb:
 180 @default_value:
 181 @flags:
 182 @Returns:
 183
 184 <!-- ##### FUNCTION g_signal_add_emission_hook_full ##### -->
 185 <para>
 186
 187 </para>
 188
 189 @signal_id:
 190 @closure:
 191 @Returns:
 192
 193 <!-- ##### MACRO g_signal_newc ##### -->
 194 <para>
 195
 196 </para>
 197
 198 @Returns:
 199 @signal_name:
 200 @itype:
 201 @signal_flags:
 202 @class_offset:
 203 @accumulator:
 204 @accu_data:
 205 @c_marshaller:
 206 @return_type:
 207 @n_params:
 208 @Varargs:
 209
 210 <!-- ##### FUNCTION g_type_check_class_cast ##### -->
 211 <para>
 212 </para>
 213
 214 @g_class:
 215 @is_a_type:
 216 @Returns:
 217
 218 <!-- ##### FUNCTION g_type_check_flags ##### -->
 219 <para>
 220 Determines whether a given set of #GTypeFlags and #GTypeFundamentalFlags
 221 are set for @type.
 222 </para>
 223
 224 @type:    The type to check for flags.
 225 @flags:   Bitwise combination of #GTypeFlags and #GTypeFundamentalFlags.
 226 @Returns: #TRUE if all @flags are set for @type, #FALSE otherwise.
 227
 228 <!-- ##### FUNCTION g_type_check_instance ##### -->
 229 <para>
 230 Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE()
 231 macro.
 232 </para>
 233
 234 @instance: A valid #GTypeInstance structure.
 235 @Returns:  #TRUE if @instance is valid, #FALSE otherwise.
 236
 237 <!-- ##### FUNCTION g_type_check_instance_cast ##### -->
 238 <para>
 239 </para>
 240
 241 @instance:
 242 @iface_type:
 243 @Returns:
 244
 245 <!-- ##### FUNCTION g_type_check_value ##### -->
 246 <para>
 247 </para>
 248
 249 @value:
 250 @Returns:
 251
 252 <!-- ##### FUNCTION g_type_class_is_a ##### -->
 253 <para>
 254 </para>
 255
 256 @g_class:
 257 @is_a_type:
 258 @Returns:
 259
 260 <!-- ##### FUNCTION g_type_fundamental_last ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @Returns:
 266
 267 <!-- ##### FUNCTION g_type_instance_is_a ##### -->
 268 <para>
 269 Determines if @instance adheres to the interface exported
 270 by @iface_type. @iface_type is either a type that @instance
 271 is derived from, or an interface type that is supported by
 272 the anchestry of @instance.
 273 </para>
 274
 275 @instance:      A valid #GTypeInstance structure.
 276 @iface_type:    A #GType value.
 277 @Returns:       #TRUE if @instance conforms to @iface_type, #FALSE otherwise.
 278
 279 <!-- ##### FUNCTION g_type_test_flags ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @type:
 285 @flags:
 286 @Returns:
 287
 288 <!-- ##### FUNCTION g_type_value_is_a ##### -->
 289 <para>
 290 Determines if @value is a #GValue whose type conforms to @type.
 291 </para>
 292
 293 @value:           A valid #GValue structure.
 294 @type:    A #GType value.
 295 @Returns: #TRUE if @value is a #GValue of @type or #FALSE if not.
 296
 297 <!-- ##### FUNCTION g_value_convert ##### -->
 298 <para>
 299
 300 </para>
 301
 302 @src_value:
 303 @dest_value:
 304 @Returns:
 305
 306 <!-- ##### FUNCTION g_value_register_exchange_func ##### -->
 307 <para>
 308
 309 </para>
 310
 311 @value_type1:
 312 @value_type2:
 313 @func:
 314
 315 <!-- ##### FUNCTION g_value_types_exchangable ##### -->
 316 <para>
 317
 318 </para>
 319
 320 @value_type1:
 321 @value_type2:
 322 @Returns:
 323
 324 <!-- ##### FUNCTION g_values_exchange ##### -->
 325 <para>
 326
 327 </para>
 328
 329 @value1:
 330 @value2:
 331 @Returns:
 332