]> Pileus Git - ~andy/gtk/blob - README.in
Mention the stripping of (_F) suffixes.
[~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 Release notes
56 =============
57
58 * GTK+ 2.6 supports clipboard persistency. To make use of this feature,
59   a clipboard manager following the specification at
60   http://www.freedesktop.org/wiki/Standards/clipboard-manager-spec
61   must be running. A sample implementation of such a clipboard manager
62   is available at 
63   http://people.imendio.com/andersca/archives/clipboard-manager-0.3.tar.gz
64   Applications can use the function gdk_display_supports_clipboard_persistence() 
65   to find out if clipboard persistence is available.
66
67 * Notification on clipboard ownership changes via GdkOwnerChange events 
68   requires the XFIXES X extension. Applications can use the function
69   gdk_display_supports_selection_notification() to find out if ownerchip
70   change notification is available.
71
72 * The icon theme code in GTK+ 2.6 follows the freedesktop.org icon theme 
73   specification. Setting the XDG_DATA_DIRS environtment variable may be 
74   necessary if your icons aren't installed in the default location 
75   /usr/share/icons.
76
77 * The icon theme code in GTK+ 2.6 can make use of mmap()able cache files
78   to avoid a lot of disk searching overhead. GTK+ includes a utility named
79   gtk-update-icon-cache to generate these cache files. For further details,
80   see the gtk-update-icon-cache man page or the GTK+ documentation.
81
82 * To reduce code size and improve efficiency, GTK+, when compiled 
83   with the GNU toolchain, has separate internal and external entry 
84   points for exported functions. The internal names, which begin with 
85   IA__, may be seen when debugging a GTK+ program.
86
87 * The following functions have been deprecated in GTK+ 2.6:
88   gdk_pango_context_set_colormap
89   gtk_cell_renderer_editing_canceled
90
91 * The new GtkFileChooser widget emphasizes simplicity and thus does 
92   not provide a navigation entry by default when opening files. 
93   Experienced command line users will likely want to make heavy use of
94   the location dialog brought up by the Control-L key shortcut.
95
96 * The GTK+ libraries use an '_' prefix to indicate private symbols that
97   must not be used by applications. On some platforms, symbols beginning 
98   with prefixes such as _gtk, _gdk, and _pango will be exported
99   from the library, on others not. In no case can applications
100   use these private symbols. In addition to that, GTK+ 2.6 makes several
101   symbols private which were not in any installed header files and
102   were never intended to be exported.
103
104 * The gdk_pixbuf_xlib library included in the contrib/ directory 
105   and the framebuffer GDK backend included in the gdk/linux-fb directory
106   of GTK+ are provided on an as-is basis and have not been tested at all. 
107   No guarantees about the degree of workingness or about future
108   compatibility are provided.
109
110 * On Unix, the assumption of GLib and GTK+ by default is that filenames on 
111   the filesystem are encoded in UTF-8 rather than the encoding of the locale;
112   the GTK+ developers consider that having filenames whose interpretation
113   depends on the current locale is fundamentally a bad idea.
114
115   If you have filenames encoded in the encoding of your locale, then you 
116   may want to set the G_FILENAME_ENCODING environment variable:
117   
118    G_FILENAME_ENCODING=@locale
119    export G_FILENAME_ENCODING
120
121   (Earlier versions of GLib 2.x required a different environment variable
122   setting; G_BROKEN_FILENAMES=1 to achieve the same effect; this 
123   is still supported, but G_FILENAME_ENCODING is preferred.)
124   Best integration of GTK+ 2.6 with the environment is achieved by 
125   using a UTF-8 locale.
126
127   On Windows, filenames passed to GTK+ should always be in UTF-8, as
128   in GLib 2.6. This is different than in previous versions of GTK+
129   where the system codepage was used. As in GLib, for DLL ABI
130   stability, applications built against previous versions of GTK+ will
131   use entry points providing the old semantics.
132
133   When compiling against GTK+ 2.6, applications intended to be
134   portable to Windows must take the UTF-8 file name encoding into
135   consideration, and use the gstdio wrappers to access files whose 
136   names have been constructed from strings returned from GTK+ or GLib.
137
138 How to report bugs
139 ==================
140
141 Bugs should be reported to the GNOME bug tracking system.
142 (http://bugzilla.gnome.org, product gtk+.) You will need to create an
143 account for yourself.
144   
145 In the bug report please include:
146   
147 * Information about your system. For instance:
148
149    - What operating system and version
150    - What version of X
151    - For Linux, what version of the C library
152
153   And anything else you think is relevant.
154
155 * How to reproduce the bug. 
156
157   If you can reproduce it with one of the tests or demos built with GTK+, 
158   such as demos/gtk-demo/gtk-demo, that would be most convenient. Otherwise, 
159   please include a short test program that exhibits the behavior. As a 
160   last resort, you can also provide a pointer to a larger piece of software 
161   that can be downloaded.
162
163 * If the bug was a crash, the exact text that was printed out when the
164   crash occured.
165
166 * Further information such as stack traces may be useful, but is not
167   necessary. If you do send a stack trace, and the error is an X error,
168   it will be more useful if the stacktrace is produced running the test
169   program with the --sync command line option.
170
171 Patches
172 =======
173
174 Patches should also be submitted to bugzilla.gnome.org. If the patch
175 fixes an existing bug, add the patch as an attachment to that bug
176 report.
177
178 Otherwise, enter a new bug report that describes the patch, and attach
179 the patch to that bug report.
180
181 Bug reports containing patches should include the PATCH keyword in their
182 keyword fields. If the patch adds to or changes the GTK+ programming
183 interface, the API keyword should also be included.
184   
185 Patches should be in unified diff form. (The -u option to GNU diff.)