AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

move README.linux-fb in here

Browse Source 
2002-01-01  Havoc Pennington  <hp@pobox.com>

	* gtk/framebuffer.sgml: move README.linux-fb in here

	* gtk/tmpl/gtkpreview.sgml: explain what to use instead

	* gtk/tmpl/gtkseparator.sgml: typo fix

	* gtk/tmpl/gtkstock.sgml: add some overview docs

	* gtk/Makefile.am (content_files): add new files

	* gtk/changes-1.2.sgml: move Changes-1.2.txt in here

	* gtk/changes-2.0.sgml: move Changes-2.0.txt in here

	* gdk/tmpl/threads.sgml: mention gdk_threads_init() in the
	overview docs, copy in the examples from the FAQ

	* gtk/gtk-docs.sgml: change DTD to 3.1, and add
	question_index.sgml and changes-1.2, changes-2.0

	* gtk/tmpl/gtkdrawingarea.sgml: fixups to reflect 2.0 changes

	* gtk/question_index.sgml: new section with question-based
	index of the manual

	* gtk/text_widget.sgml: fix some cross-references

2002-01-01  Havoc Pennington  <hp@pobox.com>

	* docs/README.linux-fb: note that this file is obsolete

	* docs/Changes-2.0.txt, docs/Changes-1.2.txt: Add notes to these
	files that they should not be edited and look in the reference
	manual instead. Probably these files should just be replaced by
	the note, and their main contents deleted.

	* gtk/gtktextview.c: docs

	* gtk/gtktextmark.c: docs

	* gtk/gtktextchild.c: docs

	* gtk/gtktextbuffer.c: docs stuff

	* gtk/gtkclipboard.c (gtk_clipboard_get): fool with docs to maybe
	give people more leads in sorting out PRIMARY vs. CLIPBOARD
This commit is contained in:
Havoc Pennington 2002-01-01 23:51:00 +00:00 committed by Havoc Pennington
parent c8940d6fdc
commit e7153de001
33 changed files with 2631 additions and 68 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
ChangeLog
View File

@ -1,3 +1,23 @@
2002-01-01 Havoc Pennington <hp@pobox.com>
* docs/README.linux-fb: note that this file is obsolete
* docs/Changes-2.0.txt, docs/Changes-1.2.txt: Add notes to these
files that they should not be edited and look in the reference
manual instead. Probably these files should just be replaced by
the note, and their main contents deleted.
* gtk/gtktextview.c: docs
* gtk/gtktextmark.c: docs
* gtk/gtktextchild.c: docs
* gtk/gtktextbuffer.c: docs stuff
* gtk/gtkclipboard.c (gtk_clipboard_get): fool with docs to maybe
give people more leads in sorting out PRIMARY vs. CLIPBOARD
2002-01-01 Tor Lillqvist <tml@iki.fi>
* demos/Makefile.am (test-inline-pixbufs.h): Append EXEEXT to

20
ChangeLog.pre-2-0
View File

@ -1,3 +1,23 @@
2002-01-01 Havoc Pennington <hp@pobox.com>
* docs/README.linux-fb: note that this file is obsolete
* docs/Changes-2.0.txt, docs/Changes-1.2.txt: Add notes to these
files that they should not be edited and look in the reference
manual instead. Probably these files should just be replaced by
the note, and their main contents deleted.
* gtk/gtktextview.c: docs
* gtk/gtktextmark.c: docs
* gtk/gtktextchild.c: docs
* gtk/gtktextbuffer.c: docs stuff
* gtk/gtkclipboard.c (gtk_clipboard_get): fool with docs to maybe
give people more leads in sorting out PRIMARY vs. CLIPBOARD
2002-01-01 Tor Lillqvist <tml@iki.fi>
* demos/Makefile.am (test-inline-pixbufs.h): Append EXEEXT to

20
ChangeLog.pre-2-10
View File

@ -1,3 +1,23 @@
2002-01-01 Havoc Pennington <hp@pobox.com>
* docs/README.linux-fb: note that this file is obsolete
* docs/Changes-2.0.txt, docs/Changes-1.2.txt: Add notes to these
files that they should not be edited and look in the reference
manual instead. Probably these files should just be replaced by
the note, and their main contents deleted.
* gtk/gtktextview.c: docs
* gtk/gtktextmark.c: docs
* gtk/gtktextchild.c: docs
* gtk/gtktextbuffer.c: docs stuff
* gtk/gtkclipboard.c (gtk_clipboard_get): fool with docs to maybe
give people more leads in sorting out PRIMARY vs. CLIPBOARD
2002-01-01 Tor Lillqvist <tml@iki.fi>
* demos/Makefile.am (test-inline-pixbufs.h): Append EXEEXT to

20
ChangeLog.pre-2-2
View File

@ -1,3 +1,23 @@
2002-01-01 Havoc Pennington <hp@pobox.com>
* docs/README.linux-fb: note that this file is obsolete
* docs/Changes-2.0.txt, docs/Changes-1.2.txt: Add notes to these
files that they should not be edited and look in the reference
manual instead. Probably these files should just be replaced by
the note, and their main contents deleted.
* gtk/gtktextview.c: docs
* gtk/gtktextmark.c: docs
* gtk/gtktextchild.c: docs
* gtk/gtktextbuffer.c: docs stuff
* gtk/gtkclipboard.c (gtk_clipboard_get): fool with docs to maybe
give people more leads in sorting out PRIMARY vs. CLIPBOARD
2002-01-01 Tor Lillqvist <tml@iki.fi>
* demos/Makefile.am (test-inline-pixbufs.h): Append EXEEXT to

20
ChangeLog.pre-2-4
View File

@ -1,3 +1,23 @@
2002-01-01 Havoc Pennington <hp@pobox.com>
* docs/README.linux-fb: note that this file is obsolete
* docs/Changes-2.0.txt, docs/Changes-1.2.txt: Add notes to these
files that they should not be edited and look in the reference
manual instead. Probably these files should just be replaced by
the note, and their main contents deleted.
* gtk/gtktextview.c: docs
* gtk/gtktextmark.c: docs
* gtk/gtktextchild.c: docs
* gtk/gtktextbuffer.c: docs stuff
* gtk/gtkclipboard.c (gtk_clipboard_get): fool with docs to maybe
give people more leads in sorting out PRIMARY vs. CLIPBOARD
2002-01-01 Tor Lillqvist <tml@iki.fi>
* demos/Makefile.am (test-inline-pixbufs.h): Append EXEEXT to

20
ChangeLog.pre-2-6
View File

@ -1,3 +1,23 @@
2002-01-01 Havoc Pennington <hp@pobox.com>
* docs/README.linux-fb: note that this file is obsolete
* docs/Changes-2.0.txt, docs/Changes-1.2.txt: Add notes to these
files that they should not be edited and look in the reference
manual instead. Probably these files should just be replaced by
the note, and their main contents deleted.
* gtk/gtktextview.c: docs
* gtk/gtktextmark.c: docs
* gtk/gtktextchild.c: docs
* gtk/gtktextbuffer.c: docs stuff
* gtk/gtkclipboard.c (gtk_clipboard_get): fool with docs to maybe
give people more leads in sorting out PRIMARY vs. CLIPBOARD
2002-01-01 Tor Lillqvist <tml@iki.fi>
* demos/Makefile.am (test-inline-pixbufs.h): Append EXEEXT to

20
ChangeLog.pre-2-8
View File

@ -1,3 +1,23 @@
2002-01-01 Havoc Pennington <hp@pobox.com>
* docs/README.linux-fb: note that this file is obsolete
* docs/Changes-2.0.txt, docs/Changes-1.2.txt: Add notes to these
files that they should not be edited and look in the reference
manual instead. Probably these files should just be replaced by
the note, and their main contents deleted.
* gtk/gtktextview.c: docs
* gtk/gtktextmark.c: docs
* gtk/gtktextchild.c: docs
* gtk/gtktextbuffer.c: docs stuff
* gtk/gtkclipboard.c (gtk_clipboard_get): fool with docs to maybe
give people more leads in sorting out PRIMARY vs. CLIPBOARD
2002-01-01 Tor Lillqvist <tml@iki.fi>
* demos/Makefile.am (test-inline-pixbufs.h): Append EXEEXT to

21
docs/Changes-1.2.txt
View File

@ -1,3 +1,15 @@
DON'T EDIT THIS FILE - changes are now maintained in the reference
manual, see docs/reference/gtk/changes-*.sgml. Also, when adding a
change to the manual, you should amend the docs for all
newly-deprecated features to point to the replacement for that
feature, and be sure the GTK_DISABLE_DEPRECATED guards are in place in
the header files. Be sure to add a note to the docs for EACH
deprecated function; don't just do the changes-*.sgml change.
Incompatible Changes from GTK+-1.0 to GTK+-1.2:
* GtkAcceleratorTable has been replaced with GtkAccelGroup
@ -272,3 +284,12 @@ Incompatible Changes from GTK+-1.0 to GTK+-1.2:
which returns the requisition of the given widget, modified
by calls to gtk_widget_set_usize().
DON'T EDIT THIS FILE - changes are now maintained in the reference
manual, see docs/reference/gtk/changes-*.sgml. Also, when adding a
change to the manual, you should amend the docs for all
newly-deprecated features to point to the replacement for that
feature, and be sure the GTK_DISABLE_DEPRECATED guards are in place in
the header files. Be sure to add a note to the docs for EACH
deprecated function; don't just do the changes-*.sgml change.

