README.in 8.26 KB
Newer Older
1
General Information
2 3
===================

4 5 6 7
This is GTK+ version @GTK_VERSION@. GTK+ is a multi-platform toolkit for
creating graphical user interfaces. Offering a complete set of widgets,
GTK+ is suitable for projects ranging from small one-off projects to
complete application suites.
Owen Taylor's avatar
Owen Taylor committed
8 9 10

GTK+ is free software and part of the GNU Project. However, the
licensing terms for GTK+, the GNU LGPL, allow it to be used by all
11 12
developers, including those developing proprietary software, without any
license fees or royalties.
13 14 15 16 17 18 19

The official ftp site is:
  ftp://ftp.gtk.org/pub/gtk

The official web site is:
  http://www.gtk.org/

20 21
Information about mailing lists can be found at
  http://www.gtk.org/mailinglists.html
22 23 24 25 26 27

Installation
============

See the file 'INSTALL'

28 29 30 31 32 33 34 35 36 37 38
Release notes for 2.10
======================

* The hexadecimal Unicode input feature has been reworked. It no longer
  blocks the use of the sixteen Ctrl-Shift-<hex digit> key sequences. Now
  it only uses Ctrl-Shift-u.

* A memory leak in GtkStyle handling has been fixed. This may expose bugs
  in third-party widgets which forget to call gtk_style_attach() in their
  realize functions.

39 40 41 42 43 44
* Range widgets like GtkScrollbar now render their arrows insensitive
  when the slider is at the end. Applications which react to arrow
  clicks even if the slider is at the end may want to use the new
  gtk_range_set_[upper/lower]_stepper_sensitivity() functions to
  prevent the arrows from being rendered insensitive.

45 46 47
* GtkObject now uses the "floating reference" support in GObject. 
  GTK_OBJECT_IS_FLOATING() will still work, but direct checking
  of the GTK_FLOATING flag will no longer detect the floating 
48 49 50
  reference. Details about floating references can be found in the docs:
  http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#floating-ref

51 52 53 54
* Suffixes like (_F) are now stripped from labels when they are displayed
  in toolbars. If this is not wanted, the feature can be suppressed by 
  inserting a Unicode control character, e.g ZWNJ.

55 56 57 58
* The pixbuf theme engine can now customize expanders (in GtkTreeView
  and GtkExpander) and resize grips, using the new EXPANDER and
  RESIZE_GRIP function values.

59 60 61 62
* Dialogs created by gtk_about_dialog_new no longer hide automatically
  when the user clicks close. It is the applications responsibility to
  hide or destroy the dialog.

Matthias Clasen's avatar
Matthias Clasen committed
63 64 65 66 67 68
* Several new signals have been added to GtkNotebook. Care has been taken
  to choose signal names which do not collide with signals added by well-known
  derived classes. The names which can no longer be used for signals in 
  objects derived from GtkNotebook are page-reordered, page-removed and
  page-added.

Owen Taylor's avatar
Owen Taylor committed
69 70
Release notes
=============
71

Matthias Clasen's avatar
Matthias Clasen committed
72 73
* GTK+ 2.6 supports clipboard persistency. To make use of this feature,
  a clipboard manager following the specification at
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
74
  http://www.freedesktop.org/wiki/Standards/clipboard-manager-spec
Matthias Clasen's avatar
Matthias Clasen committed
75 76 77
  must be running. A sample implementation of such a clipboard manager
  is available at 
  http://people.imendio.com/andersca/archives/clipboard-manager-0.3.tar.gz
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
78 79
  Applications can use the function gdk_display_supports_clipboard_persistence() 
  to find out if clipboard persistence is available.
Matthias Clasen's avatar
Matthias Clasen committed
80

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
81 82 83 84 85 86 87 88 89
* Notification on clipboard ownership changes via GdkOwnerChange events 
  requires the XFIXES X extension. Applications can use the function
  gdk_display_supports_selection_notification() to find out if ownerchip
  change notification is available.

* The icon theme code in GTK+ 2.6 follows the freedesktop.org icon theme 
  specification. Setting the XDG_DATA_DIRS environtment variable may be 
  necessary if your icons aren't installed in the default location 
  /usr/share/icons.
Matthias Clasen's avatar
Matthias Clasen committed
90 91 92 93 94 95

* The icon theme code in GTK+ 2.6 can make use of mmap()able cache files
  to avoid a lot of disk searching overhead. GTK+ includes a utility named
  gtk-update-icon-cache to generate these cache files. For further details,
  see the gtk-update-icon-cache man page or the GTK+ documentation.

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
96 97 98 99
* To reduce code size and improve efficiency, GTK+, when compiled 
  with the GNU toolchain, has separate internal and external entry 
  points for exported functions. The internal names, which begin with 
  IA__, may be seen when debugging a GTK+ program.
