README 14.3 KB
Newer Older
1 2
General Information
===================
Elliot Lee's avatar
Elliot Lee committed
3

Matthias Clasen's avatar
Matthias Clasen committed
4
This is GTK+ version 2.11.5. GTK+ is a multi-platform toolkit for
5 6 7
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

Elliot Lee's avatar
Elliot Lee committed
14
The official ftp site is:
15
  ftp://ftp.gtk.org/pub/gtk
Elliot Lee's avatar
Elliot Lee committed
16

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

Owen Taylor's avatar
Owen Taylor committed
20 21
Information about mailing lists can be found at
  http://www.gtk.org/mailinglists.html
22

Matthias Clasen's avatar
Matthias Clasen committed
23

24 25 26 27 28
Installation
============

See the file 'INSTALL'

Matthias Clasen's avatar
Matthias Clasen committed
29

Matthias Clasen's avatar
Matthias Clasen committed
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
Release notes for 2.12
======================

* Functions: gtk_about_dialog_get/set_name() were deprecated in favour of
  gtk_about_dialog_get/set_program_name(), the GtkAboutDialog now uses the
  "program-name" property instead of the conflicting "name" property.

* The tiff loader now requires libtiff 3.6.0 or later.

* Support for Windows 9x/ME has officially been removed. It hasn't worked
  since 2.6 anyway.

* The GtkTextBufferTargetInfo enumeration values have been changed from
  G_MAXUINT-0, G_MAXUINT-1, G_MAXUINT-2, etc, to -1, -2, -3 to stay within
  ANSI C limits.

* A change in the handling of _NET_WM_USER_TIME properties on toplevel
  windows can cause deadlock problems with window managers that are using
  GDK for drawing decorations. In particular, metacity <= 2.18.0 is affected
  by this. The problem has been fixed in metacity 2.18.1.

Matthias Clasen's avatar
Matthias Clasen committed
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
* Semi-private GtkTextLayout api has changed: new GtkTextLayout method
  invalidate_cursors(), and new functions gtk_text_layout_invalidate_cursors()
  and gtk_text_layout_cursors_changed(), which should be used in place of
  gtk_text_layout_invalidate() and gtk_text_layout_changed() if invalidation
  is due to marks moved or changed selection; new GtkTextLineDisplay structure
  member. Source compatibility is preserved; binary compatibility may break
  only if GtkTextLineDisplay structure was created on stack or as a part
  of another structure (in particular GnomeCanvas and its clones do not need
  recompiling).

* Another new signal has been added to GtkNotebook. The new signal
  is called create-window, so this name can no longer be used for signals
  in objects derived from GtkNotebook.

* The move-focus signal has been moved to GtkWidget, to unify the 
  various implementations of this signal in specific widgets. Great care 
  has been taken to make sure that all code using this signal continues
  to work.

Matthias Clasen's avatar
Matthias Clasen committed
70 71 72 73 74 75
* Removed an unused and hardly visible GtkFrame from the menu widget hierarchy
  when GtkComboBox::appears-as-list style property is set. Any RC file
  applying a different style to any widget below the widget path
  "gtk-combobox-popup-window.GtkFrame" should take into account that the 
  frame no longer exists.

Matthias Clasen's avatar
Matthias Clasen committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
* The external print preview application used by GtkPrintOperationPreview is
  now passed the print settings on the command line with the --print-settings
  parameter pointing to a temp file containing the settings. The preview
  application assumes ownership of the file and should delete it once it does
  not need it anymore. The --print-settings commandline option is understood
  by Evince 0.9.0 and newer. To use a different print preview application,
  change the gtk-print-preview-command setting in your gtkrc file, e.g.
  gtk-print-preview-command = "ggv %f"

* GtkMenuShell is now defined as an abstract type. It was already 
  documented as an abstract class, and there is little reason to 
  instantiate it.

* The GtkTooltips struct (this is the old tooltips API) is now considered
  private. Code that used to access this struct, in particular the
  tips_data_list field, will need to change.
  
* The memory management of the GtkRecentManager object has been changed,
  as using the screen didn't guarantee that the singleton instance was
  correctly destroyed. The screen-related functions have been deprecated,
  and should not be used anymore; the GtkRecentManager instance returned by
  the gtk_recent_manager_get_default() function is guaranteed to be valid
  for the entire lifetime of an application.
Matthias Clasen's avatar
Matthias Clasen committed
99

Matthias Clasen's avatar
2.9.0  
Matthias Clasen committed
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
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.

* 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.

* 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 
  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

Matthias Clasen's avatar
Matthias Clasen committed
123 124 125
* Accelerators 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.
Matthias Clasen's avatar
2.9.0  
Matthias Clasen committed
126 127 128 129 130

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

Matthias Clasen's avatar
Matthias Clasen committed
131
* Dialogs created by gtk_about_dialog_new() no longer hide automatically
Matthias Clasen's avatar
2.9.0  
Matthias Clasen committed
132 133 134 135 136 137 138 139 140
  when the user clicks close. It is the applications responsibility to
  hide or destroy the dialog.

* 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.

Matthias Clasen's avatar
Matthias Clasen committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
* Due to the interface changes in the file chooser backend interface, 
  the GTK+ ABI version has been bumped to 2.10.0. Third-party filesystem 
  backends have to be ported to the new interface, other modules, such as 
  theme engines, input method modules or pixbuf loaders have to be rebuilt 
  so that they are installed in the right place for GTK+ to find them.


Release notes for 2.8
=====================

* GTK+ 2.8 and Pango 1.10 require the cairo library.

* The default theme has been renamed to "Raleigh". Existing configurations
  specifying the "Default" theme name should still work.

