]> Pileus Git - ~andy/gtk/blob - gdk/gdkproperty.h
docs: Move documentation to inline comments: properties
[~andy/gtk] / gdk / gdkproperty.h
1 /* GDK - The GIMP Drawing Kit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22  * file for a list of people on the GTK+ Team.  See the ChangeLog
23  * files for a list of changes.  These files are distributed with
24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25  */
26
27 #if !defined (__GDK_H_INSIDE__) && !defined (GDK_COMPILATION)
28 #error "Only <gdk/gdk.h> can be included directly."
29 #endif
30
31 #ifndef __GDK_PROPERTY_H__
32 #define __GDK_PROPERTY_H__
33
34 #include <gdk/gdktypes.h>
35
36 G_BEGIN_DECLS
37
38
39 /**
40  * GdkPropMode:
41  * @GDK_PROP_MODE_REPLACE: the new data replaces the existing data.
42  * @GDK_PROP_MODE_PREPEND: the new data is prepended to the existing data.
43  * @GDK_PROP_MODE_APPEND: the new data is appended to the existing data.
44  *
45  * Describes how existing data is combined with new data when
46  * using gdk_property_change().
47  */
48 typedef enum
49 {
50   GDK_PROP_MODE_REPLACE,
51   GDK_PROP_MODE_PREPEND,
52   GDK_PROP_MODE_APPEND
53 } GdkPropMode;
54
55
56 GdkAtom gdk_atom_intern (const gchar *atom_name,
57                          gboolean     only_if_exists);
58 GdkAtom gdk_atom_intern_static_string (const gchar *atom_name);
59 gchar*  gdk_atom_name   (GdkAtom      atom);
60
61
62 gboolean gdk_property_get    (GdkWindow     *window,
63                               GdkAtom        property,
64                               GdkAtom        type,
65                               gulong         offset,
66                               gulong         length,
67                               gint           pdelete,
68                               GdkAtom       *actual_property_type,
69                               gint          *actual_format,
70                               gint          *actual_length,
71                               guchar       **data);
72 void     gdk_property_change (GdkWindow     *window,
73                               GdkAtom        property,
74                               GdkAtom        type,
75                               gint           format,
76                               GdkPropMode    mode,
77                               const guchar  *data,
78                               gint           nelements);
79 void     gdk_property_delete (GdkWindow     *window,
80                               GdkAtom        property);
81
82 #ifndef GDK_MULTIHEAD_SAFE
83 gint gdk_text_property_to_text_list (GdkAtom        encoding,
84                                      gint           format,
85                                      const guchar  *text,
86                                      gint           length,
87                                      gchar       ***list);
88 gint gdk_text_property_to_utf8_list (GdkAtom        encoding,
89                                      gint           format,
90                                      const guchar  *text,
91                                      gint           length,
92                                      gchar       ***list);
93 gboolean gdk_utf8_to_compound_text (const gchar *str,
94                                     GdkAtom     *encoding,
95                                     gint        *format,
96                                     guchar     **ctext,
97                                     gint        *length);
98 gint gdk_string_to_compound_text    (const gchar   *str,
99                                      GdkAtom       *encoding,
100                                      gint          *format,
101                                      guchar       **ctext,
102                                      gint          *length);
103 #endif /* GDK_MULTIHEAD_SAFE */
104
105 gint gdk_text_property_to_text_list_for_display (GdkDisplay     *display,
106                                                  GdkAtom         encoding,
107                                                  gint            format,
108                                                  const guchar   *text,
109                                                  gint            length,
110                                                  gchar        ***list);
111 gint gdk_text_property_to_utf8_list_for_display (GdkDisplay     *display,
112                                                  GdkAtom         encoding,
113                                                  gint            format,
114                                                  const guchar   *text,
115                                                  gint            length,
116                                                  gchar        ***list);
117   
118 gchar   *gdk_utf8_to_string_target   (const gchar *str);
119 gint     gdk_string_to_compound_text_for_display (GdkDisplay   *display,
120                                                   const gchar  *str,
121                                                   GdkAtom      *encoding,
122                                                   gint         *format,
123                                                   guchar      **ctext,
124                                                   gint         *length);
125 gboolean gdk_utf8_to_compound_text_for_display   (GdkDisplay   *display,
126                                                   const gchar  *str,
127                                                   GdkAtom      *encoding,
128                                                   gint         *format,
129                                                   guchar      **ctext,
130                                                   gint         *length);
131
132 void gdk_free_text_list             (gchar        **list);
133 void gdk_free_compound_text         (guchar        *ctext);
134
135 G_END_DECLS
136
137 #endif /* __GDK_PROPERTY_H__ */