Pileus Git - ~andy/gtk/blob - docs/reference/gdk/tmpl/properties.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Properties and Atoms
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Functions to manipulate properties on windows
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 Each window under X can have any number of associated
  10 <firstterm>properties</firstterm> attached to it.
  11 Properties are arbitrary chunks of data identified by
  12 <firstterm>atom</firstterm>s. (An <firstterm>atom</firstterm>
  13 is a numeric index into a string table on the X server. They are used
  14 to transfer strings efficiently between clients without
  15 having to transfer the entire string.) A property
  16 has an associated type, which is also identified
  17 using an atom.
  18 </para>
  19 <para>
  20 A property has an associated <firstterm>format</firstterm>,
  21 an integer describing how many bits are in each unit
  22 of data inside the property. It must be 8, 16, or 32.
  23 When data is transferred between the server and client,
  24 if they are of different endianesses it will be byteswapped
  25 as necessary according to the format of the property.
  26 Note that on the client side, properties of format 32
  27 will be stored with one unit per <emphasis>long</emphasis>,
  28 even if a long integer has more than 32 bits on the platform.
  29 (This decision was apparently made for Xlib to maintain
  30 compatibility with programs that assumed longs were 32
  31 bits, at the expense of programs that knew better.)
  32 </para>
  33 <para>
  34 The functions in this section are used to add, remove
  35 and change properties on windows, to convert atoms
  36 to and from strings and to manipulate some types of
  37 data commonly stored in X window properties.
  38 </para>
  39
  40 <!-- ##### SECTION See_Also ##### -->
  41 <para>
  42
  43 </para>
  44
  45 <!-- ##### SECTION Stability_Level ##### -->
  46
  47
  48 <!-- ##### STRUCT GdkAtom ##### -->
  49 <para>
  50 An opaque type representing a string as an index into a table
  51 of strings on the X server.
  52 </para>
  53
  54
  55 <!-- ##### MACRO GDK_ATOM_TO_POINTER ##### -->
  56 <para>
  57 Converts a #GdkAtom into a pointer type.
  58 </para>
  59
  60 @atom: a #GdkAtom.
  61
  62
  63 <!-- ##### MACRO GDK_POINTER_TO_ATOM ##### -->
  64 <para>
  65 Extracts a #GdkAtom from a pointer. The #GdkAtom must have been
  66 stored in the pointer with GDK_ATOM_TO_POINTER().
  67 </para>
  68
  69 @ptr: a pointer containing a #GdkAtom.
  70
  71
  72 <!-- ##### MACRO GDK_NONE ##### -->
  73 <para>
  74 A null value for #GdkAtom, used in a similar way as <literal>None</literal>
  75 in the Xlib API.
  76 </para>
  77
  78
  79
  80 <!-- ##### FUNCTION gdk_text_property_to_text_list ##### -->
  81 <para>
  82 Converts a text string from the encoding as it is stored in
  83 a property into an array of strings in the encoding of
  84 the current local. (The elements of the array represent
  85 the nul-separated elements of the original text string.)
  86 </para>
  87
  88 @encoding: an atom representing the encoding. The most common
  89            values for this are <literal>STRING</literal>,
  90            or <literal>COMPOUND_TEXT</literal>. This is
  91            value used as the type for the property.
  92 @format: the format of the property.
  93 @text: the text data.
  94 @length: the length of the property, in items.
  95 @list: location to store a terminated array of strings
  96        in the encoding of the current locale. This
  97        array should be freed using gdk_free_text_list().
  98 @Returns: the number of strings stored in @list, or 0,
  99           if the conversion failed.
 100
 101
 102 <!-- ##### FUNCTION gdk_text_property_to_text_list_for_display ##### -->
 103 <para>
 104
 105 </para>
 106
 107 @display:
 108 @encoding:
 109 @format:
 110 @text:
 111 @length:
 112 @list:
 113 @Returns:
 114
 115
 116 <!-- ##### FUNCTION gdk_free_text_list ##### -->
 117 <para>
 118 Frees the array of strings created by
 119 gdk_text_property_to_text_list().
 120 </para>
 121
 122 @list: the value stored in the @list parameter by
 123        a call to gdk_text_property_to_text_list().
 124
 125
 126 <!-- ##### FUNCTION gdk_text_property_to_utf8_list ##### -->
 127 <para>
 128
 129 </para>
 130
 131 @encoding:
 132 @format:
 133 @text:
 134 @length:
 135 @list:
 136 @Returns:
 137
 138
 139 <!-- ##### FUNCTION gdk_text_property_to_utf8_list_for_display ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @display:
 145 @encoding:
 146 @format:
 147 @text:
 148 @length:
 149 @list:
 150 @Returns:
 151
 152
 153 <!-- ##### FUNCTION gdk_string_to_compound_text ##### -->
 154 <para>
 155 Converts a string from the encoding of the current locale
 156 into a form suitable for storing in a window property.
 157 </para>
 158
 159 @str: a nul-terminated string.
 160 @encoding: location to store the encoding atom (to be used as the type for the property).
 161 @format: location to store the format for the property.
 162 @ctext: location to store newly allocated data for the property.
 163 @length: location to store the length of @ctext in items.
 164 @Returns: 0 upon sucess, non-zero upon failure.
 165
 166
 167 <!-- ##### FUNCTION gdk_string_to_compound_text_for_display ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @display:
 173 @str:
 174 @encoding:
 175 @format:
 176 @ctext:
 177 @length:
 178 @Returns:
 179
 180
 181 <!-- ##### FUNCTION gdk_free_compound_text ##### -->
 182 <para>
 183 Frees the data returned from gdk_string_to_compound_text().
 184 </para>
 185
 186 @ctext: The pointer stored in @ctext from a call to gdk_string_to_compound_text().
 187
 188
 189 <!-- ##### FUNCTION gdk_utf8_to_string_target ##### -->
 190 <para>
 191
 192 </para>
 193
 194 @str:
 195 @Returns:
 196
 197
 198 <!-- ##### FUNCTION gdk_utf8_to_compound_text ##### -->
 199 <para>
 200
 201 </para>
 202
 203 @str:
 204 @encoding:
 205 @format:
 206 @ctext:
 207 @length:
 208 @Returns:
 209
 210
 211 <!-- ##### FUNCTION gdk_utf8_to_compound_text_for_display ##### -->
 212 <para>
 213
 214 </para>
 215
 216 @display:
 217 @str:
 218 @encoding:
 219 @format:
 220 @ctext:
 221 @length:
 222 @Returns:
 223
 224
 225 <!-- ##### FUNCTION gdk_atom_intern ##### -->
 226 <para>
 227 Finds or creates an atom corresponding to a given string.
 228 </para>
 229
 230 @atom_name: a string.
 231 @only_if_exists: if %TRUE, GDK is allowed to not create a new atom, but
 232                  just return %GDK_NONE if the requested atom doesn't already
 233                  exists. Currently, the flag is ignored, since checking the
 234                  existance of an atom is as expensive as creating it.
 235 @Returns: the atom corresponding to @atom_name.
 236
 237
 238 <!-- ##### FUNCTION gdk_atom_intern_static_string ##### -->
 239 <para>
 240
 241 </para>
 242
 243 @atom_name:
 244 @Returns:
 245
 246
 247 <!-- ##### FUNCTION gdk_atom_name ##### -->
 248 <para>
 249 Determines the string corresponding to an atom.
 250 </para>
 251
 252 @atom: a #GdkAtom.
 253 @Returns: a newly-allocated string containing the string
 254           corresponding to @atom. When you are done
 255           with the return value, you should free it
 256           using g_free().
 257
 258
 259 <!-- ##### FUNCTION gdk_property_get ##### -->
 260 <para>
 261 Retrieves a portion of the contents of a property. If the
 262 property does not exist, then the function returns %FALSE,
 263 and %GDK_NONE will be stored in @actual_property_type.
 264 </para>
 265 <note>
 266 <para>
 267 The XGetWindowProperty() function that gdk_property_get()
 268 uses has a very confusing and complicated set of semantics.
 269 Unfortunately, gdk_property_get() makes the situation
 270 worse instead of better (the semantics should be considered
 271 undefined), and also prints warnings to stderr in cases where it
 272 should return a useful error to the program. You are advised to use
 273 XGetWindowProperty() directly until a replacement function for
 274 gdk_property_get()
 275 is provided.
 276 </para>
 277 </note>
 278
 279 @window: a #GdkWindow.
 280 @property: the property to retrieve.
 281 @type: the desired property type, or %GDK_NONE, if any type of data
 282        is acceptable. If this does not match the actual
 283        type, then @actual_format and @actual_length will
 284        be filled in, a warning will be printed to stderr
 285        and no data will be returned.
 286 @offset: the offset into the property at which to begin
 287          retrieving data, in 4 byte units.
 288 @length: the length of the data to retrieve in bytes.  Data is
 289          considered to be retrieved in 4 byte chunks, so @length
 290          will be rounded up to the next highest 4 byte boundary
 291          (so be careful not to pass a value that might overflow
 292           when rounded up).
 293 @pdelete: if %TRUE, delete the property after retrieving the
 294           data.
 295 @actual_property_type: location to store the actual type of
 296                        the property.
 297 @actual_format: location to store the actual return format of the
 298                 data; either 8, 16 or 32 bits.
 299 @actual_length: location to store the length of the retrieved data, in
 300                 bytes.  Data returned in the 32 bit format is stored
 301                 in a long variable, so the actual number of 32 bit
 302                 elements should be be calculated via
 303                 @actual_length/sizeof(glong) to ensure portability to
 304                 64 bit systems.
 305 @data: location to store a pointer to the data. The retrieved
 306        data should be freed with g_free() when you are finished
 307        using it.
 308 @Returns: %TRUE if data was successfully received and stored
 309           in @data, otherwise %FALSE.
 310
 311
 312 <!-- ##### FUNCTION gdk_property_change ##### -->
 313 <para>
 314 Changes the contents of a property on a window.
 315 </para>
 316
 317 @window: a #GdkWindow.
 318 @property: the property to change.
 319 @type: the new type for the property. If @mode is
 320        %GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this
 321        must match the existing type or an error will occur.
 322 @format: the new format for the property. If @mode is
 323          %GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this
 324          must match the existing format or an error will occur.
 325 @mode: a value describing how the new data is to be combined
 326        with the current data.
 327 @data: the data
 328        (a <literal>guchar *</literal>
 329         <literal>gushort *</literal>, or
 330         <literal>gulong *</literal>, depending on @format), cast to a
 331         <literal>guchar *</literal>.
 332 @nelements: the number of elements of size determined by the format,
 333             contained in @data.
 334
 335
 336 <!-- ##### ENUM GdkPropMode ##### -->
 337 <para>
 338 Describes how existing data is combined with new data when
 339 using gdk_property_change().
 340 </para>
 341
 342 @GDK_PROP_MODE_REPLACE: the new data replaces the existing data.
 343 @GDK_PROP_MODE_PREPEND: the new data is prepended to the existing data.
 344 @GDK_PROP_MODE_APPEND: the new data is appended to the existing data.
 345
 346 <!-- ##### FUNCTION gdk_property_delete ##### -->
 347 <para>
 348 Deletes a property from a window.
 349 </para>
 350
 351 @window: a #GdkWindow.
 352 @property: the property to delete.
 353
 354