* The GtkTreeView::enable-search property has been changed to control
  only typeahead search, not the C-f keybinding to start an interactive
  search. To turn off interactive searching completely, you have to
  set GtkTreeView::search-column to -1.

* The restriction on using the same cell renderer in multiple columns
  of a GtkTreeView is now more strictly enforced.

* In GTK+ 2.8, GtkCalendar uses nl_langinfo() (if available) to determine
  the first day of the week. Thus, it is possible to select the first day
  of the week independently from the language, by setting LC_TIME.

* In GTK+ 2.8, the gtk-update-icon-cache utility includes image data
  in the icon caches, which will make the icon cache files larger than
  the one produced by GTK+ 2.6. This change will reduce the memory
  overhead of icon themes at runtime, since all GTK+ applications can
  share the image data in memory.

* In 2.8, GDK emits GdkEventGrabBroken events when a keyboard or pointer
  grab is broken. On X11, this can happen if the same application grabs
  again, or if the window used for the grab becomes unviewable. It happens
  more often on Win32. Applications which use grabs should pay attention
  to these events and do the necessary cleanups when the grab is lost.
* The GIOChannel code for sockets on win32 has been rewritten.
  Applications who make non-trivial use of GIOChannels on win32 should
  be watched for possible problems.

* GLib 2.8 uses atomic operations to implement reference counting, thus
  g_object_ref/unref, g_closure_ref/sink/unref and g_iochannel_ref/unref
  can be used without locking in multithreaded applications. Note that
  other modifications, like concurrent setting of properties still require
  locking.

* g_convert() and related character set conversion functions have been
  fixed to emit pending shift states and to not cache iconv descriptors
  across multiple calls, since that is problematic for some encodings.
  Note that these functions are not suitable for streaming conversions;
  use g_iconv() to do streaming conversion.


Release notes for 2.6
=====================
198

Matthias Clasen's avatar
Matthias Clasen committed
199
* GTK+ 2.6 supports clipboard persistency. To make use of this feature,
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
200 201 202 203 204 205 206 207 208 209
  a clipboard manager following the specification at
  http://www.freedesktop.org/wiki/Standards/clipboard-manager-spec
  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
  Applications can use the function gdk_display_supports_clipboard_persistence() 
  to find out if clipboard persistence is available.

* Notification on clipboard ownership changes via GdkOwnerChange events 
  requires the XFIXES X extension. Applications can use the function
Matthias Clasen's avatar
Matthias Clasen committed
210
  gdk_display_supports_selection_notification() to find out if ownerchip
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
211 212 213
  change notification is available.

* The icon theme code in GTK+ 2.6 follows the freedesktop.org icon theme 
Matthias Clasen's avatar
Matthias Clasen committed
214
  specification. Setting the XDG_DATA_DIRS environtment variable may be 
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
215 216 217 218 219 220 221 222 223
  necessary if your icons aren't installed in the default location 
  /usr/share/icons.

* 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.

* To reduce code size and improve efficiency, GTK+, when compiled 
Matthias Clasen's avatar
Matthias Clasen committed
224
  with the GNU toolchain, has separate internal and external entry 
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
225 226 227 228 229 230 231
  points for exported functions. The internal names, which begin with 
  IA__, may be seen when debugging a GTK+ program.

* 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
232 233 234 235 236
* 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.

237
* The GTK+ libraries use an '_' prefix to indicate private symbols that
Owen Taylor's avatar
Owen Taylor committed
238 239 240
  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
2.6.0  
Matthias Clasen committed
241 242 243 244 245 246 247 248
  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.

* 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
249 250
  compatibility are provided.

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

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
256 257
  If you have filenames encoded in the encoding of your locale, then you 
  may want to set the G_FILENAME_ENCODING environment variable:
258
  
Matthias Clasen's avatar
2.6.1  
Matthias Clasen committed
259
   G_FILENAME_ENCODING=@locale
Owen Taylor's avatar
Owen Taylor committed
260
   export G_FILENAME_ENCODING
261

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

Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
268 269
  On Windows, filenames passed to GTK+ should always be in UTF-8, as
  in GLib 2.6. This is different than in previous versions of GTK+
Matthias Clasen's avatar
Matthias Clasen committed
270
  where the system codepage was used. As in GLib, for DLL ABI
Matthias Clasen's avatar
2.6.0  
Matthias Clasen committed
271 272 273 274 275 276 277 278
  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
  consideration, and use the gstdio wrappers to access files whose 
  names have been constructed from strings returned from GTK+ or GLib.

Matthias Clasen's avatar
Matthias Clasen committed
279

280 281 282
How to report bugs
==================

283 284 285
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.
Owen Taylor's avatar
Owen Taylor committed
286 287 288
  
In the bug report please include:
  
289 290 291 292 293 294 295 296 297 298
* 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
299 300 301 302
  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 
303
  that can be downloaded.
304

305
* If the bug was a crash, the exact text that was printed out when the
Matthias Clasen's avatar
Matthias Clasen committed
306
  crash occured.
307

308 309 310 311
* 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.
312

Matthias Clasen's avatar
Matthias Clasen committed
313

314 315 316
Patches
=======

317 318 319
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.
Owen Taylor's avatar
Owen Taylor committed
320

321 322
Otherwise, enter a new bug report that describes the patch, and attach
the patch to that bug report.
323

Matthias Clasen's avatar
Matthias Clasen committed
324 325 326
Bug reports containing patches should include the PATCH keyword in their
keyword fields. If the patch adds to or changes the GTK+ programming
interface, the API keyword should also be included.
Owen Taylor's avatar
Owen Taylor committed
327
  
328
Patches should be in unified diff form. (The -u option to GNU diff.)