25
docs/Changes-2.0.txt
View File

@ -1,3 +1,18 @@
DON'T EDIT THIS FILE - changes are now maintained in the reference
manual, see docs/reference/gtk/changes-*.sgml. Also, when adding a
change to the manual, you should amend the docs for all
newly-deprecated features to point to the replacement for that
feature, and be sure the GTK_DISABLE_DEPRECATED guards are in place in
the header files. Be sure to add a note to the docs for EACH
deprecated function; don't just do the changes-*.sgml change.
Incompatible Changes from GTK+-1.2 to GTK+-2.0:
* gtk_container_get_toplevels() was removed and replaced with
@ -560,3 +575,13 @@ Incompatible Changes from GTK+-1.2 to GTK+-2.0:
- The rectangle passed in is the bounding box, instead of
the rectangle used in the gdk_draw_rectangle() call, so it is
no longer necessary to subtract 1 from the width and height.
DON'T EDIT THIS FILE - changes are now maintained in the reference
manual, see docs/reference/gtk/changes-*.sgml. Also, when adding a
change to the manual, you should amend the docs for all
newly-deprecated features to point to the replacement for that
feature, and be sure the GTK_DISABLE_DEPRECATED guards are in place in
the header files. Be sure to add a note to the docs for EACH
deprecated function; don't just do the changes-*.sgml change.

12
docs/README.linux-fb
View File

@ -1,3 +1,15 @@
THIS FILE IS OBSOLETE - use docs/reference/gtk/framebuffer.sgml
About GtkFB:
------------
The linux-fb port of Gtk+, also known as GtkFB is an implementation of

29
docs/reference/ChangeLog
View File

@ -1,3 +1,32 @@
2002-01-01 Havoc Pennington <hp@pobox.com>
* gtk/framebuffer.sgml: move README.linux-fb in here
* gtk/tmpl/gtkpreview.sgml: explain what to use instead
* gtk/tmpl/gtkseparator.sgml: typo fix
* gtk/tmpl/gtkstock.sgml: add some overview docs
* gtk/Makefile.am (content_files): add new files
* gtk/changes-1.2.sgml: move Changes-1.2.txt in here
* gtk/changes-2.0.sgml: move Changes-2.0.txt in here
* gdk/tmpl/threads.sgml: mention gdk_threads_init() in the
overview docs, copy in the examples from the FAQ
* gtk/gtk-docs.sgml: change DTD to 3.1, and add
question_index.sgml and changes-1.2, changes-2.0
* gtk/tmpl/gtkdrawingarea.sgml: fixups to reflect 2.0 changes
* gtk/question_index.sgml: new section with question-based
index of the manual
* gtk/text_widget.sgml: fix some cross-references
2002-01-01 Havoc Pennington <hp@pobox.com>
* gtk/tmpl/gtktexttag.sgml: docs updates, mention that invisible

218
docs/reference/gdk/tmpl/threads.sgml
View File

@ -10,8 +10,20 @@ For thread safety, GDK relies on the thread primitives in GLib,
and on the thread-safe GLib main loop.
</para>
<para>
You must call g_thread_init() before executing any other GTK+ or GDK
functions in a threaded GTK+ program.
GLib is completely thread safe (all global data is automatically
locked), but individual data structure instances are not automatically
locked for performance reasons. So e.g. you must coordinate
accesses to the same #GHashTable from multiple threads.
</para>
<para>
GTK+ is "thread aware" but not thread safe &mdash; it provides a
global lock controlled by gdk_threads_enter()/gdk_threads_leave()
which protects all use of GTK+. That is, only one thread can use GTK+
at any given time.
</para>
<para>
You must call g_thread_init() and gdk_threads_init() before executing
any other GTK+ or GDK functions in a threaded GTK+ program.
</para>
<para>
Idles, timeouts, and input functions are executed outside
@ -31,6 +43,188 @@ As always, you must also surround any calls to GTK+ not made within
a signal handler with a gdk_threads_enter()/gdk_threads_leave() pair.
</para>
<para>A minimal main program for a threaded GTK+ application
looks like:</para>
<para>
<programlisting role="C">
int
main (int argc, char *argv[])
{
GtkWidget *window;
g_thread_init (NULL);
gdk_threads_init ();
gtk_init (&amp;argc, &amp;argv);
window = create_window ();
gtk_widget_show (window);
gdk_threads_enter ();
gtk_main ();
gdk_threads_leave ();
return 0;
}
</programlisting>
</para>
<para>
Callbacks require a bit of attention. Callbacks from GTK+ signals
are made within the GTK+ lock. However callbacks from GLib (timeouts,
IO callbacks, and idle functions) are made outside of the GTK+
lock. So, within a signal handler you do not need to call
gdk_threads_enter(), but within the other types of callbacks, you
do.
</para>
<para>Erik Mouw contributed the following code example to
illustrate how to use threads within GTK+ programs.
</para>
<para>
<programlisting role="C">
/*-------------------------------------------------------------------------
* Filename: gtk-thread.c
* Version: 0.99.1
* Copyright: Copyright (C) 1999, Erik Mouw
* Author: Erik Mouw &lt;J.A.K.Mouw@its.tudelft.nl&gt;
* Description: GTK threads example.
* Created at: Sun Oct 17 21:27:09 1999
* Modified by: Erik Mouw &lt;J.A.K.Mouw@its.tudelft.nl&gt;
* Modified at: Sun Oct 24 17:21:41 1999
*-----------------------------------------------------------------------*/
/*
* Compile with:
*
* cc -o gtk-thread gtk-thread.c `gtk-config --cflags --libs gthread`
*
* Thanks to Sebastian Wilhelmi and Owen Taylor for pointing out some
* bugs.
*
*/
#include &lt;stdio.h&gt;
#include &lt;stdlib.h&gt;
#include &lt;unistd.h&gt;
#include &lt;time.h&gt;
#include &lt;gtk/gtk.h&gt;
#include &lt;glib.h&gt;
#include &lt;pthread.h&gt;
#define YES_IT_IS (1)
#define NO_IT_IS_NOT (0)
typedef struct
{
GtkWidget *label;
int what;
} yes_or_no_args;
G_LOCK_DEFINE_STATIC (yes_or_no);
static volatile int yes_or_no = YES_IT_IS;
void destroy(GtkWidget *widget, gpointer data)
{
gtk_main_quit();
}
void *argument_thread(void *args)
{
yes_or_no_args *data = (yes_or_no_args *)args;
gboolean say_something;
for(;;)
{
/* sleep a while */
sleep(rand() / (RAND_MAX / 3) + 1);
/* lock the yes_or_no_variable */
G_LOCK(yes_or_no);
/* do we have to say something? */
say_something = (yes_or_no != data->what);
if(say_something)
{
/* set the variable */
yes_or_no = data->what;
}
/* Unlock the yes_or_no variable */
G_UNLOCK(yes_or_no);
if(say_something)
{
/* get GTK thread lock */
gdk_threads_enter();
/* set label text */
if(data->what == YES_IT_IS)
gtk_label_set_text(GTK_LABEL(data->label), "O yes, it is!");
else
gtk_label_set_text(GTK_LABEL(data->label), "O no, it isn't!");
/* release GTK thread lock */
gdk_threads_leave();
}
}
return(NULL);
}
int main(int argc, char *argv[])
{
GtkWidget *window;
GtkWidget *label;
yes_or_no_args yes_args, no_args;
pthread_t no_tid, yes_tid;
/* init threads */
g_thread_init(NULL);
gdk_threads_init ();
/* init gtk */
gtk_init(&amp;argc, &amp;argv);
/* init random number generator */
srand((unsigned int)time(NULL));
/* create a window */
window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
gtk_signal_connect(GTK_OBJECT (window), "destroy",
GTK_SIGNAL_FUNC(destroy), NULL);
gtk_container_set_border_width(GTK_CONTAINER (window), 10);
/* create a label */
label = gtk_label_new("And now for something completely different ...");
gtk_container_add(GTK_CONTAINER(window), label);
/* show everything */
gtk_widget_show(label);
gtk_widget_show (window);
/* create the threads */
yes_args.label = label;
yes_args.what = YES_IT_IS;
pthread_create(&amp;yes_tid, NULL, argument_thread, &amp;yes_args);
no_args.label = label;
no_args.what = NO_IT_IS_NOT;
pthread_create(&amp;no_tid, NULL, argument_thread, &amp;no_args);
/* enter the GTK main loop */
gdk_threads_enter();
gtk_main();
gdk_threads_leave();
return(0);
}
</programlisting>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
@ -38,10 +232,11 @@ a signal handler with a gdk_threads_enter()/gdk_threads_leave() pair.
<!-- ##### MACRO GDK_THREADS_ENTER ##### -->
<para>
This macro marks the begin of a critical section
in which GDK and GTK+ functions can be called.
Only one thread at a time can be in such a critial
section.
This macro marks the beginning of a critical section in which GDK and GTK+
functions can be called. Only one thread at a time can be in such a
critial section. The macro expands to a no-op if #G_THREADS_ENABLED
has not been defined. Typically gdk_threads_enter() should be used
instead of this macro.
</para>
@ -63,22 +258,23 @@ begun with #GDK_THREADS_ENTER.
<!-- ##### FUNCTION gdk_threads_enter ##### -->
<para>
Enters a critical region like #GDK_THREADS_ENTER.
This macro marks the beginning of a critical section
in which GDK and GTK+ functions can be called.
Only one thread at a time can be in such a critial
section.
</para>
<!-- ##### FUNCTION gdk_threads_leave ##### -->
<para>
Leaves a critical region begun with gdk_threads_enter().
</para>
<!-- ##### VARIABLE gdk_threads_mutex ##### -->
<para>
The #GMutex used to implement the critical region for
gdk_threads_enter()/gdk_threads_leave().
gdk_threads_enter()/gdk_threads_leave(). This variable should not be
used directly &mdash; consider it private.
</para>