Matthias Clasen's avatar
Matthias Clasen committed
100 101 102 103 104

* The following functions have been deprecated in GTK+ 2.6:
  gdk_pango_context_set_colormap
  gtk_cell_renderer_editing_canceled

Owen Taylor's avatar
Owen Taylor committed
105 106 107 108 109
* The new GtkFileChooser widget emphasizes simplicity and thus does 
  not provide a navigation entry by default when opening files. 
  Experienced command line users will likely want to make heavy use of
  the location dialog brought up by the Control-L key shortcut.

110
* The GTK+ libraries use an '_' prefix to indicate private symbols that
Owen Taylor's avatar
Owen Taylor committed
111 112 113
  must not be used by applications. On some platforms, symbols beginning 
  with prefixes such as _gtk, _gdk, and _pango will be exported
  from the library, on others not. In no case can applications
Matthias Clasen's avatar
Matthias Clasen committed
114 115 116
  use these private symbols. In addition to that, GTK+ 2.6 makes several
  symbols private which were not in any installed header files and
  were never intended to be exported.
117

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
118 119 120 121
* The gdk_pixbuf_xlib library included in the contrib/ directory 
  and the framebuffer GDK backend included in the gdk/linux-fb directory
  of GTK+ are provided on an as-is basis and have not been tested at all. 
  No guarantees about the degree of workingness or about future
122 123
  compatibility are provided.

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
124 125
* On Unix, the assumption of GLib and GTK+ by default is that filenames on 
  the filesystem are encoded in UTF-8 rather than the encoding of the locale;
Owen Taylor's avatar
Owen Taylor committed
126
  the GTK+ developers consider that having filenames whose interpretation
127 128
  depends on the current locale is fundamentally a bad idea.

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
129 130
  If you have filenames encoded in the encoding of your locale, then you 
  may want to set the G_FILENAME_ENCODING environment variable:
131
  
132
   G_FILENAME_ENCODING=@locale
Owen Taylor's avatar
Owen Taylor committed
133
   export G_FILENAME_ENCODING
134

Matthias Clasen's avatar
Matthias Clasen committed
135
  (Earlier versions of GLib 2.x required a different environment variable
Owen Taylor's avatar
Owen Taylor committed
136 137
  setting; G_BROKEN_FILENAMES=1 to achieve the same effect; this 
  is still supported, but G_FILENAME_ENCODING is preferred.)
Matthias Clasen's avatar
Matthias Clasen committed
138
  Best integration of GTK+ 2.6 with the environment is achieved by 
139 140
  using a UTF-8 locale.

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
141
  On Windows, filenames passed to GTK+ should always be in UTF-8, as
Tor Lillqvist's avatar
Tor Lillqvist committed
142
  in GLib 2.6. This is different than in previous versions of GTK+
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
143
  where the system codepage was used. As in GLib, for DLL ABI
Tor Lillqvist's avatar
Tor Lillqvist committed
144 145 146 147 148
  stability, applications built against previous versions of GTK+ will
  use entry points providing the old semantics.

  When compiling against GTK+ 2.6, applications intended to be
  portable to Windows must take the UTF-8 file name encoding into
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
149 150
  consideration, and use the gstdio wrappers to access files whose 
  names have been constructed from strings returned from GTK+ or GLib.
Tor Lillqvist's avatar
Tor Lillqvist committed
151

152 153 154
How to report bugs
==================

155 156 157
Bugs should be reported to the GNOME bug tracking system.
(http://bugzilla.gnome.org, product gtk+.) You will need to create an
account for yourself.
158 159 160
  
In the bug report please include:
  
161 162 163 164 165 166 167 168 169 170
* Information about your system. For instance:

   - What operating system and version
   - What version of X
   - For Linux, what version of the C library

  And anything else you think is relevant.

* How to reproduce the bug. 

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
171 172 173 174
  If you can reproduce it with one of the tests or demos built with GTK+, 
  such as demos/gtk-demo/gtk-demo, that would be most convenient. Otherwise, 
  please include a short test program that exhibits the behavior. As a 
  last resort, you can also provide a pointer to a larger piece of software 
175
  that can be downloaded.
176

177 178
* If the bug was a crash, the exact text that was printed out when the
  crash occured.
179

180 181 182 183
* Further information such as stack traces may be useful, but is not
  necessary. If you do send a stack trace, and the error is an X error,
  it will be more useful if the stacktrace is produced running the test
  program with the --sync command line option.
184 185 186 187

Patches
=======

188 189 190
Patches should also be submitted to bugzilla.gnome.org. If the patch
fixes an existing bug, add the patch as an attachment to that bug
report.
191

192 193
Otherwise, enter a new bug report that describes the patch, and attach
the patch to that bug report.
194

195
Bug reports containing patches should include the PATCH keyword in their
Matthias Clasen's avatar
Matthias Clasen committed
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.)