]> Pileus Git - ~andy/gtk/blob - README.in
New function; it lets us time the expose sequence of a widget.
[~andy/gtk] / README.in
1 General Information
2 ===================
3
4 This is GTK+ version @GTK_VERSION@. GTK+ is a multi-platform toolkit for
5 creating graphical user interfaces. Offering a complete set of widgets,
6 GTK+ is suitable for projects ranging from small one-off projects to
7 complete application suites.
8
9 GTK+ is free software and part of the GNU Project. However, the
10 licensing terms for GTK+, the GNU LGPL, allow it to be used by all
11 developers, including those developing proprietary software, without any
12 license fees or royalties.
13
14 The official ftp site is:
15   ftp://ftp.gtk.org/pub/gtk
16
17 The official web site is:
18   http://www.gtk.org/
19
20 Information about mailing lists can be found at
21   http://www.gtk.org/mailinglists.html
22
23 Installation
24 ============
25
26 See the file 'INSTALL'
27
28 Release notes for 2.10
29 ======================
30
31 * The hexadecimal Unicode input feature has been reworked. It no longer
32   blocks the use of the sixteen Ctrl-Shift-<hex digit> key sequences. Now
33   it only uses Ctrl-Shift-u.
34
35 * A memory leak in GtkStyle handling has been fixed. This may expose bugs
36   in third-party widgets which forget to call gtk_style_attach() in their
37   realize functions.
38
39 * Range widgets like GtkScrollbar now render their arrows insensitive
40   when the slider is at the end. Applications which react to arrow
41   clicks even if the slider is at the end may want to use the new
42   gtk_range_set_[upper/lower]_stepper_sensitivity() functions to
43   prevent the arrows from being rendered insensitive.
44
45 * GtkObject now uses the "floating reference" support in GObject. 
46   GTK_OBJECT_IS_FLOATING() will still work, but direct checking
47   of the GTK_FLOATING flag will no longer detect the floating 
48   reference. Details about floating references can be found in the docs:
49   http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#floating-ref
50
51 * Suffixes like (_F) are now stripped from labels when they are displayed
52   in toolbars. If this is not wanted, the feature can be suppressed by 
53   inserting a Unicode control character, e.g ZWNJ.
54
55 * The pixbuf theme engine can now customize expanders (in GtkTreeView
56   and GtkExpander) and resize grips, using the new EXPANDER and
57   RESIZE_GRIP function values.
58
59 * Dialogs created by gtk_about_dialog_new no longer hide automatically
60   when the user clicks close. It is the applications responsibility to
61   hide or destroy the dialog.
62
63 * Several new signals have been added to GtkNotebook. Care has been taken
64   to choose signal names which do not collide with signals added by well-known
65   derived classes. The names which can no longer be used for signals in 
66   objects derived from GtkNotebook are page-reordered, page-removed and
67   page-added.
68
69 Release notes
70 =============
71
72 * GTK+ 2.6 supports clipboard persistency. To make use of this feature,
73   a clipboard manager following the specification at
74   http://www.freedesktop.org/wiki/Standards/clipboard-manager-spec
75   must be running. A sample implementation of such a clipboard manager
76   is available at 
77   http://people.imendio.com/andersca/archives/clipboard-manager-0.3.tar.gz
78   Applications can use the function gdk_display_supports_clipboard_persistence() 
79   to find out if clipboard persistence is available.
80
81 * Notification on clipboard ownership changes via GdkOwnerChange events 
82   requires the XFIXES X extension. Applications can use the function
83   gdk_display_supports_selection_notification() to find out if ownerchip
84   change notification is available.
85
86 * The icon theme code in GTK+ 2.6 follows the freedesktop.org icon theme 
87   specification. Setting the XDG_DATA_DIRS environtment variable may be 
88   necessary if your icons aren't installed in the default location 
89   /usr/share/icons.
90
91 * The icon theme code in GTK+ 2.6 can make use of mmap()able cache files
92   to avoid a lot of disk searching overhead. GTK+ includes a utility named
93   gtk-update-icon-cache to generate these cache files. For further details,
94   see the gtk-update-icon-cache man page or the GTK+ documentation.
95
96 * To reduce code size and improve efficiency, GTK+, when compiled 
97   with the GNU toolchain, has separate internal and external entry 
98   points for exported functions. The internal names, which begin with 
99   IA__, may be seen when debugging a GTK+ program.
100
101 * The following functions have been deprecated in GTK+ 2.6:
102   gdk_pango_context_set_colormap
103   gtk_cell_renderer_editing_canceled
104
105 * The new GtkFileChooser widget emphasizes simplicity and thus does 
106   not provide a navigation entry by default when opening files. 
107   Experienced command line users will likely want to make heavy use of
108   the location dialog brought up by the Control-L key shortcut.
109
110 * The GTK+ libraries use an '_' prefix to indicate private symbols that
111   must not be used by applications. On some platforms, symbols beginning 
112   with prefixes such as _gtk, _gdk, and _pango will be exported
113   from the library, on others not. In no case can applications
114   use these private symbols. In addition to that, GTK+ 2.6 makes several
115   symbols private which were not in any installed header files and
116   were never intended to be exported.
117
118 * The gdk_pixbuf_xlib library included in the contrib/ directory 
119   and the framebuffer GDK backend included in the gdk/linux-fb directory
120   of GTK+ are provided on an as-is basis and have not been tested at all. 
121   No guarantees about the degree of workingness or about future
122   compatibility are provided.
123
124 * On Unix, the assumption of GLib and GTK+ by default is that filenames on 
125   the filesystem are encoded in UTF-8 rather than the encoding of the locale;
126   the GTK+ developers consider that having filenames whose interpretation
127   depends on the current locale is fundamentally a bad idea.
128
129   If you have filenames encoded in the encoding of your locale, then you 
130   may want to set the G_FILENAME_ENCODING environment variable:
131   
132    G_FILENAME_ENCODING=@locale
133    export G_FILENAME_ENCODING
134
135   (Earlier versions of GLib 2.x required a different environment variable
136   setting; G_BROKEN_FILENAMES=1 to achieve the same effect; this 
137   is still supported, but G_FILENAME_ENCODING is preferred.)
138   Best integration of GTK+ 2.6 with the environment is achieved by 
139   using a UTF-8 locale.
140
141   On Windows, filenames passed to GTK+ should always be in UTF-8, as
142   in GLib 2.6. This is different than in previous versions of GTK+
143   where the system codepage was used. As in GLib, for DLL ABI
144   stability, applications built against previous versions of GTK+ will
145   use entry points providing the old semantics.
146
147   When compiling against GTK+ 2.6, applications intended to be
148   portable to Windows must take the UTF-8 file name encoding into
149   consideration, and use the gstdio wrappers to access files whose 
150   names have been constructed from strings returned from GTK+ or GLib.
151
152 How to report bugs
153 ==================
154
155 Bugs should be reported to the GNOME bug tracking system.
156 (http://bugzilla.gnome.org, product gtk+.) You will need to create an
157 account for yourself.
158   
159 In the bug report please include:
160   
161 * Information about your system. For instance:
162
163    - What operating system and version
164    - What version of X
165    - For Linux, what version of the C library
166
167   And anything else you think is relevant.
168
169 * How to reproduce the bug. 
170
171   If you can reproduce it with one of the tests or demos built with GTK+, 
172   such as demos/gtk-demo/gtk-demo, that would be most convenient. Otherwise, 
173   please include a short test program that exhibits the behavior. As a 
174   last resort, you can also provide a pointer to a larger piece of software 
175   that can be downloaded.
176
177 * If the bug was a crash, the exact text that was printed out when the
178   crash occured.
179
180 * Further information such as stack traces may be useful, but is not
181   necessary. If you do send a stack trace, and the error is an X error,
182   it will be more useful if the stacktrace is produced running the test
183   program with the --sync command line option.
184
185 Patches
186 =======
187
188 Patches should also be submitted to bugzilla.gnome.org. If the patch
189 fixes an existing bug, add the patch as an attachment to that bug
190 report.
191
192 Otherwise, enter a new bug report that describes the patch, and attach
193 the patch to that bug report.
194
195 Bug reports containing patches should include the PATCH keyword in their
196 keyword fields. If the patch adds to or changes the GTK+ programming
197 interface, the API keyword should also be included.
198   
199 Patches should be in unified diff form. (The -u option to GNU diff.)