]> Pileus Git - ~andy/gtk/blob - README.in
2.11.0
[~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
24 Installation
25 ============
26
27 See the file 'INSTALL'
28
29
30 Release notes for 2.12
31 ======================
32
33 * Functions: gtk_about_dialog_get/set_name() were deprecated in favour of
34   gtk_about_dialog_get/set_program_name(), the GtkAboutDialog now uses the
35   "program-name" property instead of the conflicting "name" property.
36
37 * The tiff loader now requires libtiff 3.6.0 or later.
38
39 * Support for Windows 9x/ME has officially been removed. It hasn't worked
40   since 2.6 anyway.
41
42 * The GtkTextBufferTargetInfo enumeration values have been changed from
43   G_MAXUINT-0, G_MAXUINT-1, G_MAXUINT-2, etc, to -1, -2, -3 to stay within
44   ANSI C limits.
45
46 * A change in the handling of _NET_WM_USER_TIME properties on toplevel
47   windows can cause deadlock problems with window managers that are using
48   GDK for drawing decorations. In particular, metacity <= 2.18.0 is affected
49   by this. The problem has been fixed in metacity 2.18.1.
50
51 Release notes for 2.10
52 ======================
53
54 * The hexadecimal Unicode input feature has been reworked. It no longer
55   blocks the use of the sixteen Ctrl-Shift-<hex digit> key sequences. Now
56   it only uses Ctrl-Shift-u.
57
58 * A memory leak in GtkStyle handling has been fixed. This may expose bugs
59   in third-party widgets which forget to call gtk_style_attach() in their
60   realize functions.
61
62 * Range widgets like GtkScrollbar now render their arrows insensitive
63   when the slider is at the end. Applications which react to arrow
64   clicks even if the slider is at the end may want to use the new
65   gtk_range_set_[upper/lower]_stepper_sensitivity() functions to
66   prevent the arrows from being rendered insensitive.
67
68 * GtkObject now uses the "floating reference" support in GObject. 
69   GTK_OBJECT_IS_FLOATING() will still work, but direct checking
70   of the GTK_FLOATING flag will no longer detect the floating 
71   reference. Details about floating references can be found in the docs:
72   http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#floating-ref
73
74 * Accelerators like (_F) are now stripped from labels when they are 
75   displayed in toolbars. If this is not wanted, the feature can be 
76   suppressed by inserting a Unicode control character, e.g ZWNJ.
77
78 * The pixbuf theme engine can now customize expanders (in GtkTreeView
79   and GtkExpander) and resize grips, using the new EXPANDER and
80   RESIZE_GRIP function values.
81
82 * Dialogs created by gtk_about_dialog_new() no longer hide automatically
83   when the user clicks close. It is the applications responsibility to
84   hide or destroy the dialog.
85
86 * Several new signals have been added to GtkNotebook. Care has been taken
87   to choose signal names which do not collide with signals added by well-known
88   derived classes. The names which can no longer be used for signals in 
89   objects derived from GtkNotebook are page-reordered, page-removed and
90   page-added.
91
92 * Due to the interface changes in the file chooser backend interface, 
93   the GTK+ ABI version has been bumped to 2.10.0. Third-party filesystem 
94   backends have to be ported to the new interface, other modules, such as 
95   theme engines, input method modules or pixbuf loaders have to be rebuilt 
96   so that they are installed in the right place for GTK+ to find them.
97
98
99 Release notes for 2.8
100 =====================
101
102 * GTK+ 2.8 and Pango 1.10 require the cairo library.
103
104 * The default theme has been renamed to "Raleigh". Existing configurations
105   specifying the "Default" theme name should still work.
106
107 * The GtkTreeView::enable-search property has been changed to control
108   only typeahead search, not the C-f keybinding to start an interactive
109   search. To turn off interactive searching completely, you have to
110   set GtkTreeView::search-column to -1.
111
112 * The restriction on using the same cell renderer in multiple columns
113   of a GtkTreeView is now more strictly enforced.
114
115 * In GTK+ 2.8, GtkCalendar uses nl_langinfo() (if available) to determine
116   the first day of the week. Thus, it is possible to select the first day
117   of the week independently from the language, by setting LC_TIME.
118
119 * In GTK+ 2.8, the gtk-update-icon-cache utility includes image data
120   in the icon caches, which will make the icon cache files larger than
121   the one produced by GTK+ 2.6. This change will reduce the memory
122   overhead of icon themes at runtime, since all GTK+ applications can
123   share the image data in memory.
124
125 * In 2.8, GDK emits GdkEventGrabBroken events when a keyboard or pointer
126   grab is broken. On X11, this can happen if the same application grabs
127   again, or if the window used for the grab becomes unviewable. It happens
128   more often on Win32. Applications which use grabs should pay attention
129   to these events and do the necessary cleanups when the grab is lost.
130 * The GIOChannel code for sockets on win32 has been rewritten.
131   Applications who make non-trivial use of GIOChannels on win32 should
132   be watched for possible problems.
133
134 * GLib 2.8 uses atomic operations to implement reference counting, thus
135   g_object_ref/unref, g_closure_ref/sink/unref and g_iochannel_ref/unref
136   can be used without locking in multithreaded applications. Note that
137   other modifications, like concurrent setting of properties still require
138   locking.
139
140 * g_convert() and related character set conversion functions have been
141   fixed to emit pending shift states and to not cache iconv descriptors
142   across multiple calls, since that is problematic for some encodings.
143   Note that these functions are not suitable for streaming conversions;
144   use g_iconv() to do streaming conversion.
145
146
147 Release notes for 2.6
148 =====================
149
150 * GTK+ 2.6 supports clipboard persistency. To make use of this feature,
151   a clipboard manager following the specification at
152   http://www.freedesktop.org/wiki/Standards/clipboard-manager-spec
153   must be running. A sample implementation of such a clipboard manager
154   is available at 
155   http://people.imendio.com/andersca/archives/clipboard-manager-0.3.tar.gz
156   Applications can use the function gdk_display_supports_clipboard_persistence() 
157   to find out if clipboard persistence is available.
158
159 * Notification on clipboard ownership changes via GdkOwnerChange events 
160   requires the XFIXES X extension. Applications can use the function
161   gdk_display_supports_selection_notification() to find out if ownerchip
162   change notification is available.
163
164 * The icon theme code in GTK+ 2.6 follows the freedesktop.org icon theme 
165   specification. Setting the XDG_DATA_DIRS environtment variable may be 
166   necessary if your icons aren't installed in the default location 
167   /usr/share/icons.
168
169 * The icon theme code in GTK+ 2.6 can make use of mmap()able cache files
170   to avoid a lot of disk searching overhead. GTK+ includes a utility named
171   gtk-update-icon-cache to generate these cache files. For further details,
172   see the gtk-update-icon-cache man page or the GTK+ documentation.
173
174 * To reduce code size and improve efficiency, GTK+, when compiled 
175   with the GNU toolchain, has separate internal and external entry 
176   points for exported functions. The internal names, which begin with 
177   IA__, may be seen when debugging a GTK+ program.
178
179 * The following functions have been deprecated in GTK+ 2.6:
180   gdk_pango_context_set_colormap
181   gtk_cell_renderer_editing_canceled
182
183 * The new GtkFileChooser widget emphasizes simplicity and thus does 
184   not provide a navigation entry by default when opening files. 
185   Experienced command line users will likely want to make heavy use of
186   the location dialog brought up by the Control-L key shortcut.
187
188 * The GTK+ libraries use an '_' prefix to indicate private symbols that
189   must not be used by applications. On some platforms, symbols beginning 
190   with prefixes such as _gtk, _gdk, and _pango will be exported
191   from the library, on others not. In no case can applications
192   use these private symbols. In addition to that, GTK+ 2.6 makes several
193   symbols private which were not in any installed header files and
194   were never intended to be exported.
195
196 * The gdk_pixbuf_xlib library included in the contrib/ directory 
197   and the framebuffer GDK backend included in the gdk/linux-fb directory
198   of GTK+ are provided on an as-is basis and have not been tested at all. 
199   No guarantees about the degree of workingness or about future
200   compatibility are provided.
201
202 * On Unix, the assumption of GLib and GTK+ by default is that filenames on 
203   the filesystem are encoded in UTF-8 rather than the encoding of the locale;
204   the GTK+ developers consider that having filenames whose interpretation
205   depends on the current locale is fundamentally a bad idea.
206
207   If you have filenames encoded in the encoding of your locale, then you 
208   may want to set the G_FILENAME_ENCODING environment variable:
209   
210    G_FILENAME_ENCODING=@locale
211    export G_FILENAME_ENCODING
212
213   (Earlier versions of GLib 2.x required a different environment variable
214   setting; G_BROKEN_FILENAMES=1 to achieve the same effect; this 
215   is still supported, but G_FILENAME_ENCODING is preferred.)
216   Best integration of GTK+ 2.6 with the environment is achieved by 
217   using a UTF-8 locale.
218
219   On Windows, filenames passed to GTK+ should always be in UTF-8, as
220   in GLib 2.6. This is different than in previous versions of GTK+
221   where the system codepage was used. As in GLib, for DLL ABI
222   stability, applications built against previous versions of GTK+ will
223   use entry points providing the old semantics.
224
225   When compiling against GTK+ 2.6, applications intended to be
226   portable to Windows must take the UTF-8 file name encoding into
227   consideration, and use the gstdio wrappers to access files whose 
228   names have been constructed from strings returned from GTK+ or GLib.
229
230
231 How to report bugs
232 ==================
233
234 Bugs should be reported to the GNOME bug tracking system.
235 (http://bugzilla.gnome.org, product gtk+.) You will need to create an
236 account for yourself.
237   
238 In the bug report please include:
239   
240 * Information about your system. For instance:
241
242    - What operating system and version
243    - What version of X
244    - For Linux, what version of the C library
245
246   And anything else you think is relevant.
247
248 * How to reproduce the bug. 
249
250   If you can reproduce it with one of the tests or demos built with GTK+, 
251   such as demos/gtk-demo/gtk-demo, that would be most convenient. Otherwise, 
252   please include a short test program that exhibits the behavior. As a 
253   last resort, you can also provide a pointer to a larger piece of software 
254   that can be downloaded.
255
256 * If the bug was a crash, the exact text that was printed out when the
257   crash occured.
258
259 * Further information such as stack traces may be useful, but is not
260   necessary. If you do send a stack trace, and the error is an X error,
261   it will be more useful if the stacktrace is produced running the test
262   program with the --sync command line option.
263
264
265 Patches
266 =======
267
268 Patches should also be submitted to bugzilla.gnome.org. If the patch
269 fixes an existing bug, add the patch as an attachment to that bug
270 report.
271
272 Otherwise, enter a new bug report that describes the patch, and attach
273 the patch to that bug report.
274
275 Bug reports containing patches should include the PATCH keyword in their
276 keyword fields. If the patch adds to or changes the GTK+ programming
277 interface, the API keyword should also be included.
278   
279 Patches should be in unified diff form. (The -u option to GNU diff.)