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 <!-- ##### MACRO G_TYPE_FUNDAMENTAL_SHIFT ##### -->
 126 <para>
 127 Shift value used in converting numbers to type IDs.
 128 </para>
 129
 130
 131 <!-- ##### FUNCTION g_closure_add_fnotify ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @closure:
 137 @notify_data:
 138 @notify_func:
 139
 140 <!-- ##### FUNCTION g_closure_add_inotify ##### -->
 141 <para>
 142
 143 </para>
 144
 145 @closure:
 146 @notify_data:
 147 @notify_func:
 148
 149 <!-- ##### FUNCTION g_closure_remove_fnotify ##### -->
 150 <para>
 151
 152 </para>
 153
 154 @closure:
 155 @notify_data:
 156 @notify_func:
 157
 158 <!-- ##### FUNCTION g_closure_remove_inotify ##### -->
 159 <para>
 160
 161 </para>
 162
 163 @closure:
 164 @notify_data:
 165 @notify_func:
 166
 167 <!-- ##### FUNCTION g_param_spec_closure ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @name:
 173 @nick:
 174 @blurb:
 175 @flags:
 176 @Returns:
 177
 178 <!-- ##### FUNCTION g_param_spec_string_c ##### -->
 179 <para>
 180
 181 </para>
 182
 183 @name:
 184 @nick:
 185 @blurb:
 186 @default_value:
 187 @flags:
 188 @Returns:
 189
 190 <!-- ##### FUNCTION g_signal_add_emission_hook_full ##### -->
 191 <para>
 192
 193 </para>
 194
 195 @signal_id:
 196 @closure:
 197 @Returns:
 198
 199 <!-- ##### MACRO g_signal_newc ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @Returns:
 205 @signal_name:
 206 @itype:
 207 @signal_flags:
 208 @class_offset:
 209 @accumulator:
 210 @accu_data:
 211 @c_marshaller:
 212 @return_type:
 213 @n_params:
 214 @Varargs:
 215
 216 <!-- ##### FUNCTION g_type_check_class_cast ##### -->
 217 <para>
 218 </para>
 219
 220 @g_class:
 221 @is_a_type:
 222 @Returns:
 223
 224 <!-- ##### FUNCTION g_type_check_flags ##### -->
 225 <para>
 226 Determines whether a given set of #GTypeFlags and #GTypeFundamentalFlags
 227 are set for @type.
 228 </para>
 229
 230 @type:    The type to check for flags.
 231 @flags:   Bitwise combination of #GTypeFlags and #GTypeFundamentalFlags.
 232 @Returns: #TRUE if all @flags are set for @type, #FALSE otherwise.
 233
 234 <!-- ##### FUNCTION g_type_check_instance ##### -->
 235 <para>
 236 Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE()
 237 macro.
 238 </para>
 239
 240 @instance: A valid #GTypeInstance structure.
 241 @Returns:  #TRUE if @instance is valid, #FALSE otherwise.
 242
 243 <!-- ##### FUNCTION g_type_check_instance_cast ##### -->
 244 <para>
 245 </para>
 246
 247 @instance:
 248 @iface_type:
 249 @Returns:
 250
 251 <!-- ##### FUNCTION g_type_check_value ##### -->
 252 <para>
 253 </para>
 254
 255 @value:
 256 @Returns:
 257
 258 <!-- ##### FUNCTION g_type_class_is_a ##### -->
 259 <para>
 260 </para>
 261
 262 @g_class:
 263 @is_a_type:
 264 @Returns:
 265
 266 <!-- ##### FUNCTION g_type_fundamental_last ##### -->
 267 <para>
 268
 269 </para>
 270
 271 @Returns:
 272
 273 <!-- ##### FUNCTION g_type_instance_is_a ##### -->
 274 <para>
 275 Determines if @instance adheres to the interface exported
 276 by @iface_type. @iface_type is either a type that @instance
 277 is derived from, or an interface type that is supported by
 278 the anchestry of @instance.
 279 </para>
 280
 281 @instance:      A valid #GTypeInstance structure.
 282 @iface_type:    A #GType value.
 283 @Returns:       #TRUE if @instance conforms to @iface_type, #FALSE otherwise.
 284
 285 <!-- ##### FUNCTION g_type_test_flags ##### -->
 286 <para>
 287
 288 </para>
 289
 290 @type:
 291 @flags:
 292 @Returns:
 293
 294 <!-- ##### FUNCTION g_type_value_is_a ##### -->
 295 <para>
 296 Determines if @value is a #GValue whose type conforms to @type.
 297 </para>
 298
 299 @value:           A valid #GValue structure.
 300 @type:    A #GType value.
 301 @Returns: #TRUE if @value is a #GValue of @type or #FALSE if not.
 302
 303 <!-- ##### FUNCTION g_value_convert ##### -->
 304 <para>
 305
 306 </para>
 307
 308 @src_value:
 309 @dest_value:
 310 @Returns:
 311
 312 <!-- ##### FUNCTION g_value_register_exchange_func ##### -->
 313 <para>
 314
 315 </para>
 316
 317 @value_type1:
 318 @value_type2:
 319 @func:
 320
 321 <!-- ##### FUNCTION g_value_types_exchangable ##### -->
 322 <para>
 323
 324 </para>
 325
 326 @value_type1:
 327 @value_type2:
 328 @Returns:
 329
 330 <!-- ##### FUNCTION g_values_exchange ##### -->
 331 <para>
 332
 333 </para>
 334
 335 @value1:
 336 @value2:
 337 @Returns:
 338