3
docs/reference/gtk/Makefile.am
View File

@ -123,9 +123,12 @@ HTML_IMAGES = \
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
content_files = \
building.sgml \
changes-1.2.sgml \
changes-2.0.sgml \
compiling.sgml \
framebuffer.sgml \
objects_grouped.sgml \
question_index.sgml \
resources.sgml \
text_widget.sgml \
tree_widget.sgml \

401
docs/reference/gtk/changes-1.2.sgml Normal file
View File

@ -0,0 +1,401 @@
<refentry id="gtk-changes-1-2" revision="1 Jan 2002">
<refmeta>
<refentrytitle>Changes from 1.0 to 1.2</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>Changes from 1.0 to 1.2</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Changes from 1.0 to 1.2</refname>
<refpurpose>
Incompatible changes made between version 1.0 and version 1.2
</refpurpose>
</refnamediv>
<refsect1>
<title>Incompatible changes from 1.0 to 1.2</title>
<itemizedlist>
<listitem>
<para>
GtkAcceleratorTable has been replaced with GtkAccelGroup.
</para>
</listitem>
<listitem>
<para>
GtkMenuFactory has been replaced with GtkItemFactory, although
a version of GtkMenuFactory is currently still provided to ease
the migration phase.
</para>
</listitem>
<listitem>
<para>
The GtkTypeInfo structures used in the gtk_*_type_init() functions have
changed a bit, the old format:
<programlisting>
GtkTypeInfo bin_info =
{
"GtkBin",
sizeof (GtkBin),
sizeof (GtkBinClass),
(GtkClassInitFunc) gtk_bin_class_init,
(GtkObjectInitFunc) gtk_bin_init,
(GtkArgSetFunc) NULL,
(GtkArgGetFunc) NULL,
};
</programlisting>
needs to be converted to:
<programlisting>
static const GtkTypeInfo bin_info =
{
"GtkBin",
sizeof (GtkBin),
sizeof (GtkBinClass),
(GtkClassInitFunc) gtk_bin_class_init,
(GtkObjectInitFunc) gtk_bin_init,
/* reserved_1 */ NULL,
/* reserved_2 */ NULL,
(GtkClassInitFunc) NULL,
};
</programlisting>
the GtkArgSetFunc and GtkArgGetFunc functions are not supported from the
type system anymore, and you should make sure that your code only fills
in these fields with NULL and doesn't use the deprecated function typedefs
(GtkArgSetFunc) and (GtkArgGetFunc) anymore.
</para>
</listitem>
<listitem>
<para>
A number of Gtk functions were renamed. For compatibility, gtkcompat.h
#define's the old 1.0.x function names in terms of the new names.
To assure your Gtk program doesn't rely on outdated function
variants, compile your program with -DGTK_DISABLE_COMPAT_H to disable
the compatibility aliases.
Here is the list of the old names and replacements:
<programlisting>
Old: Replacement:
gtk_accel_label_accelerator_width gtk_accel_label_get_accel_width
gtk_check_menu_item_set_state gtk_check_menu_item_set_active
gtk_container_border_width gtk_container_set_border_width
gtk_label_set gtk_label_set_text
gtk_notebook_current_page gtk_notebook_get_current_page
gtk_packer_configure gtk_packer_set_child_packing
gtk_paned_gutter_size gtk_paned_set_gutter_size
gtk_paned_handle_size gtk_paned_set_handle_size
gtk_scale_value_width gtk_scale_get_value_width
gtk_style_apply_default_pixmap gtk_style_apply_default_background (1)
gtk_toggle_button_set_state gtk_toggle_button_set_active
gtk_window_position gtk_window_set_position
(1) gtk_style_apply_default_background() has an additional
argument, gboolean set_bg. This parameter should be FALSE if
the background is being set for a NO_WINDOW widget, otherwise
true.
</programlisting>
</para>
</listitem>
<listitem>
<para>
During the development phase of the 1.1.x line of Gtk certain functions
were deprecated and later removed. Functions affected are:
<programlisting>
Removed: Replacement:
gtk_clist_set_border gtk_clist_set_shadow_type
gtk_container_block_resize gtk_container_set_resize_mode
gtk_container_unblock_resize gtk_container_set_resize_mode
gtk_container_need_resize gtk_container_check_resize
gtk_ctree_show_stub gtk_ctree_set_show_stub
gtk_ctree_set_reorderable gtk_clist_set_reorderable
gtk_ctree_set_use_drag_icons gtk_clist_set_use_drag_icons
gtk_entry_adjust_scroll (1)
gtk_object_class_add_user_signal gtk_object_class_user_signal_new
gtk_preview_put_row gtk_preview_put
gtk_progress_bar_construct gtk_progress_set_adjustment
gtk_scrolled_window_construct gtk_scrolled_window_set_{h|v}adjustment
gtk_spin_button_construct gtk_spin_button_configure
gtk_widget_thaw_accelerators gtk_widget_unlock_accelerators
gtk_widget_freeze_accelerators gtk_widget_lock_accelerators
(1) This function is no longer needed as GtkEntry should automatically
keep the scroll adjusted properly.
</programlisting>
</para>
</listitem>
<listitem>
<para>
Additionally, all gtk_*_interp functions were removed.
gtk_*_full versions were provided as of GTK+-1.0 and should
be used instead.
</para>
</listitem>
<listitem>
<para>
GtkButton has been changed to derive from GtkBin.
To access a button's child, use GTK_BIN (button)-&gt;child, instead
of the old GTK_BUTTON (button)-&gt;child.
</para>
</listitem>
<listitem>
<para>
The selection API has been slightly modified:
gtk_selection_add_handler() and gtk_selection_add_handler_full()
have been removed. To supply the selection, one now register
the targets one is interested in with:
<programlisting>
void gtk_selection_add_target (GtkWidget *widget,
GdkAtom selection,
GdkAtom target,
guint info);
</programlisting>
or:
<programlisting>
void gtk_selection_add_targets (GtkWidget *widget,
GdkAtom selection,
GtkTargetEntry *targets,
guint ntargets);
</programlisting>
When a request for a selection is received, the new "selection_get"
signal will be called:
<programlisting>
void "selection_get" (GtkWidget *widget,
GtkSelectionData *selection_data,
guint info,
guint time);
</programlisting>
A "time" parameter has also been added to the "selection_received"
signal.
<programlisting>
void "selection_received" (GtkWidget *widget,
GtkSelectionData *selection_data,
guint time);
</programlisting>
</para>
</listitem>
<listitem>
<para>
The old drag and drop API has been completely removed and replaced.
See the reference documentation for details on the new API.
</para>
</listitem>
<listitem>
<para>
Support for Themes has been added. In general, this does
not affect application code, however, a few new rules should
be observed:
<programlisting>
- To set a shape for a window, you must use
gtk_widget_shape_combine_mask() instead of
gdk_window_shape_combine_mask(), or the shape will be
reset when switching themes.
- It is no longer permissable to draw directly on an arbitrary
widget, or to set an arbitrary widget's background pixmap.
If you need to do that, use a GtkDrawingArea or (for a
toplevel) a GtkWindow where gtk_widget_set_app_paintable()
has been called.
</programlisting>
</para>
</listitem>
<listitem>
<para>
The ScrolledWindow widget no longer creates a Viewport
automatically. Instead, it has been generalized to accept
any "self-scrolling" widget.
</para>
<para>
The self-scrolling widgets in the Gtk+ core are GtkViewport,
GtkCList, GtkCTree, GtkText, and GtkLayout. All of these widgets can
be added to a scrolled window as normal children with
gtk_container_add() and scrollbars will be set up automatically.
</para>
<para>
To add scrollbars to a non self-scrolling widget, (such as a GtkList),
first add it to a viewport, then add the viewport to a scrolled window.
The scrolled window code provides a convenience function to do this:
<programlisting>
void gtk_scrolled_window_add_with_viewport (GtkScrolledWindow *scrollwin,
GtkWidget *child);
</programlisting>
This does exactly what it says - it creates a Viewport, adds the child
widget to it, then adds the Viewport to the scrolled window.
</para>
<para>
The scrollbars have been removed from the GtkCList and GtkCTree,
because they are now scrolled by simply adding them to a Scrolled
Window. The scrollbar policy is set on the scrolled window with
gtk_scrolled_window_set_policy() and not on the child widgets
(e.g. GtkCList's gtk_clist_set_policy() was removed).
</para>
</listitem>
<listitem>
<para>
The "main loop" of GTK+ has been moved to GLib. This should not
affect existing programs, since compatibility functions have
been provided. However, you may want to consider migrating
your code to use the GLib main loop directly.
</para>
</listitem>
<listitem>
<para>
the GTK_BASIC flag was removed, and with it the corresponding
macro and function GTK_WIDGET_BASIC() and gtk_widget_basic().
</para>
</listitem>
<listitem>
<para>
All freeze/thaw methods are now recursive - that is, if you
freeze a widget n times, you must also thaw it n times.
Therefore, if you have code like:
<programlisting>
gboolean frozen;
frozen = GTK_CLIST_FROZEN (clist);
gtk_clist_freeze (clist);
[...]
if (!frozen)
gtk_clist_thaw (clist);
it will not work anymore. It must be, simply:
gtk_clist_freeze (clist);
[...]
gtk_clist_thaw (clist);
</programlisting>
</para>
</listitem>
<listitem>
<para>
The thread safety in GTK+ 1.2 is slightly different than
that which appeared in early versions in the 1.1
development track. The main difference is that it relies on
the thread primitives in GLib, and on the thread-safe
GLib main loop.
</para>
<para>
This means:
<programlisting>
- You must call g_thread_init() before executing any
other GTK+ or GDK functions in a threaded GTK+ program.
- Idles, timeouts, and input functions are executed outside
of the main GTK+ lock. So, if you need to call GTK+
inside of such a callback, you must surround the callback
with a gdk_threads_enter()/gdk_threads_leave() pair.
[ However, signals are still executed within the main
GTK+ lock ]
In particular, this means, if you are writing widgets
that might be used in threaded programs, you _must_
surround timeouts and idle functions in this matter.
As always, you must also surround any calls to GTK+
not made within a signal handler with a
gdk_threads_enter()/gdk_threads_leave() pair.
- There is no longer a special --with-threads configure
option for GTK+. To use threads in a GTK+ program, you
must:
a) If you want to use the native thread implementation,
make sure GLib found this in configuration, otherwise,
call you must provide a thread implementation to
g_thread_init().
b) Link with the libraries returned by:
gtk-config --libs gthread
and use the cflags from:
gtk-config --cflags gthread
You can get these CFLAGS and LIBS by passing gthread
as the fourth parameter to the AM_PATH_GTK automake
macro.
</programlisting>
</para>
</listitem>
<listitem>
<para>
Prior to GTK+-1.2, there were two conflicting interpretations
of widget->requistion. It was either taken to be
the size that the widget requested, or that size
modified by calls to gtk_widget_set_usize(). In GTK+-1.2,
it is always interpreted the first way.
</para>
<para>
Container widgets are affected in two ways by this:
<programlisting>
1) Container widgets should not pass widget->requisition
as the second parameter to gtk_widget_size_request().
Instead they should call it like:
GtkRequisition child_requisition;
gtk_widget_size_request (widget, &amp;child_requisition);
2) Container widgets should not access child->requisition
directly. Either they should use the values returned
by gtk_widget_size_request(), or they should call
the new function:
void gtk_widget_get_child_requisition (GtkWidget *widget,
GtkRequisition *requisition);
which returns the requisition of the given widget, modified
by calls to gtk_widget_set_usize().
</programlisting>
</para>
</listitem>
</itemizedlist>
</refsect1>
</refentry>

1023
docs/reference/gtk/changes-2.0.sgml Normal file
View File

File diff suppressed because it is too large Load Diff

171
docs/reference/gtk/framebuffer.sgml
View File

@ -1,4 +1,4 @@
<refentry id="gtk-framebuffer" revision="4 Feb 2001">
<refentry id="gtk-framebuffer" revision="1 Jan 2002">
<refmeta>
<refentrytitle>Framebuffer</refentrytitle>
<manvolnum>3</manvolnum>
@ -6,19 +6,182 @@
</refmeta>
<refnamediv>
<refname>Framebuffer</refname>
<refname>Using GTK+ on the Framebuffer</refname>
<refpurpose>
Using embedded GTK+ on the Linux framebuffer
</refpurpose>
</refnamediv>
<refsect1>
<title>Framebuffer</title>
<title>GTK+ for the Linux Framebuffer</title>
<para>
The linux-fb port of GTK+, also known as GtkFB is an implementation of
GDK (and therefore GTK+) that runs on the linux framebuffer. It runs in
a single process that doesn't need X. It should run most GTK+ programs
without any changes to the source.
</para>
<refsect2><title>Build requirements</title>
<para>
You need GTK+ 2.0; the 1.2.x series does not have framebuffer support.
To compile GTK+ with framebuffer support you will need freetype 2, we
recommend FreeType 2.0.1 or later, as there was some problems with
freetype-config in 2.0. Make sure that you install freetype before
Pango, since Pango also needs it. Freetype can be found at
ftp://ftp.freetype.org
</para>
</refsect2>
<refsect2><title>Hardware requirements</title>
<para>
You need a graphics card with an availible framebuffer driver that can
run in 8, 16, 24 or 32 bpp, such as matroxfb or vesafb. You also need
a supported mouse. GTK+ currently supports the ps2 mouse, ms serial
mouse and fidmour touchscreen. Additional hardware support should
be simple to add.
</para>
</refsect2>
<refsect2><title>Building and installing</title>
<para>
First build and install glib and pango as usual, in that order.
Then configure Gtk by running configure (or autogen.sh if running from
CVS) with <literal>--with-gdktarget=linux-fb</literal>.
</para>
<para>Then compile as ususal: make; make install</para>
</refsect2>
<refsect2><title>Fonts</title>
<para>
Since GtkFB uses freetype 2 to render fonts it can render truetype and
postscript type 1 antialiased fonts.
</para>
<para>At startup it scans some directories looking for fonts. By default
it looks in $prefix/lib/ft2fonts, and if you want to change this you
must add something like:
<programlisting>
[PangoFT2]
FontPath = /usr/share/fonts/default/Type1:/usr/share/fonts/default/TrueType
</programlisting>
To your <filename>$prefix/etc/pango/pangorc</filename> or <filename>~/.pangorc</filename>.
</para>
<para>
You must also set up font aliases for the fonts Sans, Serif and
Monotype. This is done by creating a
<filename>$prefix/etc/pango/pangoft2.aliases</filename> or
<filename>~/.pangoft2_aliases</filename> file. You can also set the name of this file using
the key AliasFiles in the PangoFT2 section in pangorc.
</para>
<para>
An example of a font alias file for the urw fontset is:
<programlisting>
sans normal normal normal normal "urw gothic l"
serif normal normal normal normal "urw palladio l"
monospace normal normal normal normal "nimbus mono l"
</programlisting>
</para>
<para>
And one using the Windows truetype fonts is:
<programlisting>
sans normal normal normal normal "arial"
serif normal normal normal normal "times new roman"
monospace normal normal normal normal "courier new"
</programlisting>
A more detailed example can be found in examples/pangoft2.aliases in the
pango distribution.
</para>
</refsect2>
<refsect2><title>Running</title>
<para>
To run a program you should only need to start it, but there are some
things that can cause problems, and some things that can be controlled
by environment variables. Try testgtk distributed with GTK+ to test
if things work.
</para>
<para>
If you use a ps2 mouse, make sure that /dev/psaux is readable and
writable.
</para>
<para>Make sure gpm is not running.</para>
<para>If you don't specify anything GtkFB will start up in the current
virtual console in the current resolution and bit-depth. This can be
changed by specifying environment variables:
</para>
<para>
<programlisting>
GDK_VT:
unset means open on the current VT.
0-9: open on the specified VT. Make sure you have read/write rights
there.
new: Allocate a new VT after the last currently used one.
GDK_DISPLAY_MODE:
Specifies the name of a mode in /etc/fb.modes that you want to use.
GDK_DISPLAY_DEPTH:
Specify the desired bit depth of the framebuffer.
GDK_DISPLAY_WIDTH:
Specify the desired width of the framebuffer.
GDK_DISPLAY_HEIGHT:
Specify the desired height of the framebuffer.
GDK_DISPLAY:
Specify the framebuffer device to use. Default is /dev/fb0
GDK_MOUSE_TYPE:
Specify mouse type. Currently supported is:
ps2 - PS/2 mouse
imps2 - PS/2 intellimouse (wheelmouse)
ms - Microsoft serial mouse
fidmour - touch screen
Default is ps2.
GDK_KEYBOARD_TYPE:
Specify keyboard type. Currently supported is
xlate - normal tty mode keyboard.
Quite limited, cannot detect key up/key down events. Doesn't
handle ctrl/alt/shift for all keys. This is the default driver,
but should not be used in "production" use.
raw - read from the tty in RAW mode.
Sets the keyboard in RAW mode and handles all the keycodes. This
gives correct handling of modifiers and key up/down events. You
must be root to use this. If you use this for development or
debugging it is recommended to enable magic sysrq handling in the
kernel. Then you can use ALT-SysRQ-r to turn the keyboard back to
normal mode.
Default is xlate.
</programlisting>
</para>
</refsect2>
<refsect2><title>Debug features</title>
<para>Pressing Ctrl-Alt-Return repaints the whole screen.
Unfortunately this cannot be pressed when using the xlate keyboard
driver, so instead you can use shift-F1 instead when using this
driver.
</para>
<para>Pressing Ctrl-Alt-BackSpace kills the GtkFB program. (Can't be pressed
in the xlate driver.)</para>
</refsect2>
</refsect1>
</refentry>

11
docs/reference/gtk/gtk-docs.sgml
View File

@ -1,4 +1,4 @@
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!doctype book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
<!notation PNG system "PNG">
<!entity % local.notation.class "| PNG">
@ -152,6 +152,10 @@
<!entity gtk-Resources SYSTEM "resources.sgml">
<!entity gtk-Windows SYSTEM "windows.sgml">
<!entity gtk-Framebuffer SYSTEM "framebuffer.sgml">
<!entity gtk-Questions SYSTEM "question_index.sgml">
<!entity gtk-Changes-1-2 SYSTEM "changes-1.2.sgml">
<!entity gtk-Changes-2-0 SYSTEM "changes-2.0.sgml">
]>
<book id="index">
<bookinfo>
@ -241,9 +245,12 @@ that is, GUI components such as #GtkButton or #GtkTextView.
&gtk-Building;
&gtk-Compiling;
&gtk-Resources;
&gtk-Windows;
&gtk-Framebuffer;
&gtk-Changes-1-2;
&gtk-Changes-2-0;
&gtk-Resources;
&gtk-Questions;
</chapter>

197
docs/reference/gtk/question_index.sgml Normal file
View File

@ -0,0 +1,197 @@
<refentry id="gtk-question-index" revision="1 Jan 2002">
<refmeta>
<refentrytitle>Common Questions</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>Common Questions</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Common Questions</refname>
<refpurpose>
Find answers to common questions in the GTK+ manual
</refpurpose>
</refnamediv>
<refsect1>
<title>Questions and Answers</title>
<para>
This is an "index" of the reference manual organized by common "How do
I..." questions. If you aren't sure which documentation to read for
the question you have, this list is a good place to start.
</para>
<qandaset>
<qandadiv><title>General</title>
<qandaentry>
<question><para>
Where can I get help with GTK+, submit a bug report, or make a feature
request?
</para></question>
<answer>
<para>
See the <link linkend="gtk-resources">documentation on this topic</link>.
</para>
</answer>
</qandaentry>
<qandaentry>
<question><para>How do I port from one GTK+
version to another?</para></question>
<answer>
<para>
See the <link linkend="gtk-changes-2-0">list of incompatible changes
from 1.2 to 2.0</link>. Also, the <ulink
url="http://developer.gnome.org/dotplan/porting/">GNOME 2.0 porting
guide</ulink> on <ulink
url="http://developer.gnome.org">http://developer.gnome.org</ulink>
has some more detailed discussion of porting from 1.2 to 2.0.
You may also find useful information in the documentation for
specific widgets and functions.
</para>
<para>
If you have a question not covered in the manual, feel free to
ask on the mailing lists and please <ulink
url="http://bugzilla.gnome.org">file a bug report</ulink> against the
documentation.
</para>
</answer>
</qandaentry>
<qandaentry>
<question><para>
How does memory management work in GTK+? Should I free data returned
from functions?
</para></question>
<answer>
<para>
See the documentation for <link linkend="GObject">GObject</link> and
<link linkend="GtkObject">GtkObject</link>. For <link
linkend="GObject">GObject</link> note specifically <link
linkend="g-object-ref">g_object_ref()</link> and <link
linkend="g-object-unref">g_object_unref()</link>. <link
linkend="GtkObject">GtkObject</link> is a subclass of <link
linkend="GObject">GObject</link> so the same points apply, except that
it has a "floating" state (explained in its documentation).
</para>
<para>
For strings returned from functions, they will be declared "const"
(using <link linkend="G-CONST-RETURN-CAPS">G_CONST_RETURN</link>) if they
should not be freed. Non-const strings should be freed with <link
linkend="g-free">g_free()</link>. Arrays follow the same rule. (If
you find an exception to the rules, please report a bug to <ulink
url="http://bugzilla.gnome.org">http://bugzilla.gnome.org</ulink>.)
</para>
</answer>
</qandaentry>
<qandaentry>
<question><para>
How do I use GTK+ with threads?
</para></question>
<answer>
<para>
This is covered in the
<link linkend="gdk-Threads">GDK threads documentation</link>.
See also the <link linkend="glib-Threads">GThread</link> documentation for portable
threading primitives.
</para>
</answer>
</qandaentry>
</qandadiv>
<qandadiv><title><link linkend="GtkWidget">GtkWidget</link></title>
<qandaentry>
<question><para>
How do I change the color of a widget?
</para></question>
<answer><para>
See <link linkend="gtk-widget-modify-fg">gtk_widget_modify_fg()</link>,
<link linkend="gtk-widget-modify-bg">gtk_widget_modify_bg()</link>,
<link linkend="gtk-widget-modify-base">gtk_widget_modify_base()</link>,
and <link
linkend="gtk-widget-modify-text">gtk_widget_modify_text()</link>. See
<link linkend="gtk-Resource-Files">GTK+ resource files</link> for more
discussion. You can also change widget color by installing a resource
file and parsing it with <link
linkend="gtk-rc-add-default-file">gtk_rc_add_default_file()</link>.
The advantage of a resource file is that users can then override the
color you've chosen.
</para>
<para>To change the background color for widgets such as <link
linkend="GtkLabel">GtkLabel</link> that have no background, place them
in a <link linkend="GtkEventBox">GtkEventBox</link> and set the
background of the event box.
</para></answer>
</qandaentry>
</qandadiv>
<qandadiv><title><link linkend="GtkTextView">GtkTextView</link></title>
<qandaentry>
<question><para>
How do I get the contents of the entire text widget as a string?
</para></question>
<answer><para>
See <link
linkend="gtk-text-buffer-get-bounds">gtk_text_buffer_get_bounds()</link>
and <link
linkend="gtk-text-buffer-get-text">gtk_text_buffer_get_text()</link>
or <link
linkend="gtk-text-iter-get-text">gtk_text_iter_get_text()</link>.
</para>
<para>
<programlisting>
GtkTextIter start, end;
GtkTextBuffer *buffer;
char *text;
buffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (text_view));
gtk_text_buffer_get_bounds (buffer, &amp;start, &amp;end);
text = gtk_text_iter_get_text (&amp;start, &amp;end);
/* use text */
g_free (text);
</programlisting>
</para></answer>
</qandaentry>
</qandadiv>
</qandaset>
</refsect1>
</refentry>

6
docs/reference/gtk/text_widget.sgml
View File

@ -160,12 +160,12 @@ For text features that come from the theme &mdash; such as
font and foreground color &mdash use standard
<link linkend="GtkWidget">GtkWidget</link>
functions such as
<link linkend="gtk_widget_modify_font">gtk_widget_modify_font()</link>
<link linkend="gtk-widget-modify-font">gtk_widget_modify_font()</link>
or
<link linkend="gtk_widget_modify_fg">gtk_widget_modify_fg()</link>.
<link linkend="gtk-widget-modify-fg">gtk_widget_modify_fg()</link>.
For other attributes there are dedicated methods on
<link linkend="GtkTextView">GtkTextView</link> such as
<link linkend="gtk_text_view_set_tabs">gtk_text_view_set_tabs()</link>.
<link linkend="gtk-text-view-set-tabs">gtk_text_view_set_tabs()</link>.
<programlisting>
GtkWidget *view;

4
docs/reference/gtk/tmpl/gtkclipboard.sgml
View File

@ -11,8 +11,8 @@ Storing data on Clipboards.
the same process. Each clipboard is identified by a name encoded as a
#GdkAtom. (Conversion to and from strings can be done with
gdk_atom_intern() and gdk_atom_name().) The default clipboard
corresponds to the CLIPBOARD atom; another commonly used clipboard
is the PRIMARY clipboard, which, in X, traditionally contains
corresponds to the "CLIPBOARD" atom; another commonly used clipboard
is the "PRIMARY" clipboard, which, in X, traditionally contains
the currently selected text.
</para>
<para>

52
docs/reference/gtk/tmpl/gtkdrawingarea.sgml
View File

@ -6,9 +6,12 @@ a widget for custom user interface elements.
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkDrawingArea widget is used for creating custom
user interface elements. After creating a drawing
area, the application may want to connect to:
The #GtkDrawingArea widget is used for creating custom user interface
elements. It's essentially a blank widget; you can draw on
<literal>widget-&gt;window</literal>. After creating a drawing area,
the application may want to connect to:
<itemizedlist>
<listitem>
<para>
@ -19,12 +22,13 @@ area, the application may want to connect to:
<listitem>
<para>
The "realize" signal to take any necessary actions
when the widget
when the widget is instantiated on a particular display.
(Create GDK resources in response to this signal.)
</para>
</listitem>
<listitem>
<para>
The "size_allocate" signal to take any necessary actions
The "configure_event" signal to take any necessary actions
when the widget changes size.
</para>
</listitem>
@ -35,46 +39,46 @@ area, the application may want to connect to:
</para>
</listitem>
</itemizedlist>
As a convenience, the #GtkDrawingArea widget synthesizes
a "configure_event" when the widget is realized
and any time the size of a widget changes when it
is realized. It often suffices to connect to this
signal instead of "realize" and "size_allocate".
</para>
<para>
The following code portion demonstrates using a drawing
area to implement a widget that draws a circle.
As this example demonstrates, an expose handler should
draw only the pixels within the requested area and
should draw or clear all these pixels.
area to display a circle in the normal widget foreground
color.
Note that GDK automatically clears the exposed area
to the background color before sending the expose event, and
that drawing is implicitly clipped to the exposed area.
</para>
<example>
<title>Simple <structname>GtkDrawingArea</structname> usage.</title>
<programlisting>
gboolean
expose_event (GdkWidget *widget, GdkEventExpose *event, gpointer data)
expose_event_callback (GdkWidget *widget, GdkEventExpose *event, gpointer data)
{
gdk_window_clear_area (widget->window,
event->area.x, event->area.y,
event->area.width, event->area.height);
gdk_gc_set_clip_rectangle (widget->style->fg_gc[widget->state],
&amp;event->area);
gdk_draw_arc (widget->window,
widget->style->fg_gc[widget->state],
widget->style->fg_gc[GTK_WIDGET_STATE (widget)],
TRUE,
0, 0, widget->allocation.width, widget->allocation.height,
0, 64 * 360);
gdk_gc_set_clip_rectangle (widget->style->fg_gc[widget->state],
NULL);
return TRUE;
}
[...]
GtkWidget *drawing_area = gtk_drawing_area_new (<!>);
gtk_signal_connect (GTK_OBJECT (drawing_area),
gtk_widget_set_size_request (drawing_area, 100, 100);
g_signal_connect (G_OBJECT (drawing_area), "expose_event",
G_CALLBACK (expose_event_callback), NULL);
</programlisting>
</example>
<para>
Expose events are normally delivered when a drawing area first comes
onscreen, or when it's covered by another window and then uncovered
(exposed). You can also force an expose event by adding to the "damage
region" of the drawing area's window; gtk_widget_queue_draw_area() and
gdk_window_invalidate_rect() are equally good ways to do this. You'll
then get an expose event for the invalid region.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>

8
docs/reference/gtk/tmpl/gtkiconfactory.sgml
View File

@ -6,6 +6,14 @@ Themeable Stock Images
Manipulating stock icons
<!-- ##### SECTION Long_Description ##### -->
<para>
Browse the available stock icons in the list of stock IDs found <link
linkend="gtk-Stock-Items">here</link>. You can also use
the <application>gtk-demo</application> application for this purpose.
</para>
<para>
An icon factory manages a collection of #GtkIconSet; a #GtkIconSet manages a
set of variants of a particular icon (i.e. a #GtkIconSet contains variants for

5
docs/reference/gtk/tmpl/gtkpreview.sgml
View File

@ -2,12 +2,15 @@
GtkPreview
<!-- ##### SECTION Short_Description ##### -->
a widget to display RGB or grayscale data.
deprecated widget to display RGB or grayscale data.
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkPreview widget provides a simple interface
used to display images as RGB or grayscale data.
It's deprecated; just use a #GdkPixbuf displayed by a #GtkImage, or
perhaps a #GtkDrawingArea. #GtkPreview has no advantage over those
approaches.
</para>
<!-- ##### SECTION See_Also ##### -->

2
docs/reference/gtk/tmpl/gtkseparator.sgml
View File

@ -2,7 +2,7 @@
GtkSeparator
<!-- ##### SECTION Short_Description ##### -->
a base class for #GtkHSeparator and #GtkVseparator.
a base class for #GtkHSeparator and #GtkVSeparator.
<!-- ##### SECTION Long_Description ##### -->
<para>

19
docs/reference/gtk/tmpl/gtkstock.sgml
View File

@ -3,10 +3,27 @@ Stock Items
<!-- ##### SECTION Short_Description ##### -->
Prebuilt common menu/toolbar items and corresponding icons
<!-- ##### SECTION Long_Description ##### -->
<para>
Stock items represent commonly-used menu or toolbar items such as
"Open" or "Exit". Each stock item is identified by a stock ID;
stock IDs are just strings, but macros such as #GTK_STOCK_OPEN are
provided to avoid typing mistakes in the strings.
Applications can register their own stock items in addition to those
built-in to GTK+.
</para>
<para>
Each stock ID can be associated with a #GtkStockItem, which contains
the user-visible label, keyboard accelerator, and translation domain
of the menu or toolbar item; and/or with an icon stored in a
#GtkIconFactory. See <link
linkend="gtk-Themeable-Stock-Images">GtkIconFactory</link> for
more information on stock icons. The connection between a
#GtkStockItem and stock icons is purely conventional (by virtue of
using the same stock ID); it's possible to register a stock item but
no icon, and vice versa.
</para>
<!-- ##### SECTION See_Also ##### -->

31
gtk/gtkclipboard.c
View File

@ -88,18 +88,37 @@ static GQuark clipboards_owned_key_id = 0;
/**
* gtk_clipboard_get:
* @selection: a #GdkAtom which identifies the clipboard
* to use. A value of %GDK_NONE here is the
* same as <literal>gdk_atom_intern ("CLIPBOARD", FALSE)</literal>,
* and provides the default clipboard. Another
* common value is %GDK_SELECTION_PRIMARY, which
* identifies the primary X selection.
* to use.
*
* Returns the clipboard object for the given selection.
* Cut/copy/paste menu items and keyboard shortcuts should use
* the default clipboard, returned by passing #GDK_NONE for @selection.
* The currently-selected object or text should be provided on the clipboard
* identified by #GDK_SELECTION_PRIMARY. Cut/copy/paste menu items
* conceptually copy the contents of the #GDK_SELECTION_PRIMARY clipboard
* to the default clipboard, i.e. they copy the selection to what the
* user sees as the clipboard.
*
* (Passing #GDK_NONE is the same as using <literal>gdk_atom_intern
* ("CLIPBOARD", FALSE)</literal>. See
* <ulink url="http://www.freedesktop.org/standards/clipboards.txt">
* http://www.freedesktop.org/standards/clipboards.txt</ulink>
* for a detailed discussion of the "CLIPBOARD" vs. "PRIMARY" selections
* under the X window system. On Win32 the #GDK_SELECTION_PRIMARY
* clipboard is essentially ignored.)
*
* It's possible to have arbitrary named clipboards; if you do invent
* new clipboards, you should prefix the selection name with an
* underscore (because the ICCCM requires that nonstandard atoms are
* underscore-prefixed), and namespace it as well. For example,
* if your application called "Foo" has a special-purpose
* clipboard, you might call it "_FOO_SPECIAL_CLIPBOARD".
*
* Return value: the appropriate clipboard object. If no
* clipboard already exists, a new one will
* be created. Once a clipboard object has
* been created, it is persistent for all time.
* been created, it is persistent for all time and
* cannot be freed.
**/
GtkClipboard *
gtk_clipboard_get (GdkAtom selection)

15
gtk/gtktextbuffer.c
View File

@ -1451,7 +1451,7 @@ gtk_text_buffer_real_insert_anchor (GtkTextBuffer *buffer,
* when obtaining the buffer contents as a string, will be represented
* by the Unicode "object replacement character" 0xFFFC. Note that the
* "slice" variants for obtaining portions of the buffer as a string
* include this character for pixbufs, but the "text" variants do
* include this character for child anchors, but the "text" variants do
* not. e.g. see gtk_text_buffer_get_slice() and
* gtk_text_buffer_get_text(). Consider
* gtk_text_buffer_create_child_anchor() as a more convenient
@ -1481,7 +1481,9 @@ gtk_text_buffer_insert_child_anchor (GtkTextBuffer *buffer,
*
* This is a convenience function which simply creates a child anchor
* with gtk_text_child_anchor_new() and inserts it into the buffer
* with gtk_text_buffer_insert_child_anchor().
* with gtk_text_buffer_insert_child_anchor(). The new anchor is
* owned by the buffer; no reference count is returned to
* the caller of gtk_text_buffer_create_child_anchor().
*
* Return value: the created child anchor
**/
@ -1834,6 +1836,15 @@ gtk_text_buffer_get_selection_bound (GtkTextBuffer *buffer)
return gtk_text_buffer_get_mark (buffer, "selection_bound");
}
/**
* gtk_text_buffer_get_iter_at_child_anchor:
* @buffer: a #GtkTextBuffer
* @iter: an iterator to be initialized
* @anchor: a child anchor that appears in @buffer
*
* Obtains the location of @anchor within @buffer.
*
**/
void
gtk_text_buffer_get_iter_at_child_anchor (GtkTextBuffer *buffer,
GtkTextIter *iter,

33
gtk/gtktextchild.c
View File

@ -334,6 +334,16 @@ gtk_text_child_anchor_class_init (GtkTextChildAnchorClass *klass)
object_class->finalize = gtk_text_child_anchor_finalize;
}
/**
* gtk_text_child_anchor_new:
*
* Creates a new #GtkTextChildAnchor. Usually you would then insert
* it into a #GtkTextBuffer with gtk_text_buffer_insert_child_anchor().
* To perform the creation and insertion in one step, use the
* convenience function gtk_text_buffer_create_child_anchor().
*
* Return value: a new #GtkTextChildAnchor
**/
GtkTextChildAnchor*
gtk_text_child_anchor_new (void)
{
@ -375,6 +385,16 @@ gtk_text_child_anchor_finalize (GObject *obj)
anchor->segment = NULL;
}
/**
* gtk_text_child_anchor_get_widgets:
* @anchor: a #GtkTextChildAnchor
*
* Gets a list of all widgets anchored at this child anchor.
* The returned list should be freed with g_list_free().
*
*
* Return value: list of widgets anchored at @anchor
**/
GList*
gtk_text_child_anchor_get_widgets (GtkTextChildAnchor *anchor)
{
@ -398,6 +418,19 @@ gtk_text_child_anchor_get_widgets (GtkTextChildAnchor *anchor)
return list;
}
/**
* gtk_text_child_anchor_get_deleted:
* @anchor: a #GtkTextChildAnchor
*
* Determines whether a child anchor has been deleted from
* the buffer. Keep in mind that the child anchor will be
* unreferenced when removed from the buffer, so you need to
* hold your own reference (with g_object_ref()) if you plan
* to use this function &mdash; otherwise all deleted child anchors
* will also be finalized.
*
* Return value: %TRUE if the child anchor has been deleted from its buffer
**/
gboolean
gtk_text_child_anchor_get_deleted (GtkTextChildAnchor *anchor)
{

2
gtk/gtktextmark.c
View File

@ -218,7 +218,7 @@ gtk_text_mark_get_buffer (GtkTextMark *mark)
* gtk_text_mark_get_left_gravity:
* @mark: a #GtkTextMark
*
*
* Determines whether the mark has left gravity.
*
* Return value: %TRUE if the mark has left gravity, %FALSE otherwise
**/

259
gtk/gtktextview.c
View File

@ -1690,6 +1690,15 @@ gtk_text_view_scroll_to_mark (GtkTextView *text_view,
gtk_text_view_flush_scroll (text_view);
}
/**
* gtk_text_view_scroll_mark_onscreen:
* @text_view: a #GtkTextView
* @mark: a mark in the buffer for @text_view
*
* Scrolls @text_view the minimum distance such that @mark is contained
* within the visible area of the widget.
*
**/
void
gtk_text_view_scroll_mark_onscreen (GtkTextView *text_view,
GtkTextMark *mark)
@ -1864,6 +1873,15 @@ gtk_text_view_get_editable (GtkTextView *text_view)
return text_view->editable;
}
/**
* gtk_text_view_set_pixels_above_lines:
* @text_view: a #GtkTextView
* @pixels_above_lines: pixels above paragraphs
*
* Sets the default number of blank pixels above paragraphs in @text_view.
* Tags in the buffer for @text_view may override the defaults.
*
**/
void
gtk_text_view_set_pixels_above_lines (GtkTextView *text_view,
gint pixels_above_lines)
@ -1884,6 +1902,14 @@ gtk_text_view_set_pixels_above_lines (GtkTextView *text_view,
g_object_notify (G_OBJECT (text_view), "pixels_above_lines");
}
/**
* gtk_text_view_get_pixels_above_lines:
* @text_view: a #GtkTextView
*
* Gets the default number of pixels to put above paragraphs.
*
* Return value: default number of pixels above paragraphs
**/
gint
gtk_text_view_get_pixels_above_lines (GtkTextView *text_view)
{
@ -1892,6 +1918,16 @@ gtk_text_view_get_pixels_above_lines (GtkTextView *text_view)
return text_view->pixels_above_lines;
}
/**
* gtk_text_view_set_pixels_below_lines:
* @text_view: a #GtkTextView
* @pixels_below_lines: pixels below paragraphs
*
* Sets the default number of pixels of blank space
* to put below paragraphs in @text_view. May be overridden
* by tags applied to @text_view's buffer.
*
**/
void
gtk_text_view_set_pixels_below_lines (GtkTextView *text_view,
gint pixels_below_lines)
@ -1912,6 +1948,14 @@ gtk_text_view_set_pixels_below_lines (GtkTextView *text_view,
g_object_notify (G_OBJECT (text_view), "pixels_below_lines");
}
/**
* gtk_text_view_get_pixels_below_lines:
* @text_view: a #GtkTextView
*
* Gets the value set by gtk_text_view_set_pixels_below_lines().
*
* Return value: default number of blank pixels below paragraphs
**/
gint
gtk_text_view_get_pixels_below_lines (GtkTextView *text_view)
{
@ -1920,6 +1964,16 @@ gtk_text_view_get_pixels_below_lines (GtkTextView *text_view)
return text_view->pixels_below_lines;
}
/**
* gtk_text_view_set_pixels_inside_wrap:
* @text_view: a #GtkTextView
* @pixels_inside_wrap: default number of pixels between wrapped lines
*
* Sets the default number of pixels of blank space to leave between
* display/wrapped lines within a paragraph. May be overridden by
* tags in @text_view's buffer.
*
**/
void
gtk_text_view_set_pixels_inside_wrap (GtkTextView *text_view,
gint pixels_inside_wrap)
@ -1939,6 +1993,14 @@ gtk_text_view_set_pixels_inside_wrap (GtkTextView *text_view,
g_object_notify (G_OBJECT (text_view), "pixels_inside_wrap");
}
/**
* gtk_text_view_get_pixels_inside_wrap:
* @text_view: a #GtkTextView
*
* Gets the value set by gtk_text_view_set_pixels_inside_wrap().
*
* Return value: default number of pixels of blank space between wrapped lines
**/
gint
gtk_text_view_get_pixels_inside_wrap (GtkTextView *text_view)
{
@ -1947,19 +2009,28 @@ gtk_text_view_get_pixels_inside_wrap (GtkTextView *text_view)
return text_view->pixels_inside_wrap;
}
/**
* gtk_text_view_set_justification:
* @text_view: a #GtkTextView
* @justification: justification
*
* Sets the default justification of text in @text_view.
* Tags in the view's buffer may override the default.
*
**/
void
gtk_text_view_set_justification (GtkTextView *text_view,
GtkJustification justify)
GtkJustification justification)
{
g_return_if_fail (GTK_IS_TEXT_VIEW (text_view));
if (text_view->justify != justify)
if (text_view->justify != justification)
{
text_view->justify = justify;
text_view->justify = justification;
if (text_view->layout)
{
text_view->layout->default_style->justification = justify;
text_view->layout->default_style->justification = justification;
gtk_text_layout_default_style_changed (text_view->layout);
}
}
@ -1967,6 +2038,15 @@ gtk_text_view_set_justification (GtkTextView *text_view,
g_object_notify (G_OBJECT (text_view), "justification");
}
/**
* gtk_text_view_get_justification:
* @text_view: a #GtkTextView
*
* Gets the default justification of paragraphs in @text_view.
* Tags in the buffer may override the default.
*
* Return value: default justification
**/
GtkJustification
gtk_text_view_get_justification (GtkTextView *text_view)
{
@ -1975,6 +2055,15 @@ gtk_text_view_get_justification (GtkTextView *text_view)
return text_view->justify;
}
/**
* gtk_text_view_set_left_margin:
* @text_view: a #GtkTextView
* @left_margin: left margin in pixels
*
* Sets the default left margin for text in @text_view.
* Tags in the buffer may override the default.
*
**/
void
gtk_text_view_set_left_margin (GtkTextView *text_view,
gint left_margin)
@ -1995,6 +2084,15 @@ gtk_text_view_set_left_margin (GtkTextView *text_view,
g_object_notify (G_OBJECT (text_view), "left_margin");
}
/**
* gtk_text_view_get_left_margin:
* @text_view: a #GtkTextView
*
* Gets the default left margin size of paragraphs in the @text_view.
* Tags in the buffer may override the default.
*
* Return value: left margin in pixels
**/
gint
gtk_text_view_get_left_margin (GtkTextView *text_view)
{
@ -2003,6 +2101,15 @@ gtk_text_view_get_left_margin (GtkTextView *text_view)
return text_view->left_margin;
}
/**
* gtk_text_view_set_right_margin:
* @text_view: a #GtkTextView
* @right_margin: right margin in pixels
*
* Sets the default right margin for text in the text view.
* Tags in the buffer may override the default.
*
**/
void
gtk_text_view_set_right_margin (GtkTextView *text_view,
gint right_margin)
@ -2023,6 +2130,15 @@ gtk_text_view_set_right_margin (GtkTextView *text_view,
g_object_notify (G_OBJECT (text_view), "right_margin");
}
/**
* gtk_text_view_get_right_margin:
* @text_view: a #GtkTextView
*
* Gets the default right margin for text in @text_view. Tags
* in the buffer may override the default.
*
* Return value: right margin in pixels
**/
gint
gtk_text_view_get_right_margin (GtkTextView *text_view)
{
@ -2031,6 +2147,15 @@ gtk_text_view_get_right_margin (GtkTextView *text_view)
return text_view->right_margin;
}
/**
* gtk_text_view_set_indent:
* @text_view: a #GtkTextView
* @indent: indentation in pixels
*
* Sets the default indentation for paragraphs in @text_view.
* Tags in the buffer may override the default.
*
**/
void
gtk_text_view_set_indent (GtkTextView *text_view,
gint indent)
@ -2050,6 +2175,16 @@ gtk_text_view_set_indent (GtkTextView *text_view,
g_object_notify (G_OBJECT (text_view), "indent");
}
/**
* gtk_text_view_get_indent:
* @text_view: a #GtkTextView
*
* Gets the default indentation of paragraphs in @text_view.
* Tags in the view's buffer may override the default.
* The indentation may be negative.
*
* Return value: number of pixels of indentation
**/
gint
gtk_text_view_get_indent (GtkTextView *text_view)
{
@ -2058,6 +2193,15 @@ gtk_text_view_get_indent (GtkTextView *text_view)
return text_view->indent;
}
/**
* gtk_text_view_set_tabs:
* @text_view: a #GtkTextView
* @tabs: tabs as a #PangoTabArray
*
* Sets the default tab stops for paragraphs in @text_view.
* Tags in the buffer may override the default.
*
**/
void
gtk_text_view_set_tabs (GtkTextView *text_view,
PangoTabArray *tabs)
@ -2084,6 +2228,17 @@ gtk_text_view_set_tabs (GtkTextView *text_view,
g_object_notify (G_OBJECT (text_view), "tabs");
}
/**
* gtk_text_view_get_tabs:
* @text_view: a #GtkTextView
*
* Gets the default tabs for @text_view. Tags in the buffer may
* override the defaults. The returned array will be %NULL if
* "standard" (8-space) tabs are used. Free the return value
* with pango_tab_array_free().
*
* Return value: copy of default tab array, or %NULL if "standard" tabs are used; must be freed with pango_tab_array_free().
**/
PangoTabArray*
gtk_text_view_get_tabs (GtkTextView *text_view)
{
@ -6813,6 +6968,15 @@ add_child (GtkTextView *text_view,
gtk_widget_set_parent (vc->widget, GTK_WIDGET (text_view));
}
/**
* gtk_text_view_add_child_at_anchor:
* @text_view: a #GtkTextView
* @child: a #GtkWidget
* @anchor: a #GtkTextChildAnchor in the #GtkTextBuffer for @text_view
*
* Adds a child widget in the text buffer, at the given @anchor.
*
**/
void
gtk_text_view_add_child_at_anchor (GtkTextView *text_view,
GtkWidget *child,
@ -6925,6 +7089,22 @@ gtk_text_view_move_child (GtkTextView *text_view,
/* Iterator operations */
/**
* gtk_text_view_forward_display_line:
* @text_view: a #GtkTextView
* @iter: a #GtkTextIter
*
* Moves the given @iter forward by one display (wrapped) line. A
* display line is different from a paragraph. Paragraphs are
* separated by newlines or other paragraph separator characters.
* Display lines are created by line-wrapping a paragraph. If
* wrapping is turned off, display lines and paragraphs will be the
* same. Display lines are divided differently for each view, since
* they depend on the view's width; paragraphs are the same in all
* views, since they depend on the contents of the #GtkTextBuffer.
*
* Return value: %TRUE if @iter was moved and is not on the end iterator
**/
gboolean
gtk_text_view_forward_display_line (GtkTextView *text_view,
GtkTextIter *iter)
@ -6937,6 +7117,22 @@ gtk_text_view_forward_display_line (GtkTextView *text_view,
return gtk_text_layout_move_iter_to_next_line (text_view->layout, iter);
}
/**
* gtk_text_view_backward_display_line:
* @text_view: a #GtkTextView
* @iter: a #GtkTextIter
*
* Moves the given @iter backward by one display (wrapped) line. A
* display line is different from a paragraph. Paragraphs are
* separated by newlines or other paragraph separator characters.
* Display lines are created by line-wrapping a paragraph. If
* wrapping is turned off, display lines and paragraphs will be the
* same. Display lines are divided differently for each view, since
* they depend on the view's width; paragraphs are the same in all
* views, since they depend on the contents of the #GtkTextBuffer.
*
* Return value: %TRUE if @iter was moved and is not on the end iterator
**/
gboolean
gtk_text_view_backward_display_line (GtkTextView *text_view,
GtkTextIter *iter)
@ -6949,6 +7145,22 @@ gtk_text_view_backward_display_line (GtkTextView *text_view,
return gtk_text_layout_move_iter_to_previous_line (text_view->layout, iter);
}
/**
* gtk_text_view_forward_display_line_end:
* @text_view: a #GtkTextView
* @iter: a #GtkTextIter
*
* Moves the given @iter forward to the next display line end. A
* display line is different from a paragraph. Paragraphs are
* separated by newlines or other paragraph separator characters.
* Display lines are created by line-wrapping a paragraph. If
* wrapping is turned off, display lines and paragraphs will be the
* same. Display lines are divided differently for each view, since
* they depend on the view's width; paragraphs are the same in all
* views, since they depend on the contents of the #GtkTextBuffer.
*
* Return value: %TRUE if @iter was moved and is not on the end iterator
**/
gboolean
gtk_text_view_forward_display_line_end (GtkTextView *text_view,
GtkTextIter *iter)
@ -6961,6 +7173,22 @@ gtk_text_view_forward_display_line_end (GtkTextView *text_view,
return gtk_text_layout_move_iter_to_line_end (text_view->layout, iter, 1);
}
/**
* gtk_text_view_backward_display_line_start:
* @text_view: a #GtkTextView
* @iter: a #GtkTextIter
*
* Moves the given @iter backward to the next display line start. A
* display line is different from a paragraph. Paragraphs are
* separated by newlines or other paragraph separator characters.
* Display lines are created by line-wrapping a paragraph. If
* wrapping is turned off, display lines and paragraphs will be the
* same. Display lines are divided differently for each view, since
* they depend on the view's width; paragraphs are the same in all
* views, since they depend on the contents of the #GtkTextBuffer.
*
* Return value: %TRUE if @iter was moved and is not on the end iterator
**/
gboolean
gtk_text_view_backward_display_line_start (GtkTextView *text_view,
GtkTextIter *iter)
@ -6973,6 +7201,17 @@ gtk_text_view_backward_display_line_start (GtkTextView *text_view,
return gtk_text_layout_move_iter_to_line_end (text_view->layout, iter, -1);
}
/**
* gtk_text_view_starts_display_line:
* @text_view: a #GtkTextView
* @iter: a #GtkTextIter
*
* Determines whether @iter is at the start of a display line.
* See gtk_text_view_forward_display_line() for an explanation of
* display lines vs. paragraphs.
*
* Return value: %TRUE if @iter begins a wrapped line
**/
gboolean
gtk_text_view_starts_display_line (GtkTextView *text_view,
const GtkTextIter *iter)
@ -6985,6 +7224,18 @@ gtk_text_view_starts_display_line (GtkTextView *text_view,
return gtk_text_layout_iter_starts_line (text_view->layout, iter);
}
/**
* gtk_text_view_move_visually:
* @text_view: a #GtkTextView
* @iter: a #GtkTextIter
* @count: number of lines to move
*
* Moves @iter up or down by @count display (wrapped) lines.
* See gtk_text_view_forward_display_line() for an explanation of
* display lines vs. paragraphs.
*
* Return value: %TRUE if @iter moved and is not on the end iterator
**/
gboolean
gtk_text_view_move_visually (GtkTextView *text_view,
GtkTextIter *iter,