Compare commits
23 Commits
main
...
gtk-hp-pat
| Author | SHA1 | Date | |
|---|---|---|---|
|
b1eda0e8ff | ||
|
|
2fb994ca23 | ||
|
|
3a5915201e | ||
|
|
cc0de72d97 | ||
|
|
2331f8409b | ||
|
|
7d952d8f1c | ||
|
|
8ba862aa1e | ||
|
|
7cbdbc2b39 | ||
|
|
452f2ab948 | ||
|
|
d22a509cf7 | ||
|
|
dfc74e1264 | ||
|
|
44ea90db1d | ||
|
|
03f0f06701 | ||
|
|
7b8adae406 | ||
|
|
1cd3120250 | ||
|
|
c9a3d32f83 | ||
|
|
99ee206642 | ||
|
|
65b90602cb | ||
|
|
5897dce5ee | ||
|
|
09e170b33a | ||
|
|
ac1babccac | ||
|
|
a1f0128134 | ||
|
|
73efaabf4f |
16
ChangeLog
16
ChangeLog
@@ -1,3 +1,19 @@
|
||||
2000-06-27 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkwindow.c (gtk_window_destroy): call
|
||||
set_transient_for(NULL) instead of unset_transient_for()
|
||||
in order to ensure the signal gets emitted.
|
||||
|
||||
2000-06-26 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkstock.c: Code to add sample default stock items.
|
||||
|
||||
* gtk/gtkiconfactory.c: Code to add the sample default stock icons
|
||||
to the default icon factory
|
||||
|
||||
* gtk/stock-icons/Makefile.am: Add stock-icons directory with a
|
||||
Makefile.am and some sample stock icons
|
||||
|
||||
Fri Jun 23 17:54:23 2000 Tim Janik <timj@gtk.org>
|
||||
|
||||
* configure.in: make the current version number 1.3.1 (binary age 0,
|
||||
|
||||
@@ -1,3 +1,19 @@
|
||||
2000-06-27 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkwindow.c (gtk_window_destroy): call
|
||||
set_transient_for(NULL) instead of unset_transient_for()
|
||||
in order to ensure the signal gets emitted.
|
||||
|
||||
2000-06-26 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkstock.c: Code to add sample default stock items.
|
||||
|
||||
* gtk/gtkiconfactory.c: Code to add the sample default stock icons
|
||||
to the default icon factory
|
||||
|
||||
* gtk/stock-icons/Makefile.am: Add stock-icons directory with a
|
||||
Makefile.am and some sample stock icons
|
||||
|
||||
Fri Jun 23 17:54:23 2000 Tim Janik <timj@gtk.org>
|
||||
|
||||
* configure.in: make the current version number 1.3.1 (binary age 0,
|
||||
|
||||
@@ -1,3 +1,19 @@
|
||||
2000-06-27 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkwindow.c (gtk_window_destroy): call
|
||||
set_transient_for(NULL) instead of unset_transient_for()
|
||||
in order to ensure the signal gets emitted.
|
||||
|
||||
2000-06-26 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkstock.c: Code to add sample default stock items.
|
||||
|
||||
* gtk/gtkiconfactory.c: Code to add the sample default stock icons
|
||||
to the default icon factory
|
||||
|
||||
* gtk/stock-icons/Makefile.am: Add stock-icons directory with a
|
||||
Makefile.am and some sample stock icons
|
||||
|
||||
Fri Jun 23 17:54:23 2000 Tim Janik <timj@gtk.org>
|
||||
|
||||
* configure.in: make the current version number 1.3.1 (binary age 0,
|
||||
|
||||
@@ -1,3 +1,19 @@
|
||||
2000-06-27 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkwindow.c (gtk_window_destroy): call
|
||||
set_transient_for(NULL) instead of unset_transient_for()
|
||||
in order to ensure the signal gets emitted.
|
||||
|
||||
2000-06-26 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkstock.c: Code to add sample default stock items.
|
||||
|
||||
* gtk/gtkiconfactory.c: Code to add the sample default stock icons
|
||||
to the default icon factory
|
||||
|
||||
* gtk/stock-icons/Makefile.am: Add stock-icons directory with a
|
||||
Makefile.am and some sample stock icons
|
||||
|
||||
Fri Jun 23 17:54:23 2000 Tim Janik <timj@gtk.org>
|
||||
|
||||
* configure.in: make the current version number 1.3.1 (binary age 0,
|
||||
|
||||
@@ -1,3 +1,19 @@
|
||||
2000-06-27 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkwindow.c (gtk_window_destroy): call
|
||||
set_transient_for(NULL) instead of unset_transient_for()
|
||||
in order to ensure the signal gets emitted.
|
||||
|
||||
2000-06-26 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkstock.c: Code to add sample default stock items.
|
||||
|
||||
* gtk/gtkiconfactory.c: Code to add the sample default stock icons
|
||||
to the default icon factory
|
||||
|
||||
* gtk/stock-icons/Makefile.am: Add stock-icons directory with a
|
||||
Makefile.am and some sample stock icons
|
||||
|
||||
Fri Jun 23 17:54:23 2000 Tim Janik <timj@gtk.org>
|
||||
|
||||
* configure.in: make the current version number 1.3.1 (binary age 0,
|
||||
|
||||
@@ -1,3 +1,19 @@
|
||||
2000-06-27 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkwindow.c (gtk_window_destroy): call
|
||||
set_transient_for(NULL) instead of unset_transient_for()
|
||||
in order to ensure the signal gets emitted.
|
||||
|
||||
2000-06-26 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkstock.c: Code to add sample default stock items.
|
||||
|
||||
* gtk/gtkiconfactory.c: Code to add the sample default stock icons
|
||||
to the default icon factory
|
||||
|
||||
* gtk/stock-icons/Makefile.am: Add stock-icons directory with a
|
||||
Makefile.am and some sample stock icons
|
||||
|
||||
Fri Jun 23 17:54:23 2000 Tim Janik <timj@gtk.org>
|
||||
|
||||
* configure.in: make the current version number 1.3.1 (binary age 0,
|
||||
|
||||
@@ -1,3 +1,19 @@
|
||||
2000-06-27 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkwindow.c (gtk_window_destroy): call
|
||||
set_transient_for(NULL) instead of unset_transient_for()
|
||||
in order to ensure the signal gets emitted.
|
||||
|
||||
2000-06-26 Havoc Pennington <hp@redhat.com>
|
||||
|
||||
* gtk/gtkstock.c: Code to add sample default stock items.
|
||||
|
||||
* gtk/gtkiconfactory.c: Code to add the sample default stock icons
|
||||
to the default icon factory
|
||||
|
||||
* gtk/stock-icons/Makefile.am: Add stock-icons directory with a
|
||||
Makefile.am and some sample stock icons
|
||||
|
||||
Fri Jun 23 17:54:23 2000 Tim Janik <timj@gtk.org>
|
||||
|
||||
* configure.in: make the current version number 1.3.1 (binary age 0,
|
||||
|
||||
@@ -1002,6 +1002,7 @@ gdk/nanox/Makefile
|
||||
gdk/linux-fb/Makefile
|
||||
gtk/Makefile
|
||||
gtk/gtkcompat.h
|
||||
gtk/stock-icons/Makefile
|
||||
modules/Makefile
|
||||
modules/linux-fb/Makefile
|
||||
], [chmod +x gtk-config])
|
||||
|
||||
@@ -37,6 +37,11 @@ noinst_PROGRAMS = \
|
||||
testpixbuf-scale \
|
||||
pixbuf-demo
|
||||
|
||||
BUILT_SOURCES=test-inline-pixbufs.h
|
||||
|
||||
test-inline-pixbufs.h: $(top_builddir)/gdk-pixbuf/make-inline-pixbuf apple-red.png gnome-foot.png
|
||||
GDK_PIXBUF_MODULEDIR=$(top_builddir)/gdk-pixbuf/.libs $(top_builddir)/gdk-pixbuf/make-inline-pixbuf test-inline-pixbufs.h apple_red apple-red.png gnome_foot gnome-foot.png
|
||||
|
||||
testpixbuf_DEPENDENCIES = $(DEPS)
|
||||
testpixbuf_drawable_DEPENDENCIES = $(DEPS)
|
||||
testpixbuf_scale_DEPENDENCIES = $(DEPS)
|
||||
|
||||
@@ -25,6 +25,8 @@
|
||||
#include <gtk/gtk.h>
|
||||
#include <gtk/gdk-pixbuf-loader.h>
|
||||
|
||||
#include "test-inline-pixbufs.h"
|
||||
|
||||
typedef struct {
|
||||
FILE *imagefile;
|
||||
GdkPixbufLoader *loader;
|
||||
@@ -375,7 +377,7 @@ new_testrgb_window (GdkPixbuf *pixbuf, gchar *title)
|
||||
window = gtk_widget_new (gtk_window_get_type (),
|
||||
"GtkObject::user_data", NULL,
|
||||
"GtkWindow::type", GTK_WINDOW_TOPLEVEL,
|
||||
"GtkWindow::title", "testrgb",
|
||||
"GtkWindow::title", title ? title : "testrgb",
|
||||
"GtkWindow::allow_shrink", TRUE,
|
||||
NULL);
|
||||
gtk_signal_connect (GTK_OBJECT (window), "destroy",
|
||||
@@ -536,6 +538,13 @@ main (int argc, char **argv)
|
||||
new_testrgb_window (pixbuf, NULL);
|
||||
++xpmp;
|
||||
}
|
||||
|
||||
/* Test loading from inline data. */
|
||||
pixbuf = gdk_pixbuf_new_from_inline (apple_red, FALSE);
|
||||
new_testrgb_window (pixbuf, "Red apple from inline data");
|
||||
|
||||
pixbuf = gdk_pixbuf_new_from_inline (gnome_foot, TRUE);
|
||||
new_testrgb_window (pixbuf, "Foot from inline data");
|
||||
|
||||
found_valid = TRUE;
|
||||
} else {
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
Damon Chaplin <damon@karuna.freeserve.co.uk> and others.
|
||||
|
||||
See:
|
||||
|
||||
http://www.gtk.org/rdp/status.html
|
||||
|
||||
for a complete list.
|
||||
@@ -1,30 +0,0 @@
|
||||
This work may be reproduced and distributed in whole or in part, in
|
||||
any medium, physical or electronic, so as long as this copyright
|
||||
notice remains intact and unchanged on all copies. Commercial
|
||||
redistribution is permitted and encouraged, but you may not
|
||||
redistribute, in whole or in part, under terms more restrictive than
|
||||
those under which you received it. If you redistribute a modified or
|
||||
translated version of this work, you must also make the source code to
|
||||
the modified or translated version available in electronic form
|
||||
without charge. However, mere aggregation as part of a larger work
|
||||
shall not count as a modification for this purpose.
|
||||
|
||||
All code examples in this work are placed into the public domain,
|
||||
and may be used, modified and redistributed without restriction.
|
||||
|
||||
BECAUSE THIS WORK IS LICENSED FREE OF CHARGE, THERE IS NO
|
||||
WARRANTY FOR THE WORK, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
|
||||
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
|
||||
OTHER PARTIES PROVIDE THE WORK "AS IS" WITHOUT WARRANTY OF ANY
|
||||
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. SHOULD THE WORK PROVE DEFECTIVE, YOU ASSUME
|
||||
THE COST OF ALL NECESSARY REPAIR OR CORRECTION.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
|
||||
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
|
||||
AND/OR REDISTRIBUTE THE WORK AS PERMITTED ABOVE, BE LIABLE TO YOU
|
||||
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
|
||||
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
|
||||
WORK, EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
@@ -1,269 +0,0 @@
|
||||
2000-06-14 Damon Chaplin <damon@helixcode.com>
|
||||
|
||||
* gtk/tmpl/gtktooltips.sgml: added a note about no-window widgets.
|
||||
|
||||
Mon Jun 5 11:17:25 2000 Owen Taylor <otaylor@redhat.com>
|
||||
|
||||
* gdk/tmpl/general.sgml: Fix gdk_pointer_grab description
|
||||
as pointed out by Dave Morse.
|
||||
|
||||
Sun May 28 12:16:01 2000 Owen Taylor <otaylor@redhat.com>
|
||||
|
||||
* gtk/tmpl/gtkaspectframe.sgml: Fix typo
|
||||
pointed out by Gregory McLean.
|
||||
|
||||
2000-05-28 Damon Chaplin <damon@helixcode.com>
|
||||
|
||||
* gdk/tmpl/event_structs.sgml: typo.
|
||||
|
||||
2000-04-22 Damon Chaplin <damon@helixcode.com>
|
||||
|
||||
* gtk/tmpl/gtkenums.sgml: update from Lee Mallabone
|
||||
<lee0@callnetuk.com>
|
||||
|
||||
2000-04-09 Damon Chaplin <damon@helixcode.com>
|
||||
|
||||
* gtk/tmpl/gtkmain.sgml: update from Torsten Landschoff
|
||||
<t.landschoff@gmx.net>
|
||||
|
||||
* gdk/tmpl/input_methods.sgml:
|
||||
* gdk/tmpl/general.sgml: fixed typos.
|
||||
|
||||
Tue Mar 14 14:17:46 2000 Raph Levien <raph@acm.org>
|
||||
|
||||
* gdk/tmpl/rgb.sgml: Better explanation of gdk_rgb_set_min_colors.
|
||||
Thanks to Stric for spotting it.
|
||||
|
||||
2000-03-07 Damon Chaplin <damon@helixcode.com>
|
||||
|
||||
* gtk/tmpl/gtkclist.sgml: fix to gtk_clist_set_reorderable(). It
|
||||
reorders rows, not columns. From Guy Harris <gharris@flashcom.net>.
|
||||
|
||||
2000-02-29 Damon Chaplin <damon@helixcode.com>
|
||||
|
||||
* gtk/tmpl/gtkmenuitem.sgml: minor fix from Nicolas GEORGE
|
||||
<nicolas.george@ens.fr>.
|
||||
|
||||
2000-02-28 Damon Chaplin <damon@helixcode.com>
|
||||
|
||||
* gtk/tmpl/gtkradiomenuitem.sgml:
|
||||
* gtk/tmpl/gtkmenuitem.sgml:
|
||||
* gtk/tmpl/gtknotebook.sgml: new menu item sections and minor update to
|
||||
notebook section from Nicolas GEORGE <nicolas.george@ens.fr>.
|
||||
|
||||
2000-02-18 Damon Chaplin <damon@helixcode.com>
|
||||
|
||||
* gtk/tmpl/gtktooltips.sgml: patch from
|
||||
David Benson <daveb@idealab.com> to note that gtk_tooltips_set_colors()
|
||||
does not work.
|
||||
|
||||
2000-02-09 Damon Chaplin <damon@helixcode.com>
|
||||
|
||||
* gdk/tmpl/input_methods.sgml: minor fix.
|
||||
|
||||
2000-02-03 Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
* gdk/gdk-sections.txt: rearranged a bit.
|
||||
|
||||
* gdk/tmpl/event_structs.sgml: updated.
|
||||
|
||||
* gtk/gtk-sections.txt: added INCLUDE tag for Private Info section.
|
||||
|
||||
* gdk/tmpl/color_contexts.sgml: added note saying it is deprecated.
|
||||
* gdk/tmpl/dnd.sgml: added note saying read the GTK+ DnD docs.
|
||||
|
||||
2000-02-02 Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
* gdk/tmpl/*.sgml: ran make templates.
|
||||
|
||||
* gdk/gdk-docs.sgml: rearranged sections.
|
||||
|
||||
* gdk/tmpl/events.sgml: documented.
|
||||
|
||||
* gdk/tmpl/general.sgml: documented.
|
||||
|
||||
* gdk/tmpl/rgb.sgml: fixed a few '@' -> '#'.
|
||||
|
||||
* gdk/gdk-sections.txt: rearranged a few bits, including moving
|
||||
GdkWChar and related functions from the input method section to the
|
||||
font section, and GdkCapStyle etc. from Drawing Primitives to GCs.
|
||||
|
||||
* gdk/tmpl/images.sgml: documented.
|
||||
|
||||
* gdk/tmpl/drawing.sgml: updated.
|
||||
|
||||
* gdk/tmpl/regions.sgml: updated.
|
||||
|
||||
* gdk/tmpl/input_contexts.sgml: documented.
|
||||
|
||||
* gdk/tmpl/input_methods.sgml: documented.
|
||||
|
||||
* gdk/tmpl/selections.sgml: changed xref to a link since Jade says
|
||||
a xref to a RefEntry is not supported.
|
||||
|
||||
2000-01-19 Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
* gtk/tmpl/gtkscrollbar.sgml: Started.
|
||||
|
||||
2000-01-08 Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
* gtk/tmpl/gtkclist.sgml: update from Paul Schifferer
|
||||
<isengard@geocities.com>
|
||||
|
||||
Wed Jan 5 10:23:41 2000 Owen Taylor <otaylor@redhat.com>
|
||||
|
||||
* gtk/tmpl/gtkprogress.sgml: Missing </listitem>, remove extra <para>
|
||||
* gtk/tmpl/gtkobject.sgml: dos2unix
|
||||
* gtk/tmpl/gtkcurve.sgml: missing </para>
|
||||
* gtk/tmpl/gtkarg.sgml: dos2unix, missing </para>
|
||||
* gtk/tmpl/gtkcolorsel.sgml: Missing </listitem>'s
|
||||
* gtk/tmpl/gtksignal.sgml (signal): dos2unix, missing </para>'s
|
||||
* gtk/tmpl/gtkmarshal.sgml: Missing </refsect2>
|
||||
|
||||
1999-11-16 Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
* gtk/tmpl/gtkmenubar.sgml: fixed minor error - using <em>.
|
||||
|
||||
* gtk/tmpl/gtknotebook.sgml:
|
||||
* gtk/tmpl/gtklist.sgml: new sections from
|
||||
Nicolas George <george@clipper.ens.fr>, with help from
|
||||
"Bob Springett" <bobspringett@claranet.fr>.
|
||||
|
||||
* gtk/tmpl/gtkobject.sgml:
|
||||
* gtk/tmpl/gtkarg.sgml: new sections from
|
||||
David Benson <daveb@idealab.com>.
|
||||
|
||||
* gtk/tmpl/gtkvbox.sgml:
|
||||
* gtk/tmpl/gtkhbox.sgml: fixed line endings.
|
||||
|
||||
* gtk/tmpl/gtkvbbox.sgml: update from Lee Mallabone
|
||||
<lee0@callnetuk.com>
|
||||
|
||||
* gdk/tmpl/drawing.sgml: fixed error in gdk_draw_arc() @angle2 param
|
||||
- it is relative to @angle1 rather than from the 3 o'clock position.
|
||||
|
||||
* gtk/tmpl/gtkfontseldlg.sgml: changed enums to use @ fields.
|
||||
|
||||
* gtk/tmpl/gtkcolorsel.sgml:
|
||||
* gtk/tmpl/gtkcolorseldlg.sgml:
|
||||
* gtk/tmpl/gtkprogress.sgml:
|
||||
* gtk/tmpl/gtkprogressbar.sgml: new sections from Tom Martone
|
||||
<tom@martoneconsulting.com>
|
||||
|
||||
* gtk/tmpl/gtkclist.sgml: partially written documentation from
|
||||
Paul Schifferer <isengard@geocities.com> who won't be able to finish it
|
||||
|
||||
1999-09-22 Martin Norb<72>ck <d95mback@dtek.chalmers.se>
|
||||
|
||||
* gtk/tmpl/gtkclist.sgml: Added information about the sorting functions
|
||||
|
||||
Tue Oct 26 16:50:15 1999 Owen Taylor <otaylor@redhat.com>
|
||||
|
||||
* gtk/tmpl/gtkrc.sgml: Added information about widget
|
||||
paths and pattern matching.
|
||||
|
||||
1999-09-22 Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
* gtk/tmpl/*.sgml: ran make templates, to fix problems with structs.
|
||||
|
||||
* gtk/gtk-sections.txt: rearranged GtkCombo section.
|
||||
|
||||
* gtk/tmpl/gtkvseparator.sgml:
|
||||
* gtk/tmpl/gtkhseparator.sgml:
|
||||
* gtk/tmpl/gtkgc.sgml:
|
||||
* gtk/tmpl/gtkfeatures.sgml:
|
||||
* gtk/tmpl/gtktipsquery.sgml:
|
||||
* gtk/tmpl/gtkitem.sgml:
|
||||
* gtk/tmpl/gtkinvisible.sgml:
|
||||
* gtk/tmpl/gtkgamma.sgml:
|
||||
* gtk/tmpl/gtkdata.sgml:
|
||||
* gtk/tmpl/gtkcurve.sgml:
|
||||
* gtk/tmpl/gtkcombo.sgml:
|
||||
* gtk/tmpl/gtkaccellabel.sgml: documented.
|
||||
|
||||
1999-09-20 Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
* gtk/gtk-docs.sgml: added role="no-toc" to the GTK+ Widgets & Objects
|
||||
chapter since we've created our own special contents page.
|
||||
|
||||
1999-09-19 Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
* gtk/tmpl/gtkmarshal.sgml:
|
||||
* gtk/tmpl/gtksignal.sgml: new sections from
|
||||
David Benson <daveb@idealab.com>.
|
||||
|
||||
* gtk/gtk-sections.txt: rearranged signal sections, and made most
|
||||
marshallers private. Moved GtkSignalRunType to signals section.
|
||||
|
||||
* gtk/tmpl/gtkradiobutton.sgml: new section from Lee Mallabone.
|
||||
|
||||
1999-09-17 Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
* gtk/gtk-docs.sgml: removed menu factory and debugging sections.
|
||||
|
||||
* gtk/gtk-sections.txt: made menu factory stuff private since it is
|
||||
deprecated. Also made debugging stuff private since it is only useful
|
||||
within GTK+.
|
||||
|
||||
1999-09-14 Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
* gtk/tmpl/gtkfilesel.sgml: fixed mismatched parentheses.
|
||||
|
||||
1999-09-02 Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
* gdk/tmpl/event_structs.sgml:
|
||||
* gdk/tmpl/drawing.sgml: minor fixes.
|
||||
|
||||
1999-09-20 David C. Mason <dcm@redhat.com>
|
||||
|
||||
* gtk/tmpl/gtkimage.sgml: first pass at gtkimage... not complete
|
||||
|
||||
1999-08-28 Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
* gtk/tmpl/gtkbbox.sgml: new section from Lee Mallabone.
|
||||
|
||||
* gdk/gdk-sections.txt: rearranged rgb, regions, and drawing sections.
|
||||
|
||||
* gdk/tmpl/rgb.sgml: new section from Raph Levien, with a few changes
|
||||
by me, including a little example app.
|
||||
|
||||
* gdk/tmpl/regions.sgml:
|
||||
* gdk/tmpl/event_structs.sgml:
|
||||
* gdk/tmpl/drawing.sgml: my first attempt.
|
||||
* gdk/tmpl/cursors.sgml: tiny changes.
|
||||
|
||||
Tue Aug 17 09:14:01 1999 Owen Taylor <otaylor@redhat.com>
|
||||
|
||||
* gtk/tmpl/gtktypeutils.sgml: Fix corrupted end tag.
|
||||
|
||||
* gtk/tmpl/gtkselection.sgml gtk/tmpl/gtkrc.sgml
|
||||
gtk/tmpl/gtkdnd.sgml gtk/tmpl/gtkarrow.sgml
|
||||
gtk/tmpl/gtkpaned.sgml gtk/tmpl/gtkmisc.sgml
|
||||
gtk/tmpl/gtkhandlebox.sgml gtk/tmpl/gtkctree.sgml:
|
||||
Added missing close tags.
|
||||
|
||||
Thu Aug 19 14:43:08 1999 Owen Taylor <otaylor@redhat.com>
|
||||
|
||||
* gdk/tmpl/gcs.sgml gdk/gdk-sections.txt: Added section.
|
||||
(Written a while ago but fell through the cracks)
|
||||
|
||||
* gtk/gtk-docs.sgml: Add a &hash; entity here as a
|
||||
temporary hack. (There is no standard entity
|
||||
for '#', and no way of escaping '#' in gtk-doc)
|
||||
|
||||
* gtk/tmpl/gtkrc.sgml: Use the above to fix up #rrggbb
|
||||
string literals.
|
||||
|
||||
* gtk/tmpl/gtkdrawingarea.sgml: Fixed a couple
|
||||
of errors in the example. (pointed out by
|
||||
Nick Lamb)
|
||||
|
||||
Mon Aug 16 6:60:53 1999 Owen Taylor <otaylor@redhat.com>
|
||||
|
||||
* gdk/tmpl/properties.sgml
|
||||
gdk/tmpl/selections.sgml
|
||||
gdk/tmpl/input_devices.sgml: Documented
|
||||
|
||||
* gdk/gdk-sections.txt: Moved around types for
|
||||
input devices properties and selections, marked
|
||||
a few functions as private.
|
||||
@@ -1,62 +0,0 @@
|
||||
This package contains the reference documentation
|
||||
for GTK+. For more information about GTK+
|
||||
see:
|
||||
|
||||
http://www.gtk.org
|
||||
|
||||
For information about contributing to the
|
||||
GLib/GTK+ reference documentation project, see:
|
||||
|
||||
http://www.gtk.org/rdp/
|
||||
|
||||
The GTK+ reference documentation is freely redistributable,
|
||||
see the file COPYING for details.
|
||||
|
||||
|
||||
REQUIREMENTS
|
||||
============
|
||||
|
||||
To build the documentation, you must have the gtk-doc
|
||||
package installed. To rebuild the template files,
|
||||
you must have the current version of the GTK+
|
||||
header files installed.
|
||||
|
||||
|
||||
BUILD
|
||||
=====
|
||||
|
||||
First, run configure to generate the makefiles for this
|
||||
module. There is one option specific to this package
|
||||
|
||||
--with-html-dir=DIR top of installed HTML documentation tree
|
||||
|
||||
|
||||
The Makefiles in the gdk/ and gtk/ subdirs each define three targets:
|
||||
|
||||
templates:
|
||||
|
||||
Scan the headers and merge the results with the current
|
||||
template files
|
||||
|
||||
sgml:
|
||||
|
||||
Generate SGML files using the DocBook DTD from
|
||||
the template files
|
||||
|
||||
html:
|
||||
|
||||
Generate HTML from the SGML files.
|
||||
|
||||
To build the documentation, do:
|
||||
|
||||
make sgml
|
||||
make html
|
||||
|
||||
You should only run the 'make templates' step if you
|
||||
need to regenerate the templates for a more recent
|
||||
version of the GTK+ sources.
|
||||
|
||||
INSTALLATION
|
||||
============
|
||||
|
||||
make install
|
||||
@@ -1,39 +0,0 @@
|
||||
Before making any changes to this module, please
|
||||
contact:
|
||||
|
||||
Damon Chaplin <damon@karuna.freeserve.co.uk>
|
||||
|
||||
This will ensure that duplicate work does not occur,
|
||||
and also make sure we know who has written what
|
||||
parts of the documentation. See
|
||||
|
||||
http://www.gtk.org/rdp/
|
||||
|
||||
for more information.
|
||||
|
||||
By contributing work to the Reference Documentation
|
||||
Project, you agree that it will be covered under the
|
||||
license terms described in the file COPYING
|
||||
included in this directory.
|
||||
|
||||
|
||||
Other notes:
|
||||
|
||||
- Do not run 'make templates' unless you have
|
||||
the latest cvs version of the gtk-1-2
|
||||
branch of GTK+ and the latest CVS version
|
||||
of gtk-doc.
|
||||
|
||||
(This is very important. Otherwise, the template
|
||||
files may be come corrupted.)
|
||||
|
||||
Make sure that gtk-config --prefix points
|
||||
to the correct version of GTK+.
|
||||
|
||||
- As always, ChangeLog entries should be made for
|
||||
each commit. These can be really brief
|
||||
"documented GHashTable"; but if you are editing
|
||||
something someone else wrote, please be specific.
|
||||
(Or better, send the changes to them for their
|
||||
approval, first)
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
Makefile
|
||||
Makefile.in
|
||||
sgml
|
||||
html
|
||||
gdk-decl-list.txt
|
||||
gdk-unused.txt
|
||||
@@ -1,50 +0,0 @@
|
||||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
# The name of the module.
|
||||
DOC_MODULE=gdk
|
||||
|
||||
# The top-level SGML file.
|
||||
DOC_MAIN_SGML_FILE=gdk-docs.sgml
|
||||
|
||||
# We could alternatively use this for using installed headers.
|
||||
INCLUDE_DIR=`gtk-config --prefix`/include/gdk
|
||||
|
||||
|
||||
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
|
||||
|
||||
scan:
|
||||
gtkdoc-scan --module=$(DOC_MODULE) $(INCLUDE_DIR)/gdk.h $(INCLUDE_DIR)/gdktypes.h $(INCLUDE_DIR)/gdkrgb.h
|
||||
|
||||
templates: scan
|
||||
gtkdoc-mktmpl --module=$(DOC_MODULE)
|
||||
|
||||
sgml:
|
||||
gtkdoc-mkdb --module=$(DOC_MODULE)
|
||||
|
||||
html:
|
||||
if ! test -d html ; then mkdir html ; fi
|
||||
-cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
|
||||
|
||||
clean-local:
|
||||
rm -f *~ *.bak *.hierarchy *.signals *.args *-unused.txt
|
||||
|
||||
maintainer-clean-local: clean
|
||||
rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
|
||||
|
||||
install-data-local:
|
||||
install -d -m 0755 $(TARGET_DIR)
|
||||
install -m 0644 html/*.html $(TARGET_DIR)
|
||||
install -m 0644 html/index.sgml $(TARGET_DIR)
|
||||
gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)
|
||||
|
||||
EXTRA_DIST = \
|
||||
$(DOC_MAIN_SGML_FILE) \
|
||||
$(DOC_MODULE)-sections.txt \
|
||||
gdk-overrides.txt \
|
||||
gdk-decl.txt
|
||||
|
||||
dist-hook:
|
||||
mkdir $(distdir)/tmpl
|
||||
cp -p tmpl/*.sgml $(distdir)/tmpl
|
||||
|
||||
.PHONY : html sgml templates scan
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,72 +0,0 @@
|
||||
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
|
||||
<!entity gdk-General SYSTEM "sgml/general.sgml">
|
||||
<!entity gdk-Bitmaps-and-Pixmaps SYSTEM "sgml/pixmaps.sgml">
|
||||
<!entity gdk-Images SYSTEM "sgml/images.sgml">
|
||||
<!entity gdk-GdkRGB SYSTEM "sgml/rgb.sgml">
|
||||
<!entity gdk-Colormaps-and-Colors SYSTEM "sgml/colors.sgml">
|
||||
<!entity gdk-Fonts SYSTEM "sgml/fonts.sgml">
|
||||
<!entity gdk-Drawing-Primitives SYSTEM "sgml/drawing.sgml">
|
||||
<!entity gdk-Graphics-Contexts SYSTEM "sgml/gcs.sgml">
|
||||
<!entity gdk-Visuals SYSTEM "sgml/visuals.sgml">
|
||||
<!entity gdk-Windows SYSTEM "sgml/windows.sgml">
|
||||
<!entity gdk-Selections SYSTEM "sgml/selections.sgml">
|
||||
<!entity gdk-Properties-and-Atoms SYSTEM "sgml/properties.sgml">
|
||||
<!entity gdk-Input-Methods SYSTEM "sgml/input_methods.sgml">
|
||||
<!entity gdk-Input-Contexts SYSTEM "sgml/input_contexts.sgml">
|
||||
<!entity gdk-Color-Contexts SYSTEM "sgml/color_contexts.sgml">
|
||||
<!entity gdk-Points-Rectangles-and-Regions SYSTEM "sgml/regions.sgml">
|
||||
<!entity gdk-Threads SYSTEM "sgml/threads.sgml">
|
||||
<!entity gdk-Key-Values SYSTEM "sgml/keys.sgml">
|
||||
<!entity gdk-Input-Devices SYSTEM "sgml/input_devices.sgml">
|
||||
<!entity gdk-Events SYSTEM "sgml/events.sgml">
|
||||
<!entity gdk-Event-Structures SYSTEM "sgml/event_structs.sgml">
|
||||
<!entity gdk-Cursors SYSTEM "sgml/cursors.sgml">
|
||||
<!entity gdk-Input SYSTEM "sgml/input.sgml">
|
||||
<!entity gdk-Drag-and-Drop SYSTEM "sgml/dnd.sgml">
|
||||
]>
|
||||
<book id="index">
|
||||
<bookinfo>
|
||||
<title>GDK Reference Manual</title>
|
||||
</bookinfo>
|
||||
|
||||
<chapter id="gdk">
|
||||
<title>GDK</title>
|
||||
&gdk-General;
|
||||
|
||||
&gdk-Points-Rectangles-and-Regions;
|
||||
&gdk-Graphics-Contexts;
|
||||
&gdk-Drawing-Primitives;
|
||||
|
||||
&gdk-Bitmaps-and-Pixmaps;
|
||||
&gdk-GdkRGB;
|
||||
&gdk-Images;
|
||||
|
||||
&gdk-Colormaps-and-Colors;
|
||||
&gdk-Color-Contexts;
|
||||
&gdk-Visuals;
|
||||
|
||||
&gdk-Fonts;
|
||||
&gdk-Cursors;
|
||||
|
||||
&gdk-Windows;
|
||||
|
||||
&gdk-Events;
|
||||
&gdk-Event-Structures;
|
||||
|
||||
&gdk-Selections;
|
||||
&gdk-Drag-and-Drop;
|
||||
|
||||
&gdk-Properties-and-Atoms;
|
||||
|
||||
&gdk-Threads;
|
||||
|
||||
&gdk-Input;
|
||||
|
||||
&gdk-Input-Devices;
|
||||
|
||||
&gdk-Key-Values;
|
||||
|
||||
&gdk-Input-Methods;
|
||||
&gdk-Input-Contexts;
|
||||
</chapter>
|
||||
</book>
|
||||
@@ -1,23 +0,0 @@
|
||||
|
||||
# GdkPixmap, GdkBitmap and GdkDrawable are the same as GdkWindow.
|
||||
<STRUCT>
|
||||
<NAME>GdkPixmap</NAME>
|
||||
struct GdkPixmap
|
||||
{
|
||||
gpointer user_data;
|
||||
};
|
||||
</STRUCT>
|
||||
<STRUCT>
|
||||
<NAME>GdkBitmap</NAME>
|
||||
struct GdkBitmap
|
||||
{
|
||||
gpointer user_data;
|
||||
};
|
||||
</STRUCT>
|
||||
<STRUCT>
|
||||
<NAME>GdkDrawable</NAME>
|
||||
struct GdkDrawable
|
||||
{
|
||||
gpointer user_data;
|
||||
};
|
||||
</STRUCT>
|
||||
@@ -1,622 +0,0 @@
|
||||
|
||||
<INCLUDE>gdk/gdk.h</INCLUDE>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>General</TITLE>
|
||||
<FILE>general</FILE>
|
||||
gdk_init
|
||||
gdk_init_check
|
||||
gdk_exit
|
||||
gdk_set_locale
|
||||
gdk_set_sm_client_id
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_get_display
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_flush
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_screen_width
|
||||
gdk_screen_height
|
||||
gdk_screen_width_mm
|
||||
gdk_screen_height_mm
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_pointer_grab
|
||||
gdk_pointer_ungrab
|
||||
gdk_pointer_is_grabbed
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_keyboard_grab
|
||||
gdk_keyboard_ungrab
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_key_repeat_disable
|
||||
gdk_key_repeat_restore
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_beep
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_get_use_xshm
|
||||
gdk_set_use_xshm
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_error_trap_push
|
||||
gdk_error_trap_pop
|
||||
|
||||
<SUBSECTION Private>
|
||||
GdkStatus
|
||||
gdk_time_get
|
||||
gdk_timer_get
|
||||
gdk_timer_set
|
||||
gdk_timer_enable
|
||||
gdk_timer_disable
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Bitmaps and Pixmaps</TITLE>
|
||||
<FILE>pixmaps</FILE>
|
||||
GdkPixmap
|
||||
gdk_pixmap_new
|
||||
gdk_bitmap_create_from_data
|
||||
gdk_pixmap_create_from_data
|
||||
gdk_pixmap_create_from_xpm
|
||||
gdk_pixmap_colormap_create_from_xpm
|
||||
gdk_pixmap_create_from_xpm_d
|
||||
gdk_pixmap_colormap_create_from_xpm_d
|
||||
gdk_pixmap_ref
|
||||
gdk_pixmap_unref
|
||||
GdkBitmap
|
||||
gdk_bitmap_ref
|
||||
gdk_bitmap_unref
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Images</TITLE>
|
||||
<FILE>images</FILE>
|
||||
GdkImage
|
||||
gdk_image_new
|
||||
GdkImageType
|
||||
gdk_image_new_bitmap
|
||||
gdk_image_get
|
||||
gdk_image_destroy
|
||||
<SUBSECTION>
|
||||
gdk_image_put_pixel
|
||||
gdk_image_get_pixel
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>GdkRGB</TITLE>
|
||||
<FILE>rgb</FILE>
|
||||
gdk_rgb_init
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_draw_rgb_image
|
||||
gdk_draw_rgb_image_dithalign
|
||||
gdk_draw_indexed_image
|
||||
gdk_draw_gray_image
|
||||
gdk_draw_rgb_32_image
|
||||
GdkRgbDither
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_rgb_cmap_new
|
||||
gdk_rgb_cmap_free
|
||||
GdkRgbCmap
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_rgb_gc_set_foreground
|
||||
gdk_rgb_gc_set_background
|
||||
gdk_rgb_xpixel_from_rgb
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_rgb_set_install
|
||||
gdk_rgb_set_min_colors
|
||||
gdk_rgb_get_visual
|
||||
gdk_rgb_get_cmap
|
||||
gdk_rgb_ditherable
|
||||
gdk_rgb_set_verbose
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Colormaps and Colors</TITLE>
|
||||
<FILE>colors</FILE>
|
||||
GdkColor
|
||||
GdkColormap
|
||||
gdk_colormap_new
|
||||
gdk_colormap_ref
|
||||
gdk_colormap_unref
|
||||
gdk_colormap_get_system
|
||||
gdk_colormap_get_system_size
|
||||
gdk_colormap_change
|
||||
gdk_colormap_alloc_colors
|
||||
gdk_colormap_alloc_color
|
||||
gdk_colormap_free_colors
|
||||
gdk_colormap_get_visual
|
||||
gdk_colors_store
|
||||
gdk_color_copy
|
||||
gdk_color_free
|
||||
gdk_colors_alloc
|
||||
gdk_colors_free
|
||||
gdk_color_white
|
||||
gdk_color_black
|
||||
gdk_color_parse
|
||||
gdk_color_alloc
|
||||
gdk_color_change
|
||||
gdk_color_equal
|
||||
gdk_color_hash
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Fonts</TITLE>
|
||||
<FILE>fonts</FILE>
|
||||
GdkFont
|
||||
GdkFontType
|
||||
gdk_font_load
|
||||
gdk_fontset_load
|
||||
gdk_font_ref
|
||||
gdk_font_unref
|
||||
gdk_font_id
|
||||
gdk_font_equal
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_string_extents
|
||||
gdk_text_extents
|
||||
gdk_text_extents_wc
|
||||
gdk_string_width
|
||||
gdk_text_width
|
||||
gdk_text_width_wc
|
||||
gdk_char_width
|
||||
gdk_char_width_wc
|
||||
gdk_string_measure
|
||||
gdk_text_measure
|
||||
gdk_char_measure
|
||||
gdk_string_height
|
||||
gdk_text_height
|
||||
gdk_char_height
|
||||
|
||||
<SUBSECTION>
|
||||
GdkWChar
|
||||
gdk_wcstombs
|
||||
gdk_mbstowcs
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Drawing Primitives</TITLE>
|
||||
<FILE>drawing</FILE>
|
||||
gdk_draw_point
|
||||
gdk_draw_points
|
||||
gdk_draw_line
|
||||
gdk_draw_lines
|
||||
gdk_draw_segments
|
||||
GdkSegment
|
||||
gdk_draw_rectangle
|
||||
gdk_draw_arc
|
||||
gdk_draw_polygon
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_draw_string
|
||||
gdk_draw_text
|
||||
gdk_draw_text_wc
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_draw_pixmap
|
||||
gdk_draw_image
|
||||
|
||||
<SUBSECTION Private>
|
||||
gdk_draw_bitmap
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Graphics Contexts</TITLE>
|
||||
<FILE>gcs</FILE>
|
||||
GdkGC
|
||||
GdkGCValues
|
||||
GdkGCValuesMask
|
||||
|
||||
GdkFunction
|
||||
|
||||
gdk_gc_new
|
||||
gdk_gc_new_with_values
|
||||
gdk_gc_ref
|
||||
gdk_gc_unref
|
||||
gdk_gc_destroy
|
||||
gdk_gc_get_values
|
||||
gdk_gc_set_foreground
|
||||
gdk_gc_set_background
|
||||
gdk_gc_set_font
|
||||
gdk_gc_set_function
|
||||
gdk_gc_set_fill
|
||||
GdkFill
|
||||
gdk_gc_set_tile
|
||||
gdk_gc_set_stipple
|
||||
gdk_gc_set_ts_origin
|
||||
gdk_gc_set_clip_origin
|
||||
gdk_gc_set_clip_mask
|
||||
gdk_gc_set_clip_rectangle
|
||||
gdk_gc_set_clip_region
|
||||
gdk_gc_set_subwindow
|
||||
GdkSubwindowMode
|
||||
gdk_gc_set_exposures
|
||||
gdk_gc_set_line_attributes
|
||||
GdkLineStyle
|
||||
GdkCapStyle
|
||||
GdkJoinStyle
|
||||
gdk_gc_set_dashes
|
||||
gdk_gc_copy
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Visuals</TITLE>
|
||||
<FILE>visuals</FILE>
|
||||
GdkVisual
|
||||
GdkVisualType
|
||||
GdkByteOrder
|
||||
gdk_query_depths
|
||||
gdk_query_visual_types
|
||||
gdk_list_visuals
|
||||
|
||||
gdk_visual_get_best_depth
|
||||
gdk_visual_get_best_type
|
||||
gdk_visual_get_system
|
||||
gdk_visual_get_best
|
||||
gdk_visual_get_best_with_depth
|
||||
gdk_visual_get_best_with_type
|
||||
gdk_visual_get_best_with_both
|
||||
gdk_visual_ref
|
||||
gdk_visual_unref
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Windows</TITLE>
|
||||
<FILE>windows</FILE>
|
||||
GdkWindowAttr
|
||||
GdkWindow
|
||||
GdkWindowType
|
||||
GdkWindowClass
|
||||
GdkWindowAttributesType
|
||||
GdkWindowHints
|
||||
GdkGeometry
|
||||
|
||||
gdk_window_new
|
||||
gdk_window_destroy
|
||||
gdk_window_ref
|
||||
gdk_window_unref
|
||||
gdk_window_at_pointer
|
||||
gdk_window_show
|
||||
gdk_window_hide
|
||||
gdk_window_is_visible
|
||||
gdk_window_is_viewable
|
||||
gdk_window_withdraw
|
||||
gdk_window_move
|
||||
gdk_window_resize
|
||||
gdk_window_move_resize
|
||||
gdk_window_reparent
|
||||
gdk_window_clear
|
||||
gdk_window_clear_area
|
||||
gdk_window_clear_area_e
|
||||
gdk_window_copy_area
|
||||
gdk_window_raise
|
||||
gdk_window_lower
|
||||
gdk_window_register_dnd
|
||||
gdk_window_set_user_data
|
||||
gdk_window_set_override_redirect
|
||||
gdk_window_add_filter
|
||||
gdk_window_remove_filter
|
||||
GdkFilterFunc
|
||||
GdkFilterReturn
|
||||
GdkXEvent
|
||||
gdk_window_shape_combine_mask
|
||||
gdk_window_set_child_shapes
|
||||
gdk_window_merge_child_shapes
|
||||
gdk_window_set_static_gravities
|
||||
gdk_window_set_hints
|
||||
gdk_window_set_title
|
||||
gdk_window_set_background
|
||||
gdk_window_set_back_pixmap
|
||||
GDK_PARENT_RELATIVE
|
||||
gdk_window_set_cursor
|
||||
gdk_window_set_colormap
|
||||
gdk_window_get_user_data
|
||||
gdk_window_get_geometry
|
||||
gdk_window_set_geometry_hints
|
||||
gdk_window_get_position
|
||||
gdk_window_get_root_origin
|
||||
gdk_window_get_size
|
||||
gdk_window_get_visual
|
||||
gdk_window_get_colormap
|
||||
gdk_window_get_type
|
||||
gdk_window_get_origin
|
||||
gdk_window_get_deskrelative_origin
|
||||
gdk_window_get_pointer
|
||||
GdkModifierType
|
||||
gdk_window_get_parent
|
||||
gdk_window_get_toplevel
|
||||
gdk_window_get_children
|
||||
gdk_window_get_events
|
||||
gdk_window_set_events
|
||||
gdk_window_set_icon
|
||||
gdk_window_set_icon_name
|
||||
gdk_window_set_transient_for
|
||||
gdk_window_set_role
|
||||
gdk_window_set_group
|
||||
gdk_window_set_decorations
|
||||
GdkWMDecoration
|
||||
gdk_window_set_functions
|
||||
GdkWMFunction
|
||||
gdk_window_get_toplevels
|
||||
GdkDrawable
|
||||
gdk_drawable_set_data
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Selections</TITLE>
|
||||
<FILE>selections</FILE>
|
||||
GdkSelection
|
||||
GdkSelectionType
|
||||
GdkTarget
|
||||
gdk_selection_owner_set
|
||||
gdk_selection_owner_get
|
||||
gdk_selection_convert
|
||||
gdk_selection_property_get
|
||||
gdk_selection_send_notify
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Properties and Atoms</TITLE>
|
||||
<FILE>properties</FILE>
|
||||
GdkAtom
|
||||
GDK_NONE
|
||||
gdk_text_property_to_text_list
|
||||
gdk_free_text_list
|
||||
gdk_string_to_compound_text
|
||||
gdk_free_compound_text
|
||||
gdk_atom_intern
|
||||
gdk_atom_name
|
||||
gdk_property_get
|
||||
gdk_property_change
|
||||
GdkPropMode
|
||||
gdk_property_delete
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Input Methods</TITLE>
|
||||
<FILE>input_methods</FILE>
|
||||
GdkIMStyle
|
||||
gdk_im_ready
|
||||
gdk_im_decide_style
|
||||
gdk_im_set_best_style
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_im_begin
|
||||
gdk_im_end
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Input Contexts</TITLE>
|
||||
<FILE>input_contexts</FILE>
|
||||
GdkIC
|
||||
gdk_ic_new
|
||||
gdk_ic_destroy
|
||||
gdk_ic_get_events
|
||||
gdk_ic_get_style
|
||||
gdk_ic_get_attr
|
||||
gdk_ic_set_attr
|
||||
|
||||
<SUBSECTION>
|
||||
GdkICAttr
|
||||
GdkICAttributesType
|
||||
gdk_ic_attr_new
|
||||
gdk_ic_attr_destroy
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Color Contexts</TITLE>
|
||||
<FILE>color_contexts</FILE>
|
||||
GdkColorContext
|
||||
GdkColorContextDither
|
||||
GdkColorContextMode
|
||||
|
||||
gdk_color_context_new
|
||||
gdk_color_context_new_mono
|
||||
gdk_color_context_free
|
||||
gdk_color_context_get_pixel
|
||||
gdk_color_context_get_pixels
|
||||
gdk_color_context_get_pixels_incremental
|
||||
gdk_color_context_query_color
|
||||
gdk_color_context_query_colors
|
||||
gdk_color_context_add_palette
|
||||
gdk_color_context_init_dither
|
||||
gdk_color_context_free_dither
|
||||
gdk_color_context_get_pixel_from_palette
|
||||
gdk_color_context_get_index_from_palette
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Points, Rectangles and Regions</TITLE>
|
||||
<FILE>regions</FILE>
|
||||
GdkPoint
|
||||
|
||||
<SUBSECTION>
|
||||
GdkRectangle
|
||||
gdk_rectangle_intersect
|
||||
gdk_rectangle_union
|
||||
|
||||
<SUBSECTION>
|
||||
GdkRegion
|
||||
gdk_region_new
|
||||
gdk_region_polygon
|
||||
GdkFillRule
|
||||
gdk_region_destroy
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_regions_intersect
|
||||
gdk_regions_union
|
||||
gdk_regions_subtract
|
||||
gdk_regions_xor
|
||||
gdk_region_union_with_rect
|
||||
gdk_region_offset
|
||||
gdk_region_shrink
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_region_empty
|
||||
gdk_region_equal
|
||||
gdk_region_point_in
|
||||
gdk_region_rect_in
|
||||
GdkOverlapType
|
||||
gdk_region_get_clipbox
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Threads</TITLE>
|
||||
<FILE>threads</FILE>
|
||||
gdk_threads_mutex
|
||||
GDK_THREADS_ENTER
|
||||
GDK_THREADS_LEAVE
|
||||
gdk_threads_enter
|
||||
gdk_threads_leave
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Key Values</TITLE>
|
||||
<FILE>keys</FILE>
|
||||
gdk_keyval_name
|
||||
gdk_keyval_from_name
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_keyval_is_upper
|
||||
gdk_keyval_is_lower
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_keyval_to_upper
|
||||
gdk_keyval_to_lower
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Input Devices</TITLE>
|
||||
<FILE>input_devices</FILE>
|
||||
GDK_CORE_POINTER
|
||||
gdk_input_list_devices
|
||||
GdkDeviceInfo
|
||||
GdkDeviceKey
|
||||
gdk_input_set_extension_events
|
||||
GdkExtensionMode
|
||||
gdk_input_set_source
|
||||
GdkInputSource
|
||||
gdk_input_set_mode
|
||||
GdkInputMode
|
||||
gdk_input_set_axes
|
||||
GdkAxisUse
|
||||
gdk_input_set_key
|
||||
gdk_input_window_get_pointer
|
||||
gdk_input_motion_events
|
||||
GdkTimeCoord
|
||||
|
||||
<SUBSECTION Private>
|
||||
gdk_input_init
|
||||
gdk_input_exit
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Events</TITLE>
|
||||
<FILE>events</FILE>
|
||||
GdkEventType
|
||||
GdkEventMask
|
||||
GDK_CURRENT_TIME
|
||||
GDK_PRIORITY_EVENTS
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_events_pending
|
||||
gdk_event_peek
|
||||
gdk_event_get
|
||||
gdk_event_get_graphics_expose
|
||||
gdk_event_put
|
||||
gdk_event_copy
|
||||
gdk_event_free
|
||||
gdk_event_get_time
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_event_handler_set
|
||||
GdkEventFunc
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_event_send_client_message
|
||||
gdk_event_send_clientmessage_toall
|
||||
gdk_add_client_message_filter
|
||||
|
||||
<SUBSECTION>
|
||||
gdk_get_show_events
|
||||
gdk_set_show_events
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Event Structures</TITLE>
|
||||
<FILE>event_structs</FILE>
|
||||
GdkEvent
|
||||
|
||||
<SUBSECTION>
|
||||
GdkEventAny
|
||||
GdkEventKey
|
||||
GdkEventButton
|
||||
GdkEventMotion
|
||||
GdkEventExpose
|
||||
GdkEventVisibility
|
||||
GdkEventCrossing
|
||||
GdkEventFocus
|
||||
GdkEventConfigure
|
||||
GdkEventProperty
|
||||
GdkEventSelection
|
||||
GdkEventDND
|
||||
GdkEventProximity
|
||||
GdkEventClient
|
||||
GdkEventNoExpose
|
||||
|
||||
<SUBSECTION>
|
||||
GdkVisibilityState
|
||||
GdkCrossingMode
|
||||
GdkNotifyType
|
||||
GdkPropertyState
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Cursors</TITLE>
|
||||
<FILE>cursors</FILE>
|
||||
GdkCursor
|
||||
GdkCursorType
|
||||
gdk_cursor_new
|
||||
gdk_cursor_new_from_pixmap
|
||||
gdk_cursor_destroy
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Input</TITLE>
|
||||
<FILE>input</FILE>
|
||||
gdk_input_add_full
|
||||
GdkInputCondition
|
||||
GdkInputFunction
|
||||
GdkDestroyNotify
|
||||
gdk_input_add
|
||||
gdk_input_remove
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<TITLE>Drag and Drop</TITLE>
|
||||
<FILE>dnd</FILE>
|
||||
gdk_drag_get_selection
|
||||
gdk_drag_abort
|
||||
gdk_drop_reply
|
||||
gdk_drag_context_new
|
||||
gdk_drag_drop
|
||||
gdk_drag_find_window
|
||||
gdk_drag_context_ref
|
||||
gdk_drag_begin
|
||||
gdk_drag_motion
|
||||
gdk_drop_finish
|
||||
gdk_drag_get_protocol
|
||||
GdkDragProtocol
|
||||
gdk_drag_context_unref
|
||||
GdkDragContext
|
||||
GdkDragAction
|
||||
gdk_drag_status
|
||||
</SECTION>
|
||||
@@ -1,207 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Color Contexts
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
routines for allocating colors (deprecated).
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GdkColorContext type is used for allocating groups of colors.
|
||||
</para>
|
||||
<para>
|
||||
It is now deprecated in favor of the gdk_colormap_*() functions described in
|
||||
the <link linkend="gdk-Colormaps-and-Colors">Colormaps and Colors</link>
|
||||
section.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GdkColorContext ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@visual:
|
||||
@colormap:
|
||||
@num_colors:
|
||||
@max_colors:
|
||||
@num_allocated:
|
||||
@mode:
|
||||
@need_to_free_colormap:
|
||||
@std_cmap_atom:
|
||||
@clut:
|
||||
@cmap:
|
||||
@color_hash:
|
||||
@palette:
|
||||
@num_palette:
|
||||
@fast_dither:
|
||||
|
||||
<!-- ##### STRUCT GdkColorContextDither ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@fast_rgb:
|
||||
@fast_err:
|
||||
@fast_erg:
|
||||
@fast_erb:
|
||||
|
||||
<!-- ##### ENUM GdkColorContextMode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_CC_MODE_UNDEFINED:
|
||||
@GDK_CC_MODE_BW:
|
||||
@GDK_CC_MODE_STD_CMAP:
|
||||
@GDK_CC_MODE_TRUE:
|
||||
@GDK_CC_MODE_MY_GRAY:
|
||||
@GDK_CC_MODE_PALETTE:
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@visual:
|
||||
@colormap:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_new_mono ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@visual:
|
||||
@colormap:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_free ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cc:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_get_pixel ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cc:
|
||||
@red:
|
||||
@green:
|
||||
@blue:
|
||||
@failed:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_get_pixels ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cc:
|
||||
@reds:
|
||||
@greens:
|
||||
@blues:
|
||||
@ncolors:
|
||||
@colors:
|
||||
@nallocated:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_get_pixels_incremental ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cc:
|
||||
@reds:
|
||||
@greens:
|
||||
@blues:
|
||||
@ncolors:
|
||||
@used:
|
||||
@colors:
|
||||
@nallocated:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_query_color ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cc:
|
||||
@color:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_query_colors ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cc:
|
||||
@colors:
|
||||
@num_colors:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_add_palette ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cc:
|
||||
@palette:
|
||||
@num_palette:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_init_dither ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cc:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_free_dither ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cc:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_get_pixel_from_palette ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cc:
|
||||
@red:
|
||||
@green:
|
||||
@blue:
|
||||
@failed:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_context_get_index_from_palette ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@cc:
|
||||
@red:
|
||||
@green:
|
||||
@blue:
|
||||
@failed:
|
||||
@Returns:
|
||||
|
||||
|
||||
@@ -1,390 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Colormaps and Colors
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
manipulation of colors and colormaps.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
These functions are used to modify colormaps.
|
||||
A colormap is an object that contains the mapping
|
||||
between the color values stored in memory and
|
||||
the RGB values that are used to display color
|
||||
values. In general, colormaps only contain
|
||||
significant information for pseudo-color visuals,
|
||||
but even for other visual types, a colormap object
|
||||
is required in some circumstances.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
There are a couple of special colormaps that can
|
||||
be retrieved. The system colormap (retrieved
|
||||
with gdk_colormap_get_system()) is the default
|
||||
colormap of the system. If you are using GdkRGB,
|
||||
there is another colormap that is important - the
|
||||
colormap in which GdkRGB works, retrieved with
|
||||
gdk_rgb_get_cmap(). However, when using GdkRGB,
|
||||
it is not generally necessary to allocate colors
|
||||
directly.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
In previous revisions of this interface, a number
|
||||
of functions that take a #GdkColormap parameter
|
||||
were replaced with functions whose names began
|
||||
with "gdk_colormap_". This process will probably
|
||||
be extended somewhat in the future -
|
||||
gdk_color_white(), gdk_color_black(), and
|
||||
gdk_color_change() will probably become aliases.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GdkColor ##### -->
|
||||
<para>
|
||||
The #GdkColor structure is used to describe an
|
||||
allocated or unallocated color.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry><structfield>pixel</structfield></entry>
|
||||
<entry>For allocated colors, the value used to
|
||||
draw this color on the screen.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>red</structfield></entry>
|
||||
<entry>The red component of the color. This is
|
||||
a value between 0 and 65535, with 65535 indicating
|
||||
full intensitiy.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>green</structfield></entry>
|
||||
<entry>the blue component of the color.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>blue</structfield></entry>
|
||||
<entry>the green component of the color..</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@pixel:
|
||||
@red:
|
||||
@green:
|
||||
@blue:
|
||||
|
||||
<!-- ##### STRUCT GdkColormap ##### -->
|
||||
<para>
|
||||
The colormap structure contains the following public
|
||||
fields.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry><structfield>size</structfield></entry>
|
||||
<entry>For pseudo-color colormaps, the number of colors
|
||||
in the colormap..</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>colors</structfield></entry>
|
||||
<entry>An array containing the current values in the
|
||||
colormap. This can be used to map from pixel values
|
||||
back to RGB values. This is only meaningful for
|
||||
pseudo-color colormaps.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@size:
|
||||
@colors:
|
||||
|
||||
<!-- ##### FUNCTION gdk_colormap_new ##### -->
|
||||
<para>
|
||||
Create a new colormap for the given visual.
|
||||
</para>
|
||||
|
||||
@visual: a #GdkVisual.
|
||||
@allocate: if %TRUE, the newly created colormap will be
|
||||
a private colormap, and all colors in it will be
|
||||
allocated for the applications use.
|
||||
@Returns: the new #GdkColormap.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_colormap_ref ##### -->
|
||||
<para>
|
||||
Increase the reference count of a colormap.
|
||||
</para>
|
||||
|
||||
@cmap: a #GdkColormap.
|
||||
@Returns: @cmap
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_colormap_unref ##### -->
|
||||
<para>
|
||||
Decrease the reference count of a colormap. If the
|
||||
resulting reference count is zero, destroys the colormap.
|
||||
</para>
|
||||
|
||||
@cmap: a #GdkColormap.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_colormap_get_system ##### -->
|
||||
<para>
|
||||
Returns the system's default colormap.
|
||||
</para>
|
||||
|
||||
@Returns: the default colormap.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_colormap_get_system_size ##### -->
|
||||
<para>
|
||||
Returns the size of the system's default colormap.
|
||||
(See the description of struct #GdkColormap for an
|
||||
explanation of the size of a colormap.)
|
||||
</para>
|
||||
|
||||
@Returns: the size of the system's default colormap.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_colormap_change ##### -->
|
||||
<para>
|
||||
Change the value of the first @ncolors in a private colormap
|
||||
to match the values in the <structfield>colors</structfield>
|
||||
array in the color map. This function is obsolete and
|
||||
should not be used. See gdk_color_change().
|
||||
</para>
|
||||
|
||||
@colormap: a #GdkColormap.
|
||||
@ncolors: the number of colors to change.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_colormap_alloc_colors ##### -->
|
||||
<para>
|
||||
Allocates colors from a colormap.
|
||||
</para>
|
||||
|
||||
@colormap: a #GdkColormap.
|
||||
@colors: The color values to allocate. On return, the pixel
|
||||
values for allocated colors will be filled in.
|
||||
@ncolors: The number of colors in @colors.
|
||||
@writeable: If %TRUE, the colors are allocated writeable
|
||||
(their values can later be changed using gdk_color_change()).
|
||||
Writeable colors cannot be shared between applications.
|
||||
@best_match: If %TRUE, GDK will attempt to do matching against
|
||||
existing colors if the colors cannot be allocated as
|
||||
requested.
|
||||
@success: An array of length @ncolors. On return, this
|
||||
indicates whether the corresponding color in @colors was
|
||||
sucessfully allocated or not.
|
||||
@Returns: The number of colors that were not sucessfully
|
||||
allocated.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_colormap_alloc_color ##### -->
|
||||
<para>
|
||||
Allocate a single color from a colormap.
|
||||
</para>
|
||||
|
||||
@colormap: a #GdkColormap.
|
||||
@color: the color to allocate. On return the
|
||||
<structfield>pixel</structfield> field will be
|
||||
filled in if allocation succeeds.
|
||||
@writeable: If %TRUE, the color is allocated writeable
|
||||
(their values can later be changed using gdk_color_change()).
|
||||
Writeable colors cannot be shared between applications.
|
||||
@best_match: If %TRUE, GDK will attempt to do matching against
|
||||
existing colors if the color cannot be allocated as
|
||||
requested.
|
||||
@Returns: %TRUE if the allocation succeeded.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_colormap_free_colors ##### -->
|
||||
<para>
|
||||
Free previously allocated colors.
|
||||
</para>
|
||||
|
||||
@colormap: a #GdkColormap.
|
||||
@colors: the colors to free.
|
||||
@ncolors: the number of colors in @colors.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_colormap_get_visual ##### -->
|
||||
<para>
|
||||
Return the visual for which a given colormap was created.
|
||||
</para>
|
||||
|
||||
@colormap: a #GdkColormap.
|
||||
@Returns: the visual of the colormap.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_colors_store ##### -->
|
||||
<para>
|
||||
Change the value of the first @ncolors colors in
|
||||
a private colormap. This function is obsolete and
|
||||
should not be used. See gdk_color_change().
|
||||
</para>
|
||||
|
||||
@colormap: a #GdkColormap.
|
||||
@colors: the new color values.
|
||||
@ncolors: the number of colors to change.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_copy ##### -->
|
||||
<para>
|
||||
Make a copy of a color structure. The result
|
||||
must be freed using gdk_color_free().
|
||||
</para>
|
||||
|
||||
@color: a #GdkColor.
|
||||
@Returns: a copy of @color.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_free ##### -->
|
||||
<para>
|
||||
Free a color structure created with
|
||||
gdk_color_copy().
|
||||
</para>
|
||||
|
||||
@color: a #GdkColor.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_colors_alloc ##### -->
|
||||
<para>
|
||||
Allocate colors from a colormap. This function
|
||||
is obsolete. See gdk_colormap_alloc_colors().
|
||||
For full documentation of the fields, see
|
||||
the Xlib documentation for XAllocColorCells.
|
||||
</para>
|
||||
|
||||
@colormap: a #GdkColormap.
|
||||
@contiguous: if %TRUE, the colors should be allocated
|
||||
in contiguous color cells.
|
||||
@planes: an array in which to store the plane masks.
|
||||
@nplanes: the number of planes to allocate. (Or zero,
|
||||
to indicate that the color allocation should not be
|
||||
planar.)
|
||||
@pixels: an array into which to store allocated pixel
|
||||
values.
|
||||
@npixels: the number of pixels in each plane to allocate.
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_colors_free ##### -->
|
||||
<para>
|
||||
Free colors allocated with gdk_colors_alloc(). This
|
||||
function is obsolete. See gdk_colormap_free_colors().
|
||||
</para>
|
||||
|
||||
@colormap: a #GdkColormap.
|
||||
@pixels: the pixel values of the colors to free.
|
||||
@npixels: the number of values in @pixels.
|
||||
@planes: the plane masks for all planes to free, OR'd
|
||||
together.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_white ##### -->
|
||||
<para>
|
||||
Return the white color for a given colormap. The resulting
|
||||
value has already allocated been allocated.
|
||||
</para>
|
||||
|
||||
@colormap: a #GdkColormap.
|
||||
@color: the location to store the color.
|
||||
@Returns: %TRUE if the allocation succeeded.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_black ##### -->
|
||||
<para>
|
||||
Return the black color for a given colormap. The resulting
|
||||
value has already benn allocated.
|
||||
</para>
|
||||
|
||||
@colormap: a #GdkColormap.
|
||||
@color: the location to store the color.
|
||||
@Returns: %TRUE if the allocation succeeded.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_parse ##### -->
|
||||
<para>
|
||||
Parse a textual specification of a color and fill in
|
||||
the <structfield>red</structfield>,
|
||||
<structfield>green</structfield>, and
|
||||
<structfield>blue</structfield> fields of a
|
||||
#GdkColor structure. The color is <emphasis>not</emphasis>
|
||||
allocated, you must call gdk_colormap_alloc_color() yourself.
|
||||
The text string can be in any of the forms accepted
|
||||
by <function>XParseColor</function>; these include
|
||||
name for a color from <filename>rgb.txt</filename>, such as
|
||||
<literal>DarkSlateGray</literal>, or a hex specification
|
||||
such as <literal>305050</literal>.
|
||||
</para>
|
||||
|
||||
@spec: the string specifying the color.
|
||||
@color: the #GdkColor to fill in
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_alloc ##### -->
|
||||
<para>
|
||||
Allocate a single color from a colormap.
|
||||
This function is obsolete. See gdk_colormap_alloc_color().
|
||||
</para>
|
||||
|
||||
@colormap: a #GdkColormap.
|
||||
@color: The color to allocate. On return, the
|
||||
<structfield>pixel</structfield> field will be
|
||||
filled in.
|
||||
@Returns: %TRUE if the allocation succeeded.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_change ##### -->
|
||||
<para>
|
||||
Change the value of a color that has already
|
||||
been allocated. If @colormap is not a private
|
||||
colormap, then the color must have been allocated
|
||||
using gdk_colormap_alloc_colors() with the
|
||||
@writeable set to %TRUE.
|
||||
</para>
|
||||
|
||||
@colormap: a #GdkColormap.
|
||||
@color: a #GdkColor, with the color to change
|
||||
in the <structfield>pixel</structfield> field,
|
||||
and the new value in the remaining fields.
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_equal ##### -->
|
||||
<para>
|
||||
Compare two colors.
|
||||
</para>
|
||||
|
||||
@colora: a #GdkColor.
|
||||
@colorb: another #GdkColor.
|
||||
@Returns: %TRUE if the two colors compare equal
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_color_hash ##### -->
|
||||
<para>
|
||||
A hash function suitable for using for a hash
|
||||
table that stores #GdkColor's.
|
||||
</para>
|
||||
|
||||
@colora: a #GdkColor.
|
||||
@colorb: NOT USED.
|
||||
@Returns: The hash function appled to @colora
|
||||
|
||||
|
||||
@@ -1,99 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Cursors
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
standard and pixmap cursors.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GdkCursor ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
|
||||
<!-- ##### ENUM GdkCursorType ##### -->
|
||||
<para>
|
||||
The standard cursors available.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_cursor_new ##### -->
|
||||
<para>
|
||||
Creates a new standard cursor.
|
||||
</para>
|
||||
|
||||
@cursor_type: the type of the cursor.
|
||||
@Returns: a new #GdkCursor.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_cursor_new_from_pixmap ##### -->
|
||||
<para>
|
||||
Creates a new cursor from a given pixmap and mask. Both the pixmap and mask
|
||||
must have a depth of 1 (i.e. each pixel has only 2 values - on or off).
|
||||
The standard cursor size is 16 by 16 pixels.
|
||||
</para>
|
||||
<example><title>Creating a custom cursor.</title>
|
||||
<programlisting>
|
||||
/* This data is in X bitmap format, and can be created with the 'bitmap'
|
||||
utility. */
|
||||
#define cursor1_width 16
|
||||
#define cursor1_height 16
|
||||
static unsigned char cursor1_bits[] = {
|
||||
0x80, 0x01, 0x40, 0x02, 0x20, 0x04, 0x10, 0x08, 0x08, 0x10, 0x04, 0x20,
|
||||
0x82, 0x41, 0x41, 0x82, 0x41, 0x82, 0x82, 0x41, 0x04, 0x20, 0x08, 0x10,
|
||||
0x10, 0x08, 0x20, 0x04, 0x40, 0x02, 0x80, 0x01};
|
||||
|
||||
static unsigned char cursor1mask_bits[] = {
|
||||
0x80, 0x01, 0xc0, 0x03, 0x60, 0x06, 0x30, 0x0c, 0x18, 0x18, 0x8c, 0x31,
|
||||
0xc6, 0x63, 0x63, 0xc6, 0x63, 0xc6, 0xc6, 0x63, 0x8c, 0x31, 0x18, 0x18,
|
||||
0x30, 0x0c, 0x60, 0x06, 0xc0, 0x03, 0x80, 0x01};
|
||||
|
||||
|
||||
GdkCursor *cursor;
|
||||
GdkPixmap *source, *mask;
|
||||
GdkColor fg = { 0, 65535, 0, 0 }; /* Red. */
|
||||
GdkColor bg = { 0, 0, 0, 65535 }; /* Blue. */
|
||||
|
||||
|
||||
source = gdk_bitmap_create_from_data (NULL, cursor1_bits,
|
||||
cursor1_width, cursor1_height);
|
||||
mask = gdk_bitmap_create_from_data (NULL, cursor1mask_bits,
|
||||
cursor1_width, cursor1_height);
|
||||
cursor = gdk_cursor_new_from_pixmap (source, mask, &fg, &bg, 8, 8);
|
||||
gdk_pixmap_unref (source);
|
||||
gdk_pixmap_unref (mask);
|
||||
|
||||
|
||||
gdk_window_set_cursor (widget->window, cursor);
|
||||
</programlisting>
|
||||
</example>
|
||||
|
||||
@source: the pixmap specifying the cursor.
|
||||
@mask: the pixmap specifying the mask, which must be the same size as @source.
|
||||
@fg: the foreground color, used for the bits in the source which are 1.
|
||||
The color does not have to be allocated first.
|
||||
@bg: the background color, used for the bits in the source which are 0.
|
||||
The color does not have to be allocated first.
|
||||
@x: the horizontal offset of the 'hotspot' of the cursor.
|
||||
@y: the vertical offset of the 'hotspot' of the cursor.
|
||||
@Returns: a new #GdkCursor.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_cursor_destroy ##### -->
|
||||
<para>
|
||||
Destroys a cursor, freeing any resources allocated for it.
|
||||
</para>
|
||||
|
||||
@cursor: a #GdkCursor.
|
||||
|
||||
|
||||
@@ -1,194 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Drag and Drop
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
functions for controlling drag and drop handling.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
These functions provide a low level interface for drag and drop.
|
||||
GDK supports both the Xdnd and Motif drag and drop protocols transparently.
|
||||
</para>
|
||||
<para>
|
||||
GTK+ provides a higher level abstraction based on top of these functions,
|
||||
and so they are not normally needed in GTK+ applications.
|
||||
See the <link linkend="gtk-Drag-and-Drop">Drag and Drop</link> section of
|
||||
the GTK+ documentation for more information.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gdk_drag_get_selection ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_drag_abort ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
@time:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_drop_reply ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
@ok:
|
||||
@time:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_drag_context_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_drag_drop ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
@time:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_drag_find_window ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
@drag_window:
|
||||
@x_root:
|
||||
@y_root:
|
||||
@dest_window:
|
||||
@protocol:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_drag_context_ref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_drag_begin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@targets:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@actions:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_drag_motion ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
@dest_window:
|
||||
@protocol:
|
||||
@x_root:
|
||||
@y_root:
|
||||
@suggested_action:
|
||||
@possible_actions:
|
||||
@time:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@action:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_drop_finish ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
@success:
|
||||
@time:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_drag_get_protocol ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@xid:
|
||||
@protocol:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkDragProtocol ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_DRAG_PROTO_MOTIF:
|
||||
@GDK_DRAG_PROTO_XDND:
|
||||
@GDK_DRAG_PROTO_ROOTWIN:
|
||||
@GDK_DRAG_PROTO_NONE:
|
||||
|
||||
<!-- ##### FUNCTION gdk_drag_context_unref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GdkDragContext ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@protocol:
|
||||
@is_source:
|
||||
@source_window:
|
||||
@dest_window:
|
||||
@targets:
|
||||
@actions:
|
||||
@suggested_action:
|
||||
@action:
|
||||
@start_time:
|
||||
|
||||
<!-- ##### ENUM GdkDragAction ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_ACTION_DEFAULT:
|
||||
@GDK_ACTION_COPY:
|
||||
@GDK_ACTION_MOVE:
|
||||
@GDK_ACTION_LINK:
|
||||
@GDK_ACTION_PRIVATE:
|
||||
@GDK_ACTION_ASK:
|
||||
|
||||
<!-- ##### FUNCTION gdk_drag_status ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@context:
|
||||
@action:
|
||||
@time:
|
||||
|
||||
|
||||
@@ -1,239 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Drawing Primitives
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
functions for drawing points, lines, arcs, and text.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
These functions provide support for drawing points, lines, arcs and text
|
||||
onto what are called 'drawables'. Drawables, as the name suggests, are things
|
||||
which support drawing onto them, and are either #GdkWindow or #GdkPixmap
|
||||
objects.
|
||||
</para>
|
||||
<para>
|
||||
Many of the drawing operations take a #GdkGC argument, which represents a
|
||||
graphics context. This #GdkGC contains a number of drawing attributes such
|
||||
as foreground color, background color and line width, and is used to reduce
|
||||
the number of arguments needed for each drawing operation. See the
|
||||
<link linkend="gdk-Graphics-Contexts">Graphics Contexts</link> section for
|
||||
more information.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_point ##### -->
|
||||
<para>
|
||||
Draws a point, using the foreground color and other attributes of the #GdkGC.
|
||||
</para>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@gc: a #GdkGC.
|
||||
@x: the x coordinate of the point.
|
||||
@y: the y coordinate of the point.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_points ##### -->
|
||||
<para>
|
||||
Draws a number of points, using the foreground color and other attributes of
|
||||
the #GdkGC.
|
||||
</para>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@gc: a #GdkGC.
|
||||
@points: an array of #GdkPoint structures.
|
||||
@npoints: the number of points to be drawn.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_line ##### -->
|
||||
<para>
|
||||
Draws a line, using the foreground color and other attributes of the #GdkGC.
|
||||
</para>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@gc: a #GdkGC.
|
||||
@x1: the x coordinate of the start point.
|
||||
@y1: the y coordinate of the start point.
|
||||
@x2: the x coordinate of the end point.
|
||||
@y2: the y coordinate of the end point.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_lines ##### -->
|
||||
<para>
|
||||
Draws a series of lines connecting the given points.
|
||||
The way in which joins between lines are draw is determined by the
|
||||
#GdkCapStyle value in the #GdkGC. This can be set with
|
||||
gdk_gc_set_line_attributes().
|
||||
</para>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@gc: a #GdkGC.
|
||||
@points: an array of #GdkPoint structures specifying the endpoints of the
|
||||
lines.
|
||||
@npoints: the size of the @points array.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_segments ##### -->
|
||||
<para>
|
||||
Draws a number of unconnected lines.
|
||||
</para>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@gc: a #GdkGC.
|
||||
@segs: an array of #GdkSegment structures specifying the start and end points
|
||||
of the lines to be drawn,
|
||||
@nsegs: the number of line segments to draw, i.e. the size of the @segs array.
|
||||
|
||||
|
||||
<!-- ##### STRUCT GdkSegment ##### -->
|
||||
<para>
|
||||
Specifies the start and end point of a line for use by the gdk_draw_segments()
|
||||
function.
|
||||
</para>
|
||||
|
||||
@x1: the x coordinate of the start point.
|
||||
@y1: the y coordinate of the start point.
|
||||
@x2: the x coordinate of the end point.
|
||||
@y2: the y coordinate of the end point.
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_rectangle ##### -->
|
||||
<para>
|
||||
Draws a rectangular outline or filled rectangle, using the foreground color
|
||||
and other attributes of the #GdkGC.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
A rectangle drawn filled is 1 pixel smaller in both dimensions than a rectangle
|
||||
outlined. Calling gdk_draw_rectangle (window, gc, TRUE, 0, 0, 20, 20) results
|
||||
in a filled rectangle 20 pixels wide and 20 pixels high. Calling
|
||||
gdk_draw_rectangle (window, gc, FALSE, 0, 0, 20, 20) results in an outlined
|
||||
rectangle with corners at (0, 0), (0, 20), (20, 20), and (20, 0), which
|
||||
makes it 21 pixels wide and 21 pixels high.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@gc: a #GdkGC.
|
||||
@filled: TRUE if the rectangle should be filled.
|
||||
@x: the x coordinate of the left edge of the rectangle.
|
||||
@y: the y coordinate of the top edge of the rectangle.
|
||||
@width: the width of the rectangle.
|
||||
@height: the height of the rectangle.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_arc ##### -->
|
||||
<para>
|
||||
Draws an arc or a filled 'pie slice'. The arc is defined by the bounding
|
||||
rectangle of the entire ellipse, and the start and end angles of the part of
|
||||
the ellipse to be drawn.
|
||||
</para>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@gc: a #GdkGC.
|
||||
@filled: TRUE if the arc should be filled, producing a 'pie slice'.
|
||||
@x: the x coordinate of the left edge of the bounding rectangle.
|
||||
@y: the y coordinate of the top edge of the bounding rectangle.
|
||||
@width: the width of the bounding rectangle.
|
||||
@height: the height of the bounding rectangle.
|
||||
@angle1: the start angle of the arc, relative to the 3 o'clock position,
|
||||
counter-clockwise, in 1/64ths of a degree.
|
||||
@angle2: the end angle of the arc, relative to @angle1, in 1/64ths of a degree.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_polygon ##### -->
|
||||
<para>
|
||||
Draws an outlined or filled polygon.
|
||||
</para>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@gc: a #GdkGC.
|
||||
@filled: TRUE if the polygon should be filled. The polygon is closed
|
||||
automatically, connecting the last point to the first point if necessary.
|
||||
@points: an array of #GdkPoint structures specifying the points making up the
|
||||
polygon.
|
||||
@npoints: the number of points.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_string ##### -->
|
||||
<para>
|
||||
Draws a string of characters in the given font or fontset.
|
||||
</para>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@font: a #GdkFont.
|
||||
@gc: a #GdkGC.
|
||||
@x: the x coordinate of the left edge of the text.
|
||||
@y: the y coordinate of the baseline of the text.
|
||||
@string: the string of characters to draw.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_text ##### -->
|
||||
<para>
|
||||
Draws a number of characters in the given font or fontset.
|
||||
</para>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@font: a #GdkFont.
|
||||
@gc: a #GdkGC.
|
||||
@x: the x coordinate of the left edge of the text.
|
||||
@y: the y coordinate of the baseline of the text.
|
||||
@text: the characters to draw.
|
||||
@text_length: the number of characters of @text to draw.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_text_wc ##### -->
|
||||
<para>
|
||||
Draws a number of wide characters using the given font of fontset.
|
||||
If the font is a 1-byte font, the string is converted into 1-byte characters
|
||||
(discarding the high bytes) before output.
|
||||
</para>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@font: a #GdkFont.
|
||||
@gc: a #GdkGC.
|
||||
@x: the x coordinate of the left edge of the text.
|
||||
@y: the y coordinate of the baseline of the text.
|
||||
@text: the wide characters to draw.
|
||||
@text_length: the number of characters to draw.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_pixmap ##### -->
|
||||
<para>
|
||||
Draws a pixmap, or a part of a pixmap, onto another drawable.
|
||||
</para>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@gc: a #GdkGC.
|
||||
@src: the source #GdkPixmap to draw.
|
||||
@xsrc: the left edge of the source rectangle within @src.
|
||||
@ysrc: the top of the source rectangle within @src.
|
||||
@xdest: the x coordinate of the destination within @drawable.
|
||||
@ydest: the y coordinate of the destination within @drawable.
|
||||
@width: the width of the area to be copied, or -1 to make the area extend to
|
||||
the right edge of the source pixmap.
|
||||
@height: the height of the area to be copied, or -1 to make the area extend
|
||||
to the bottom edge of the source pixmap.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_image ##### -->
|
||||
<para>
|
||||
Draws a #GdkImage onto a drawable.
|
||||
The depth of the #GdkImage must match the depth of the #GdkDrawable.
|
||||
</para>
|
||||
|
||||
@drawable: a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
|
||||
@gc: a #GdkGC.
|
||||
@image: the #GdkImage to draw.
|
||||
@xsrc: the left edge of the source rectangle within @image.
|
||||
@ysrc: the top of the source rectangle within @image.
|
||||
@xdest: the x coordinate of the destination within @drawable.
|
||||
@ydest: the y coordinate of the destination within @drawable.
|
||||
@width: the width of the area to be copied, or -1 to make the area extend to
|
||||
the right edge of @image.
|
||||
@height: the height of the area to be copied, or -1 to make the area extend
|
||||
to the bottom edge of @image.
|
||||
|
||||
|
||||
@@ -1,368 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Event Structures
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
data structures specific to each type of event.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The event structs contain data specific to each type of event in GDK.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
A common mistake is to forget to set the event mask of a widget so that the
|
||||
required events are received. See gtk_widget_set_events().
|
||||
</para>
|
||||
</note>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### UNION GdkEvent ##### -->
|
||||
<para>
|
||||
The #GdkEvent struct contains a union of all of the event structs,
|
||||
and allows access to the data fields in a number of ways.
|
||||
</para>
|
||||
<para>
|
||||
The event type is always the first field in all of the event structs, and
|
||||
can always be accessed with the following code, no matter what type of event
|
||||
it is:
|
||||
<informalexample>
|
||||
<programlisting>
|
||||
GdkEvent *event;
|
||||
GdkEventType type;
|
||||
|
||||
type = event->type;
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
To access other fields of the event structs, the pointer to the event can be
|
||||
cast to the appropriate event struct pointer, or the union member name can be
|
||||
used. For example if the event type is %GDK_BUTTON_PRESS then the x coordinate
|
||||
of the button press can be accessed with:
|
||||
<informalexample>
|
||||
<programlisting>
|
||||
GdkEvent *event;
|
||||
gdouble x;
|
||||
|
||||
x = ((GdkEventButton*)event)->x;
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
or:
|
||||
<informalexample>
|
||||
<programlisting>
|
||||
GdkEvent *event;
|
||||
gdouble x;
|
||||
|
||||
x = event->button.x;
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GdkEventAny ##### -->
|
||||
<para>
|
||||
Contains the fields which are common to all event structs.
|
||||
Any event pointer can safely be cast to a pointer to a #GdkEventAny to access
|
||||
these fields.
|
||||
</para>
|
||||
|
||||
@type: the type of the event.
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
|
||||
<!-- ##### STRUCT GdkEventKey ##### -->
|
||||
<para>
|
||||
Describes a key press or key release event.
|
||||
</para>
|
||||
|
||||
@type: the type of the event (%GDK_KEY_PRESS or %GDK_KEY_RELEASE).
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@time: the time of the event in milliseconds.
|
||||
@state: a bit-mask representing the state of the modifier keys (e.g. Control,
|
||||
Shift and Alt) and the pointer buttons. See #GdkModifierType.
|
||||
@keyval: the key that was pressed or released. See the <gdk/gdkkeysym.h>
|
||||
header file for a complete list of GDK key codes.
|
||||
@length: the length of @string.
|
||||
@string: a null-terminated multi-byte string containing the composed characters
|
||||
resulting from the key press. When text is being input, in a GtkEntry for
|
||||
example, it is these characters which should be added to the input buffer.
|
||||
When using <link linkend="gdk-Input-Methods"> Input Methods</link> to support
|
||||
internationalized text input, the composed characters appear here after the
|
||||
pre-editing has been completed.
|
||||
|
||||
<!-- ##### STRUCT GdkEventButton ##### -->
|
||||
<para>
|
||||
Used for button press and button release events. The
|
||||
<structfield>type</structfield> field will be one of %GDK_BUTTON_PRESS,
|
||||
%GDK_2BUTTON_PRESS, %GDK_3BUTTON_PRESS, and %GDK_BUTTON_RELEASE.
|
||||
</para>
|
||||
<para>
|
||||
Double and triple-clicks result in a sequence of events being received.
|
||||
For double-clicks the order of events will be:
|
||||
<orderedlist>
|
||||
<listitem><para>%GDK_BUTTON_PRESS</para></listitem>
|
||||
<listitem><para>%GDK_BUTTON_RELEASE</para></listitem>
|
||||
<listitem><para>%GDK_BUTTON_PRESS</para></listitem>
|
||||
<listitem><para>%GDK_2BUTTON_PRESS</para></listitem>
|
||||
<listitem><para>%GDK_BUTTON_RELEASE</para></listitem>
|
||||
</orderedlist>
|
||||
Note that the first click is received just like a normal
|
||||
button press, while the second click results in a %GDK_2BUTTON_PRESS being
|
||||
received just after the %GDK_BUTTON_PRESS.
|
||||
</para>
|
||||
<para>
|
||||
Triple-clicks are very similar to double-clicks, except that %GDK_3BUTTON_PRESS
|
||||
is inserted after the third click. The order of the events is:
|
||||
<orderedlist>
|
||||
<listitem><para>%GDK_BUTTON_PRESS</para></listitem>
|
||||
<listitem><para>%GDK_BUTTON_RELEASE</para></listitem>
|
||||
<listitem><para>%GDK_BUTTON_PRESS</para></listitem>
|
||||
<listitem><para>%GDK_2BUTTON_PRESS</para></listitem>
|
||||
<listitem><para>%GDK_BUTTON_RELEASE</para></listitem>
|
||||
<listitem><para>%GDK_BUTTON_PRESS</para></listitem>
|
||||
<listitem><para>%GDK_3BUTTON_PRESS</para></listitem>
|
||||
<listitem><para>%GDK_BUTTON_RELEASE</para></listitem>
|
||||
</orderedlist>
|
||||
</para>
|
||||
<para>
|
||||
For a double click to occur, the second button press must occur within 1/4 of
|
||||
a second of the first. For a triple click to occur, the third button press
|
||||
must also occur within 1/2 second of the first button press.
|
||||
</para>
|
||||
|
||||
@type: the type of the event (%GDK_BUTTON_PRESS, %GDK_2BUTTON_PRESS,
|
||||
%GDK_3BUTTON_PRESS or %GDK_BUTTON_RELEASE).
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@time: the time of the event in milliseconds.
|
||||
@x: the x coordinate of the mouse relative to the window.
|
||||
@y: the y coordinate of the mouse relative to the window.
|
||||
@pressure: the pressure of the button press, intended for input devices such
|
||||
as graphics tablets. It defaults to 0.5.
|
||||
@xtilt: the horizontal tilt of the input device. Defaults to 0.
|
||||
@ytilt: the vertical tilt of the input device. Defaults to 0.
|
||||
@state: a bit-mask representing the state of the modifier keys (e.g. Control,
|
||||
Shift and Alt) and the pointer buttons. See #GdkModifierType.
|
||||
@button: the button which was pressed or released, numbered from 1 to 5.
|
||||
Normally button 1 is the left mouse button, 2 is the middle button,
|
||||
and 3 is the right button. On 2-button mice, the middle button can often
|
||||
be simulated by pressing both mouse buttons together.
|
||||
@source: the input device where the event came from, usually %GDK_SOURCE_MOUSE.
|
||||
@deviceid: the input device ID, usually %GDK_CORE_POINTER but may be
|
||||
different if touch screens or graphics tablets are being used.
|
||||
@x_root: the x coordinate of the mouse relative to the root of the screen.
|
||||
@y_root: the y coordinate of the mouse relative to the root of the screen.
|
||||
|
||||
<!-- ##### STRUCT GdkEventMotion ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type: the type of the event.
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@time:
|
||||
@x:
|
||||
@y:
|
||||
@pressure:
|
||||
@xtilt:
|
||||
@ytilt:
|
||||
@state:
|
||||
@is_hint:
|
||||
@source:
|
||||
@deviceid:
|
||||
@x_root:
|
||||
@y_root:
|
||||
|
||||
<!-- ##### STRUCT GdkEventExpose ##### -->
|
||||
<para>
|
||||
Generated when all or part of a window becomes visible and needs to be
|
||||
redrawn.
|
||||
</para>
|
||||
|
||||
@type: the type of the event (%GDK_EXPOSE).
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@area: the area that needs to be redrawn.
|
||||
@count: the number of contiguous %GDK_EXPOSE events following this one.
|
||||
The only use for this is "exposure compression", i.e. handling all contiguous
|
||||
%GDK_EXPOSE events in one go, though GDK performs some exposure compression
|
||||
so this is not normally needed.
|
||||
|
||||
<!-- ##### STRUCT GdkEventVisibility ##### -->
|
||||
<para>
|
||||
Generated when the window visibility status has changed.
|
||||
</para>
|
||||
|
||||
@type: the type of the event (%GDK_VISIBILITY_NOTIFY).
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@state: the new visibility state (%GDK_VISIBILITY_FULLY_OBSCURED,
|
||||
%GDK_VISIBILITY_PARTIAL or %GDK_VISIBILITY_UNOBSCURED).
|
||||
|
||||
<!-- ##### ENUM GdkVisibilityState ##### -->
|
||||
<para>
|
||||
Specifies the visiblity status of a window for a #GdkEventVisibility.
|
||||
</para>
|
||||
|
||||
@GDK_VISIBILITY_UNOBSCURED: the window is completely visible.
|
||||
@GDK_VISIBILITY_PARTIAL: the window is partially visible.
|
||||
@GDK_VISIBILITY_FULLY_OBSCURED: the window is not visible at all.
|
||||
|
||||
<!-- ##### STRUCT GdkEventCrossing ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type: the type of the event.
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@subwindow:
|
||||
@time: the time of the event in milliseconds.
|
||||
@x:
|
||||
@y:
|
||||
@x_root:
|
||||
@y_root:
|
||||
@mode:
|
||||
@detail:
|
||||
@focus:
|
||||
@state:
|
||||
|
||||
<!-- ##### ENUM GdkCrossingMode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_CROSSING_NORMAL:
|
||||
@GDK_CROSSING_GRAB:
|
||||
@GDK_CROSSING_UNGRAB:
|
||||
|
||||
<!-- ##### ENUM GdkNotifyType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_NOTIFY_ANCESTOR:
|
||||
@GDK_NOTIFY_VIRTUAL:
|
||||
@GDK_NOTIFY_INFERIOR:
|
||||
@GDK_NOTIFY_NONLINEAR:
|
||||
@GDK_NOTIFY_NONLINEAR_VIRTUAL:
|
||||
@GDK_NOTIFY_UNKNOWN:
|
||||
|
||||
<!-- ##### STRUCT GdkEventFocus ##### -->
|
||||
<para>
|
||||
Describes a change of keyboard focus.
|
||||
</para>
|
||||
|
||||
@type: the type of the event (%GDK_FOCUS_CHANGE).
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@in: TRUE if the window has gained the keyboard focus, FALSE if it has lost
|
||||
the focus.
|
||||
|
||||
<!-- ##### STRUCT GdkEventConfigure ##### -->
|
||||
<para>
|
||||
Generated when a window size or position has changed.
|
||||
</para>
|
||||
|
||||
@type: the type of the event (%GDK_CONFIGURE).
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@x: the new x coordinate of the window, relative to its parent.
|
||||
@y: the new y coordinate of the window, relative to its parent.
|
||||
@width: the new width of the window.
|
||||
@height: the new height of the window.
|
||||
|
||||
<!-- ##### STRUCT GdkEventProperty ##### -->
|
||||
<para>
|
||||
Describes a property change on a window.
|
||||
</para>
|
||||
|
||||
@type: the type of the event (%GDK_PROPERTY_NOTIFY).
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@atom: the property that was changed.
|
||||
@time: the time of the event in milliseconds.
|
||||
@state: whether the property was changed (%GDK_PROPERTY_NEW_VALUE) or
|
||||
deleted (%GDK_PROPERTY_DELETE).
|
||||
|
||||
<!-- ##### ENUM GdkPropertyState ##### -->
|
||||
<para>
|
||||
Specifies the type of a property change for a #GdkEventProperty.
|
||||
</para>
|
||||
|
||||
@GDK_PROPERTY_NEW_VALUE: the property value wan changed.
|
||||
@GDK_PROPERTY_DELETE: the property was deleted.
|
||||
|
||||
<!-- ##### STRUCT GdkEventSelection ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type: the type of the event.
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@selection:
|
||||
@target:
|
||||
@property:
|
||||
@requestor:
|
||||
@time: the time of the event in milliseconds.
|
||||
|
||||
<!-- ##### STRUCT GdkEventDND ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type: the type of the event.
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@context:
|
||||
@time: the time of the event in milliseconds.
|
||||
@x_root:
|
||||
@y_root:
|
||||
|
||||
<!-- ##### STRUCT GdkEventProximity ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type: the type of the event.
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@time: the time of the event in milliseconds.
|
||||
@source:
|
||||
@deviceid:
|
||||
|
||||
<!-- ##### STRUCT GdkEventClient ##### -->
|
||||
<para>
|
||||
An event sent by another client application.
|
||||
</para>
|
||||
|
||||
@type: the type of the event (%GDK_CLIENT_EVENT).
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
@message_type: the type of the message, which can be defined by the
|
||||
application.
|
||||
@data_format: the format of the data, given as the number of bits in each
|
||||
data element, i.e. 8, 16, or 32. 8-bit data uses the b array of the data
|
||||
union, 16-bit data uses the s array, and 32-bit data uses the l array.
|
||||
|
||||
<!-- ##### STRUCT GdkEventNoExpose ##### -->
|
||||
<para>
|
||||
Generated when the area of a #GdkDrawable being copied, with gdk_draw_pixmap()
|
||||
or gdk_window_copy_area(), was completely available.
|
||||
</para>
|
||||
<para>
|
||||
FIXME: add more here.
|
||||
</para>
|
||||
|
||||
@type: the type of the event (%GDK_NO_EXPOSE).
|
||||
@window: the window which received the event.
|
||||
@send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent).
|
||||
|
||||
@@ -1,303 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Events
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
functions for handling events from the window system.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
This section describes functions dealing with events from the window system.
|
||||
</para>
|
||||
<para>
|
||||
In GTK+ applications the events are handled automatically in
|
||||
gtk_main_do_event() and passed on to the appropriate widgets, so these
|
||||
functions are rarely needed. Though some of the fields in the
|
||||
<link linkend="gdk-Event-Structures">Event Structures</link> are useful.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><link linkend="gdk-Event-Structures">Event Structures</link></term>
|
||||
<listitem><para>
|
||||
The structs used for each type of event.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GdkEventType ##### -->
|
||||
<para>
|
||||
Specifies the type of the event.
|
||||
</para>
|
||||
<para>
|
||||
Do not confuse these events with the signals that GTK+ widgets emit.
|
||||
Although many of these events result in corresponding signals being emitted,
|
||||
the events are often transformed or filtered along the way.
|
||||
</para>
|
||||
|
||||
@GDK_NOTHING: a special code to indicate a null event.
|
||||
@GDK_DELETE: the window manager has requested that the toplevel window be
|
||||
hidden or destroyed, usually when the user clicks on a special icon in the
|
||||
title bar.
|
||||
@GDK_DESTROY: the window has been destroyed.
|
||||
@GDK_EXPOSE: all or part of the window has become visible and needs to be
|
||||
redrawn.
|
||||
@GDK_MOTION_NOTIFY: the pointer (usually a mouse) has moved.
|
||||
@GDK_BUTTON_PRESS: a mouse button has been pressed.
|
||||
@GDK_2BUTTON_PRESS: a mouse button has been double-clicked (clicked twice
|
||||
within a short period of time). Note that each click also generates a
|
||||
%GDK_BUTTON_PRESS event.
|
||||
@GDK_3BUTTON_PRESS: a mouse button has been clicked 3 times in a short period
|
||||
of time. Note that each click also generates a %GDK_BUTTON_PRESS event.
|
||||
@GDK_BUTTON_RELEASE: a mouse button has been released.
|
||||
@GDK_KEY_PRESS: a key has been pressed.
|
||||
@GDK_KEY_RELEASE: a key has been released.
|
||||
@GDK_ENTER_NOTIFY: the pointer has entered the window.
|
||||
@GDK_LEAVE_NOTIFY: the pointer has left the window.
|
||||
@GDK_FOCUS_CHANGE: the keyboard focus has entered or left the window.
|
||||
@GDK_CONFIGURE: the size, position or stacking order of the window has changed.
|
||||
Note that GTK+ discards these events for %GDK_WINDOW_CHILD windows.
|
||||
@GDK_MAP: the window has been mapped.
|
||||
@GDK_UNMAP: the window has been unmapped.
|
||||
@GDK_PROPERTY_NOTIFY: a property on the window has been changed or deleted.
|
||||
@GDK_SELECTION_CLEAR: the application has lost ownership of a selection.
|
||||
@GDK_SELECTION_REQUEST: another application has requested a selection.
|
||||
@GDK_SELECTION_NOTIFY: a selection has been received.
|
||||
@GDK_PROXIMITY_IN: an input device has moved into contact with a sensing
|
||||
surface (e.g. a touchscreen or graphics tablet).
|
||||
@GDK_PROXIMITY_OUT: an input device has moved out of contact with a sensing
|
||||
surface.
|
||||
@GDK_DRAG_ENTER: the mouse has entered the window while a drag is in progress.
|
||||
@GDK_DRAG_LEAVE: the mouse has left the window while a drag is in progress.
|
||||
@GDK_DRAG_MOTION: the mouse has moved in the window while a drag is in
|
||||
progress.
|
||||
@GDK_DRAG_STATUS: the status of the drag operation initiated by the window
|
||||
has changed.
|
||||
@GDK_DROP_START: a drop operation onto the window has started.
|
||||
@GDK_DROP_FINISHED: the drop operation initiated by the window has completed.
|
||||
@GDK_CLIENT_EVENT: a message has been received from another application.
|
||||
@GDK_VISIBILITY_NOTIFY: the window visibility status has changed.
|
||||
@GDK_NO_EXPOSE: indicates that the source region was completely available
|
||||
when parts of a drawable were copied. This is not very useful.
|
||||
|
||||
<!-- ##### ENUM GdkEventMask ##### -->
|
||||
<para>
|
||||
A set of bit-flags to indicate which events a window is to receive.
|
||||
Most of these masks map onto one or more of the #GdkEventType event types
|
||||
above.
|
||||
</para>
|
||||
<para>
|
||||
%GDK_POINTER_MOTION_HINT_MASK is a special mask which is used to reduce the
|
||||
number of %GDK_MOTION_NOTIFY events received. Normally a %GDK_MOTION_NOTIFY
|
||||
event is received each time the mouse moves. However, if the application
|
||||
spends a lot of time processing the event (updating the display, for example),
|
||||
it can easily lag behind the position of the mouse. When using the
|
||||
%GDK_POINTER_MOTION_HINT_MASK the server will only send %GDK_MOTION_NOTIFY
|
||||
events when the application asks for them, by calling gdk_window_get_pointer().
|
||||
</para>
|
||||
|
||||
@GDK_EXPOSURE_MASK:
|
||||
@GDK_POINTER_MOTION_MASK:
|
||||
@GDK_POINTER_MOTION_HINT_MASK:
|
||||
@GDK_BUTTON_MOTION_MASK:
|
||||
@GDK_BUTTON1_MOTION_MASK:
|
||||
@GDK_BUTTON2_MOTION_MASK:
|
||||
@GDK_BUTTON3_MOTION_MASK:
|
||||
@GDK_BUTTON_PRESS_MASK:
|
||||
@GDK_BUTTON_RELEASE_MASK:
|
||||
@GDK_KEY_PRESS_MASK:
|
||||
@GDK_KEY_RELEASE_MASK:
|
||||
@GDK_ENTER_NOTIFY_MASK:
|
||||
@GDK_LEAVE_NOTIFY_MASK:
|
||||
@GDK_FOCUS_CHANGE_MASK:
|
||||
@GDK_STRUCTURE_MASK:
|
||||
@GDK_PROPERTY_CHANGE_MASK:
|
||||
@GDK_VISIBILITY_NOTIFY_MASK:
|
||||
@GDK_PROXIMITY_IN_MASK:
|
||||
@GDK_PROXIMITY_OUT_MASK:
|
||||
@GDK_SUBSTRUCTURE_MASK:
|
||||
@GDK_ALL_EVENTS_MASK: the combination of all the above event masks.
|
||||
|
||||
<!-- ##### MACRO GDK_CURRENT_TIME ##### -->
|
||||
<para>
|
||||
Represents the current time, and can be used anywhere a time is expected.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GDK_PRIORITY_EVENTS ##### -->
|
||||
<para>
|
||||
This is the priority that events from the X server are given in the
|
||||
<link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_events_pending ##### -->
|
||||
<para>
|
||||
Checks if any events are waiting to be processed.
|
||||
</para>
|
||||
|
||||
@Returns: TRUE if any events are pending.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_event_peek ##### -->
|
||||
<para>
|
||||
Gets a copy of the first #GdkEvent in the event queue.
|
||||
(Note that this function will not get more events from the X server.
|
||||
It only checks the events that have already been moved to the GDK event queue.)
|
||||
</para>
|
||||
|
||||
@Returns: a copy of the first #GdkEvent on the event queue, or NULL if no
|
||||
events are in the queue. The returned #GdkEvent should be freed with
|
||||
gdk_event_free().
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_event_get ##### -->
|
||||
<para>
|
||||
Gets the next #GdkEvent to be processed, fetching events from the X server if
|
||||
necessary.
|
||||
</para>
|
||||
|
||||
@Returns: the next #GdkEvent to be processed, or NULL if no events are pending.
|
||||
The returned #GdkEvent should be freed with gdk_event_free().
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_event_get_graphics_expose ##### -->
|
||||
<para>
|
||||
Waits for a GraphicsExpose or NoExpose event from the X server.
|
||||
This is used in the #GtkText and #GtkCList widgets in GTK+ to make sure any
|
||||
GraphicsExpose events are handled before the widget is scrolled.
|
||||
</para>
|
||||
|
||||
@window: the #GdkWindow to wait for the events for.
|
||||
@Returns: a #GdkEventExpose if a GraphicsExpose was received, or NULL if a
|
||||
NoExpose event was received.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_event_put ##### -->
|
||||
<para>
|
||||
Appends a copy of the given event onto the front of the event queue.
|
||||
</para>
|
||||
|
||||
@event: a #GdkEvent.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_event_copy ##### -->
|
||||
<para>
|
||||
Copies a #GdkEvent, copying or incrementing the reference count of the
|
||||
resources associated with it (e.g. #GdkWindow's and strings).
|
||||
</para>
|
||||
|
||||
@event: a #GdkEvent.
|
||||
@Returns: a copy of @event. The returned #GdkEvent should be freed with
|
||||
gdk_event_free().
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_event_free ##### -->
|
||||
<para>
|
||||
Frees a #GdkEvent, freeing or decrementing any resources associated with it.
|
||||
Note that this function should only be called with events returned from
|
||||
gdk_event_peek(), gdk_event_get(), gdk_event_get_graphics_expose() and
|
||||
gdk_event_copy().
|
||||
</para>
|
||||
|
||||
@event: a #GdkEvent.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_event_get_time ##### -->
|
||||
<para>
|
||||
Gets the timestamp from a #GdkEvent.
|
||||
</para>
|
||||
|
||||
@event: a #GdkEvent.
|
||||
@Returns: the timestamp from @event, or #GDK_CURRENT_TIME if the event has
|
||||
no timestamp.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_event_handler_set ##### -->
|
||||
<para>
|
||||
Sets the function to call to handle all events from GDK.
|
||||
</para>
|
||||
<para>
|
||||
Note that GTK+ uses this to install its own event handler, so it is probably
|
||||
not useful for GTK+ applications.
|
||||
</para>
|
||||
|
||||
@func: the function to call to handle events from GDK.
|
||||
@data: user data to pass to the function.
|
||||
@notify: the function to call when the handler function is removed, i.e. when
|
||||
gdk_event_handler_set() is called with another event handler.
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GdkEventFunc ##### -->
|
||||
<para>
|
||||
Specifies the type of function passed to gdk_event_handler_set() to handle
|
||||
all GDK events.
|
||||
</para>
|
||||
|
||||
@event: the #GdkEvent to process.
|
||||
@data: user data set when the event handler was installed with
|
||||
gdk_event_handler_set().
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_event_send_client_message ##### -->
|
||||
<para>
|
||||
Sends an X ClientMessage event to a given window.
|
||||
</para>
|
||||
<para>
|
||||
This could be used for communicating between different applications,
|
||||
though the amount of data is limited to 20 bytes.
|
||||
</para>
|
||||
|
||||
@event: the #GdkEvent to send, which should be a #GdkEventClient.
|
||||
@xid: the window to send the X ClientMessage event to.
|
||||
@Returns: non-zero on success.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_event_send_clientmessage_toall ##### -->
|
||||
<para>
|
||||
Sends an X ClientMessage event to all toplevel windows.
|
||||
</para>
|
||||
<para>
|
||||
Toplevel windows are determined by checking for the WM_STATE property, as
|
||||
described in the Inter-Client Communication Conventions Manual (ICCCM).
|
||||
If no windows are found with the WM_STATE property set, the message is sent
|
||||
to all children of the root window.
|
||||
</para>
|
||||
|
||||
@event: the #GdkEvent to send, which should be a #GdkEventClient.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_add_client_message_filter ##### -->
|
||||
<para>
|
||||
Adds a filter to be called when X ClientMessage events are received.
|
||||
</para>
|
||||
|
||||
@message_type: the type of ClientMessage events to receive. This will be
|
||||
checked against the <structfield>message_type</structfield> field of the
|
||||
XClientMessage event struct.
|
||||
@func: the function to call to process the event.
|
||||
@data: user data to pass to @func.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_get_show_events ##### -->
|
||||
<para>
|
||||
Returns non-zero if event debugging output is enabled.
|
||||
</para>
|
||||
|
||||
@Returns: non-zero if event debugging output is enabled.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_set_show_events ##### -->
|
||||
<para>
|
||||
Sets whether event debugging information is output.
|
||||
Note that GTK+ must be compiled with debugging enabled, i.e. using the
|
||||
'--enable-debug' configure option.
|
||||
</para>
|
||||
|
||||
@show_events: TRUE to output event debugging information.
|
||||
|
||||
|
||||
@@ -1,643 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Fonts
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
loading and manipulating fonts
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The GdkFont data type represents a font for drawing on
|
||||
the screen. These functions provide support for
|
||||
loading fonts, and also for determining the dimensions
|
||||
of characters and strings when drawn with a particular
|
||||
font.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Fonts in X are specified by a
|
||||
<firstterm>X Logical Font Description</firstterm>.
|
||||
The following description is considerably simplified.
|
||||
For definitive information about XLFD's see the
|
||||
X reference documentation. A X Logical Font Description (XLFD)
|
||||
consists of a sequence of fields separated (and surrounded by) '-'
|
||||
characters. For example, Adobe Helvetica Bold 12 pt, has the
|
||||
full description:
|
||||
|
||||
<programlisting>
|
||||
"-adobe-helvetica-bold-r-normal--12-120-75-75-p-70-iso8859-1"
|
||||
</programlisting>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The fields in the XLFD are:
|
||||
|
||||
<informaltable pgwide=1 frame="none">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>Foundry</entry>
|
||||
<entry>the company or organization where the font originated.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Family</entry>
|
||||
<entry>the font family (a group of related font designs).</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Weight</entry>
|
||||
<entry>A name for the font's typographic weight
|
||||
For example, 'bold' or 'medium').</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Slant</entry>
|
||||
<entry>The slant of the font. Common values are 'R' for Roman,
|
||||
'I' for italoc, and 'O' for oblique.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Set Width</entry>
|
||||
<entry>A name for the width of the font. For example,
|
||||
'normal' or 'condensed'.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Add Style</entry>
|
||||
<entry>Additional information to distinguish a font from
|
||||
other fonts of the same family.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Pixel Size</entry>
|
||||
<entry>The body size of the font in pixels.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Point Size</entry>
|
||||
<entry>The body size of the font in 10ths of a point.
|
||||
(A <firstterm>point</firstterm> is 1/72.27 inch) </entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Resolution X</entry>
|
||||
<entry>The horizontal resolution that the font was designed for.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Resolution Y</entry>
|
||||
<entry>The vertical resolution that the font was designed for .</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Spacing</entry>
|
||||
<entry>The type of spacing for the font - can be 'p' for proportional,
|
||||
'm' for monospaced or 'c' for charcell.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Average Width</entry>
|
||||
<entry>The average width of a glyph in the font. For monospaced
|
||||
and charcell fonts, all glyphs in the font have this width</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Charset Registry</entry>
|
||||
<entry>The registration authority that owns the encoding for
|
||||
the font. Together with the Charset Encoding field, this
|
||||
defines the character set for the font.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Charset Encoding</entry>
|
||||
<entry>An identifier for the particular character set encoding.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
When specifying a font via a X logical Font Description,
|
||||
'*' can be used as a wildcard to match any portion of
|
||||
the XLFD. For instance, the above example could
|
||||
also be specified as
|
||||
|
||||
<programlisting>
|
||||
"-*-helvetica-bold-r-normal--*-120-*-*-*-*-iso8859-1"
|
||||
</programlisting>
|
||||
|
||||
It is generally a good idea to use wildcards for any
|
||||
portion of the XLFD that your program does not care
|
||||
about specifically, since that will improve the
|
||||
chances of finding a matching font.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
A <firstterm>fontset</firstterm> is a list of fonts
|
||||
that is used for drawing international text that may
|
||||
contain characters from a number of different character
|
||||
sets. It is represented by a list of XLFD's.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The font for a given character set is determined by going
|
||||
through the list of XLFD's in order. For each one, if
|
||||
the registry and and encoding fields match the desired
|
||||
character set, then that font is used, otherwise if
|
||||
the XLFD contains wild-cards for the registry and encoding
|
||||
fields, the registry and encoding for the desired character
|
||||
set are subsituted in and a lookup is done. If a match is found
|
||||
that font is used. Otherwise, processing continues
|
||||
on to the next font in the list.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The functions for determining the metrics of a string
|
||||
come in several varieties that can take a number
|
||||
of forms of string input:
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>8-bit string</term>
|
||||
<listitem><para>
|
||||
When using functions like gdk_string_width() that
|
||||
take a <type>gchar *</type>, if the font is of type
|
||||
%GDK_FONT_FONT and is an 8-bit font, then each
|
||||
<type>gchar</type> indexes the glyphs in the font directly.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>16-bit string</term>
|
||||
<listitem><para>
|
||||
For functions taking a <type>gchar *</type>, if the
|
||||
font is of type %GDK_FONT_FONT, and is a 16-bit
|
||||
font, then the <type>gchar *</type> argument is
|
||||
interpreted as a <type>guint16 *</type> cast to
|
||||
a <type>gchar *</type> and each <type>guint16</type>
|
||||
indexes the glyphs in the font directly.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>Multibyte string</term>
|
||||
<listitem><para>
|
||||
For functions taking a <type>gchar *</type>, if the
|
||||
font is of type %GDK_FONT_FONTSET, then the input
|
||||
string is interpreted as a <firstterm>multibyte</firstterm>
|
||||
encoded according to the current locale. (A multibyte
|
||||
string is one in which each character may consist
|
||||
of one or more bytes, with different lengths for different
|
||||
characters in the string). They can be converted to and
|
||||
from wide character strings (see below) using
|
||||
gdk_wcstombs() and gdk_mbstowcs().) The string will
|
||||
be rendered using one or more different fonts from
|
||||
the fontset.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>Wide character string</term>
|
||||
<listitem><para>
|
||||
For a number of the text-measuring functions, GTK+
|
||||
provides a variant (such as gdk_text_width_wc()) which
|
||||
takes a <type>GdkWChar *</type> instead of a
|
||||
<type>gchar *</type>. The input is then taken to
|
||||
be a wide character string in the encoding of the
|
||||
current locale. (A wide character string is a string
|
||||
in which each character consists of several bytes,
|
||||
and the width of each character in the string is
|
||||
constant.)
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
GDK provides functions to determine a number of different
|
||||
measurements (metrics) for a given string. (Need diagram
|
||||
here).
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>ascent</term>
|
||||
<listitem><para>
|
||||
The vertical distance from the origin of the drawing
|
||||
opereration to the top of the drawn character.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>descent</term>
|
||||
<listitem><para>
|
||||
The vertical distance from the origin of the drawing
|
||||
opereration to the bottom of the drawn character.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>left bearing</term>
|
||||
<listitem><para>
|
||||
The horizontal distance from the origin of the drawing
|
||||
operation to the left-most part of the drawn character.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>right bearing</term>
|
||||
<listitem><para>
|
||||
The horizontal distance from the origin of the drawing
|
||||
operation to the right-most part of the drawn character.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>width bearing</term>
|
||||
<listitem><para>
|
||||
The horizontal distance from the origin of the drawing
|
||||
operation to the correct origin for drawing another
|
||||
string to follow the current one. Depending on the
|
||||
font, this could be greater than or less than the
|
||||
right bearing.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GdkFont ##### -->
|
||||
<para>
|
||||
The GdkFont structure represents a font or fontset. It
|
||||
contains the following public fields. A new GdkFont
|
||||
structure is returned by gdk_font_load() or gdk_fontset_load(),
|
||||
and is reference counted with gdk_font_ref() and gdk_font_unref()
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry><structfield>type</structfield></entry>
|
||||
<entry>a value of type #GdkFontType which indicates
|
||||
whether this font is a single font or a fontset.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>ascent</structfield></entry>
|
||||
<entry>the maximum distance that the font, when drawn,
|
||||
ascends above the baseline.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>descent</structfield></entry>
|
||||
<entry>the maximum distance that the font, when drawn,
|
||||
descends below the baseline.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@ascent:
|
||||
@descent:
|
||||
|
||||
<!-- ##### ENUM GdkFontType ##### -->
|
||||
<para>
|
||||
Indicates the type of a font. The possible values
|
||||
are currently:
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="enum">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>GDK_FONT_FONT</entry>
|
||||
<entry>the font is a single font.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_FONT_FONT</entry>
|
||||
<entry>the font is a fontset.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@GDK_FONT_FONT:
|
||||
@GDK_FONT_FONTSET:
|
||||
|
||||
<!-- ##### FUNCTION gdk_font_load ##### -->
|
||||
<para>
|
||||
Loads a font.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Currently, this function will always return a new
|
||||
font, however, in the future, it may be changed to
|
||||
look up the font in a cache. You should make no
|
||||
assumptions about the initial reference count.
|
||||
</para>
|
||||
|
||||
@font_name: a XLFD describing the font to load.
|
||||
@Returns: a #GdkFont, or NULL if the font could not be loaded.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_fontset_load ##### -->
|
||||
<para>
|
||||
Loads a fontset.
|
||||
</para>
|
||||
<para>
|
||||
Currently this function will always return a new
|
||||
font, however, in the future, it may be changed to
|
||||
look up the font in a cache. You should make no
|
||||
assumptions about the initial reference count.
|
||||
</para>
|
||||
|
||||
@fontset_name: a comma-separated list of XLFDs describing
|
||||
the component fonts of the fontset to load.
|
||||
@Returns: a #GdkFont, or NULL if the fontset could not be loaded.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_font_ref ##### -->
|
||||
<para>
|
||||
Increase the reference count of a count by one.
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@Returns: @font
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_font_unref ##### -->
|
||||
<para>
|
||||
Decrease the reference count of a count by one.
|
||||
If the result is zero, destroys the font.
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_font_id ##### -->
|
||||
<para>
|
||||
Returns the X Font ID for the given font.
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont.
|
||||
@Returns: the numeric X Font ID
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_font_equal ##### -->
|
||||
<para>
|
||||
Compares two fonts for equality. Single fonts compare equal
|
||||
if they have the same X font ID. This operation does
|
||||
not currently work correctly for fontsets.
|
||||
</para>
|
||||
|
||||
@fonta: a #GdkFont.
|
||||
@fontb: another #GdkFont.
|
||||
@Returns: %TRUE if the fonts are equal.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_string_extents ##### -->
|
||||
<para>
|
||||
Returns the metrics of a NULL-terminated string.
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont.
|
||||
@string: the NULL-terminated string to measure.
|
||||
@lbearing: the left bearing of the string.
|
||||
@rbearing: the right bearing of the string.
|
||||
@width: the width of the string.
|
||||
@ascent: the ascent of the string.
|
||||
@descent: the descent of the string.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_text_extents ##### -->
|
||||
<para>
|
||||
Returns the metrics of a string.
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@text: the text to measure
|
||||
@text_length: the length of the text in bytes. (If the
|
||||
font is a 16-bit font, this is twice the length
|
||||
of the text in characters.)
|
||||
@lbearing: the left bearing of the string.
|
||||
@rbearing: the right bearing of the string.
|
||||
@width: the width of the string.
|
||||
@ascent: the ascent of the string.
|
||||
@descent: the descent of the string.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_text_extents_wc ##### -->
|
||||
<para>
|
||||
Returns the metrics of a string of wide characters.
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@text: the text to measure.
|
||||
@text_length: the length of the text in character.
|
||||
@lbearing: the left bearing of the string.
|
||||
@rbearing: the right bearing of the string.
|
||||
@width: the width of the string.
|
||||
@ascent: the ascent of the string.
|
||||
@descent: the descent of the string.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_string_width ##### -->
|
||||
<para>
|
||||
Determine the width of a NULL-terminated string.
|
||||
(The distance from the origin of the string to the
|
||||
point where the next string in a sequence of strings
|
||||
should be drawn)
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@string: the NULL-terminated string to measure
|
||||
@Returns: the width of the string in pixels.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_text_width ##### -->
|
||||
<para>
|
||||
Determine the width of a given string.
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@text: the text to measure.
|
||||
@text_length: the length of the text in bytes.
|
||||
@Returns: the width of the string in pixels.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_text_width_wc ##### -->
|
||||
<para>
|
||||
Determine the width of a given wide-character string.
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@text: the text to measure.
|
||||
@text_length: the length of the text in characters.
|
||||
@Returns: the width of the string in pixels.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_char_width ##### -->
|
||||
<para>
|
||||
Determine the width of a given character.
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@character: the character to measure.
|
||||
@Returns: the width of the character in pixels.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_char_width_wc ##### -->
|
||||
<para>
|
||||
Determine the width of a given wide character. (Encoded
|
||||
in the wide-character encoding of the current locale).
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@character: the character to measure.
|
||||
@Returns: the width of the character in pixels.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_string_measure ##### -->
|
||||
<para>
|
||||
Determines the distance from the origin to the rightmost
|
||||
portion of a NULL-terminated string when drawn. This is not the
|
||||
correct value for determining the origin of the next
|
||||
portion when drawing text in multiple pieces.
|
||||
See gdk_string_width().
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@string: the NULL-terminated string to measure.
|
||||
@Returns: the right bearing of the string in pixels.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_text_measure ##### -->
|
||||
<para>
|
||||
Determines the distance from the origin to the rightmost
|
||||
portion of a string when drawn. This is not the
|
||||
correct value for determining the origin of the next
|
||||
portion when drawing text in multiple pieces.
|
||||
See gdk_text_width().
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@text: the text to measure.
|
||||
@text_length: the length of the text in bytes.
|
||||
@Returns: the right bearing of the string in pixels.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_char_measure ##### -->
|
||||
<para>
|
||||
Determines the distance from the origin to the rightmost
|
||||
portion of a character when drawn. This is not the
|
||||
correct value for determining the origin of the next
|
||||
portion when drawing text in multiple pieces.
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@character: the character to measure.
|
||||
@Returns: the right bearing of the character in pixels.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_string_height ##### -->
|
||||
<para>
|
||||
Determines the total height of a given NULL-terminated
|
||||
string. This value is not generally useful, because you
|
||||
cannot determine how this total height will be drawn in
|
||||
relation to the baseline. See gdk_string_extents().
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@string: the NULL-terminated string to measure.
|
||||
@Returns: the height of the string in pixels.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_text_height ##### -->
|
||||
<para>
|
||||
Determines the total height of a given string.
|
||||
This value is not generally useful, because you cannot
|
||||
determine how this total height will be drawn in
|
||||
relation to the baseline. See gdk_text_extents().
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@text: the text to measure.
|
||||
@text_length: the length of the text in bytes.
|
||||
@Returns: the height of the string in pixels.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_char_height ##### -->
|
||||
<para>
|
||||
Determines the total height of a given character.
|
||||
This value is not generally useful, because you cannot
|
||||
determine how this total height will be drawn in
|
||||
relation to the baseline. See gdk_text_extents().
|
||||
</para>
|
||||
|
||||
@font: a #GdkFont
|
||||
@character: the character to measure.
|
||||
@Returns: the height of the character in pixels.
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF GdkWChar ##### -->
|
||||
<para>
|
||||
Specifies a wide character type, used to represent character codes.
|
||||
This is needed since some native languages have character sets which have
|
||||
more than 256 characters (Japanese and Chinese, for example).
|
||||
</para>
|
||||
<para>
|
||||
Wide character values between 0 and 127 are always identical in meaning to
|
||||
the ASCII character codes. The wide character value 0 is often used to
|
||||
terminate strings of wide characters in a similar way to normal strings
|
||||
using the char type.
|
||||
</para>
|
||||
<para>
|
||||
An alternative to wide characters is multi-byte characters, which extend
|
||||
normal char strings to cope with larger character sets. As the name suggests,
|
||||
multi-byte characters use a different number of bytes to store different
|
||||
character codes. For example codes 0-127 (i.e. the ASCII codes) often
|
||||
use just one byte of memory, while other codes may use 2, 3 or even 4 bytes.
|
||||
Multi-byte characters have the advantage that they can often be used in an
|
||||
application with little change, since strings are still represented as arrays
|
||||
of char values. However multi-byte strings are much easier to manipulate since
|
||||
the character are all of the same size.
|
||||
</para>
|
||||
<para>
|
||||
Applications typically use wide characters to represent character codes
|
||||
internally, and multi-byte strings when saving the characters to a file.
|
||||
The gdk_wcstombs() and gdk_mbstowcs() functions can be used to convert from
|
||||
one representation to the other.
|
||||
</para>
|
||||
<para>
|
||||
See the 'Extended Characters' section of the GNU C Library Reference Manual
|
||||
for more detailed information on wide and multi-byte characters.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_wcstombs ##### -->
|
||||
<para>
|
||||
Converts a wide character string to a multi-byte string.
|
||||
(The function name comes from an acronym of 'Wide Character String TO
|
||||
Multi-Byte String').
|
||||
</para>
|
||||
|
||||
@src: a wide character string.
|
||||
@Returns: the multi-byte string corresponding to @src, or NULL if the
|
||||
conversion failed. The returned string should be freed with g_free() when no
|
||||
longer needed.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_mbstowcs ##### -->
|
||||
<para>
|
||||
Converts a multi-byte string to a wide character string.
|
||||
(The function name comes from an acronym of 'Multi-Byte String TO Wide
|
||||
Character String').
|
||||
</para>
|
||||
|
||||
@dest: the space to place the converted wide character string into.
|
||||
@src: the multi-byte string to convert, which must be null-terminated.
|
||||
@dest_max: the maximum number of wide characters to place in @dest.
|
||||
@Returns: the number of wide characters written into @dest, or -1 if the
|
||||
conversion failed.
|
||||
|
||||
|
||||
@@ -1,639 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Graphics Contexts
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
objects to encapsulate drawing properties.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
All drawing operations in GDK take a
|
||||
<firstterm>graphics context</firstterm> (GC) argument.
|
||||
A graphics context encapsulates information about
|
||||
the way things are drawn, such as the foreground
|
||||
color or line width. By using graphics contexts,
|
||||
the number of arguments to each drawing call is
|
||||
greatly reduced, and communication overhead is
|
||||
minimized, since identical arguments do not need
|
||||
to be passed repeatedly.
|
||||
</para>
|
||||
<para>
|
||||
Most values of a graphics context can be set at
|
||||
creation time by using gdk_gc_new_with_values(),
|
||||
or can be set one-by-one using functions such
|
||||
as gdk_gc_set_foreground(). A few of the values
|
||||
in the GC, such as the dash pattern, can only
|
||||
be set by the latter method.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GdkGC ##### -->
|
||||
<para>
|
||||
The #GdkGC structure represents a graphics context.
|
||||
It is an opaque structure with no user-visible
|
||||
elements.
|
||||
</para>
|
||||
|
||||
@dummy_var:
|
||||
|
||||
<!-- ##### STRUCT GdkGCValues ##### -->
|
||||
<para>
|
||||
The #GdkGCValues structure holds a set of values used
|
||||
to create or modify a graphics context.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#GdkColor foreground;</entry>
|
||||
<entry>the foreground color.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GdkColor background;</entry>
|
||||
<entry>the background color.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GdkFont *font;</entry>
|
||||
<entry>the default font..</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GdkFunction function;</entry>
|
||||
<entry>the bitwise operation used when drawing.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GdkFill fill;</entry>
|
||||
<entry>the fill style.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GdkPixmap *tile;</entry>
|
||||
<entry>the tile pixmap.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GdkPixmap *stipple;</entry>
|
||||
<entry>the stipple bitmap.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GdkPixmap *clip_mask;</entry>
|
||||
<entry>the clip mask bitmap.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GdkSubwindowMode subwindow_mode;</entry>
|
||||
<entry>the subwindow mode.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gint ts_x_origin;</entry>
|
||||
<entry>the x origin of the tile or stipple.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gint ts_y_origin;</entry>
|
||||
<entry>the y origin of the tile or stipple.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gint clip_x_origin;</entry>
|
||||
<entry>the x origin of the clip mask.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gint clip_y_origin;</entry>
|
||||
<entry>the y origin of the clip mask.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gint graphics_exposures;</entry>
|
||||
<entry>whether graphics exposures are enabled.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gint line_width;</entry>
|
||||
<entry>the line width</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GdkLineStyle line_style;</entry>
|
||||
<entry>the way dashed lines are drawn</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GdkCapStyle cap_style;</entry>
|
||||
<entry>the way the ends of lines are drawn</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GdkJoinStyle join_style;</entry>
|
||||
<entry>the way joins between lines are drawn</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@foreground:
|
||||
@background:
|
||||
@font:
|
||||
@function:
|
||||
@fill:
|
||||
@tile:
|
||||
@stipple:
|
||||
@clip_mask:
|
||||
@subwindow_mode:
|
||||
@ts_x_origin:
|
||||
@ts_y_origin:
|
||||
@clip_x_origin:
|
||||
@clip_y_origin:
|
||||
@graphics_exposures:
|
||||
@line_width:
|
||||
@line_style:
|
||||
@cap_style:
|
||||
@join_style:
|
||||
|
||||
<!-- ##### ENUM GdkGCValuesMask ##### -->
|
||||
<para>
|
||||
A set of bit flags used to indicate which fields
|
||||
#GdkGCValues structure are set.
|
||||
</para>
|
||||
|
||||
@GDK_GC_FOREGROUND:
|
||||
@GDK_GC_BACKGROUND:
|
||||
@GDK_GC_FONT:
|
||||
@GDK_GC_FUNCTION:
|
||||
@GDK_GC_FILL:
|
||||
@GDK_GC_TILE:
|
||||
@GDK_GC_STIPPLE:
|
||||
@GDK_GC_CLIP_MASK:
|
||||
@GDK_GC_SUBWINDOW:
|
||||
@GDK_GC_TS_X_ORIGIN:
|
||||
@GDK_GC_TS_Y_ORIGIN:
|
||||
@GDK_GC_CLIP_X_ORIGIN:
|
||||
@GDK_GC_CLIP_Y_ORIGIN:
|
||||
@GDK_GC_EXPOSURES:
|
||||
@GDK_GC_LINE_WIDTH:
|
||||
@GDK_GC_LINE_STYLE:
|
||||
@GDK_GC_CAP_STYLE:
|
||||
@GDK_GC_JOIN_STYLE:
|
||||
|
||||
<!-- ##### ENUM GdkFunction ##### -->
|
||||
<para>
|
||||
Determines how the bit values for the source pixels are combined with
|
||||
the bit values for destination pixels to produce the final result. The
|
||||
sixteen values here correspond to the 16 different possible 2x2 truth
|
||||
tables. Only a couple of these values are usually useful; for colored
|
||||
images, only %GDK_COPY, %GDK_XOR and %GDK_INVERT are generally
|
||||
useful. For bitmaps, %GDK_AND and %GDK_OR are also useful.
|
||||
</para>
|
||||
|
||||
@GDK_COPY:
|
||||
@GDK_INVERT:
|
||||
@GDK_XOR:
|
||||
@GDK_CLEAR:
|
||||
@GDK_AND:
|
||||
@GDK_AND_REVERSE:
|
||||
@GDK_AND_INVERT:
|
||||
@GDK_NOOP:
|
||||
@GDK_OR:
|
||||
@GDK_EQUIV:
|
||||
@GDK_OR_REVERSE:
|
||||
@GDK_COPY_INVERT:
|
||||
@GDK_OR_INVERT:
|
||||
@GDK_NAND:
|
||||
@GDK_SET:
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_new ##### -->
|
||||
<para>
|
||||
Create a new graphics context with default values.
|
||||
</para>
|
||||
|
||||
@window: a #GdkDrawable. The created GC must always be used
|
||||
with drawables of the same depth as this one.
|
||||
@Returns: the new graphics context.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_new_with_values ##### -->
|
||||
<para>
|
||||
Create a new GC with the given initial values.
|
||||
</para>
|
||||
|
||||
@window: a #GdkDrawable. The created GC must always be used
|
||||
with drawables of the same depth as this one.
|
||||
@values: a structure containing initial values for the GC.
|
||||
@values_mask: a bit mask indicating which fields in @values
|
||||
are set.
|
||||
@Returns: the new graphics context.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_ref ##### -->
|
||||
<para>
|
||||
Increase the reference count on a graphics context.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@Returns: @gc.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_unref ##### -->
|
||||
<para>
|
||||
Decrease the reference count on a graphics context. If
|
||||
the resulting reference count is zero, the graphics
|
||||
context will be destroyed.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_destroy ##### -->
|
||||
<para>
|
||||
Identical to gdk_gc_unref(). This function is obsolete
|
||||
and should not be used.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_get_values ##### -->
|
||||
<para>
|
||||
Retrieves the current values from a graphics context.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@values: the #GdkGCValues structure in which to store the results.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_foreground ##### -->
|
||||
<para>
|
||||
Sets the foreground color for a graphics context.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@color: the new foreground color.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_background ##### -->
|
||||
<para>
|
||||
Sets the background color for a graphics context.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@color: the new background color.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_font ##### -->
|
||||
<para>
|
||||
Sets the font for a graphics context. (Note that
|
||||
all text-drawing functions in GDK take a @font
|
||||
argument; the value set here is used when that
|
||||
argument is %NULL.)
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@font: the new font.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_function ##### -->
|
||||
<para>
|
||||
Determines how the current pixel values and the
|
||||
pixel values being drawn are combined to produce
|
||||
the final pixel values.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@function:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_fill ##### -->
|
||||
<para>
|
||||
Set the fill mode for a graphics context.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@fill: the new fill mode.
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkFill ##### -->
|
||||
<para>
|
||||
Determines how primitives are drawn.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="enum">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>GDK_SOLID</entry>
|
||||
<entry>draw with the foreground color.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_TILED</entry>
|
||||
<entry>draw with a tiled pixmap.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_STIPPLED</entry>
|
||||
<entry>draw using the stipple bitmap. Pixels corresponding
|
||||
to bits in the stipple bitmap that are set will be drawn in the
|
||||
foreground color; pixels corresponding to bits that are
|
||||
not set will be left untouched.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_OPAQUE_STIPPLED</entry>
|
||||
<entry>draw using the stipple bitmap. Pixels corresponding
|
||||
to bits in the stipple bitmap that are set will be drawn in the
|
||||
foreground color; pixels corresponding to bits that are
|
||||
not set will be drawn with the background color.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@GDK_SOLID:
|
||||
@GDK_TILED:
|
||||
@GDK_STIPPLED:
|
||||
@GDK_OPAQUE_STIPPLED:
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_tile ##### -->
|
||||
<para>
|
||||
Set a tile pixmap for a graphics context.
|
||||
This will only be used if the fill mode
|
||||
is %GDK_TILED.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@tile: the new tile pixmap.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_stipple ##### -->
|
||||
<para>
|
||||
Set the stipple bitmap for a graphics context. The
|
||||
stipple will only be used if the fill mode is
|
||||
%GDK_STIPPLED or %GDK_OPAQUE_STIPPLED.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@stipple: the new stipple bitmap.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_ts_origin ##### -->
|
||||
<para>
|
||||
Set the origin when using tiles or stipples with
|
||||
the GC. The tile or stipple will be aligned such
|
||||
that the upper left corner of the tile or stipple
|
||||
will coincide with this point.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@x: the x-coordinate of the origin.
|
||||
@y: the y-coordinate of the origin.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_clip_origin ##### -->
|
||||
<para>
|
||||
Sets the origin of the clip mask. The coordinates are
|
||||
interpreted relative to the upper-left corner of
|
||||
the destination drawable of the current operation.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@x: the x-coordinate of the origin.
|
||||
@y: the y-coordinate of the origin.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_clip_mask ##### -->
|
||||
<para>
|
||||
Sets the clip mask for a graphics context from a bitmap.
|
||||
The clip mask is interpreted relative to the clip
|
||||
origin. (See gdk_gc_set_clip_origin()).
|
||||
</para>
|
||||
|
||||
@gc: the #GdkGC.
|
||||
@mask: a bitmap.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_clip_rectangle ##### -->
|
||||
<para>
|
||||
Sets the clip mask for a graphics context from a
|
||||
rectangle. The clip mask is interpreted relative to the clip
|
||||
origin. (See gdk_gc_set_clip_origin()).
|
||||
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@rectangle: the rectangle to clip to.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_clip_region ##### -->
|
||||
<para>
|
||||
Sets the clip mask for a graphics context from a region structure.
|
||||
The clip mask is interpreted relative to the clip origin. (See
|
||||
gdk_gc_set_clip_origin()).
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@region: the #GdkRegion.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_subwindow ##### -->
|
||||
<para>
|
||||
Sets how drawing with this GC on a window will affect child
|
||||
windows of that window.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@mode: the subwindow mode.
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkSubwindowMode ##### -->
|
||||
<para>
|
||||
|
||||
Determines how drawing onto a window will affect child
|
||||
windows of that window.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="enum">
|
||||
<tgroup cols="2"><colspec colwidth="3*"><colspec colwidth="7*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>GDK_CLIP_BY_CHILDREN</entry>
|
||||
<entry>only draw onto the window itself.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_INCLUDE_INFERIORS</entry>
|
||||
<entry>Draw onto the window and child windows.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@GDK_CLIP_BY_CHILDREN:
|
||||
@GDK_INCLUDE_INFERIORS:
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_exposures ##### -->
|
||||
<para>
|
||||
Sets whether copying non-visible portions of a drawable
|
||||
using this graphics context generate exposure events
|
||||
for the corresponding regions of the destination
|
||||
drawable. (See gdk_draw_pixmap()).
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@exposures: if %TRUE, exposure events will be generated.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_line_attributes ##### -->
|
||||
<para>
|
||||
Sets various attributes of how lines are drawn. See
|
||||
the corresponding members of GdkGCValues for full
|
||||
explanations of the arguments.
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@line_width: the width of lines.
|
||||
@line_style: the dash-style for lines.
|
||||
@cap_style: the manner in which the ends of lines are drawn.
|
||||
@join_style: the in which lines are joined together.
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkLineStyle ##### -->
|
||||
<para>
|
||||
Determines how lines are drawn.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="enum">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>GDK_LINE_SOLID</entry>
|
||||
<entry>lines are drawn solid.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_LINE_ON_OFF_DASH</entry>
|
||||
<entry>even segments are drawn; odd segments are not drawn.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_LINE_DOUBLE_DASH</entry>
|
||||
<entry>even segments are normally. Odd segments are drawn
|
||||
in the background color if the fill style is %GDK_SOLID,
|
||||
or in the background color masked by the stipple if the
|
||||
fill style is %GDK_STIPPLED.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@GDK_LINE_SOLID:
|
||||
@GDK_LINE_ON_OFF_DASH:
|
||||
@GDK_LINE_DOUBLE_DASH:
|
||||
|
||||
<!-- ##### ENUM GdkCapStyle ##### -->
|
||||
<para>
|
||||
Determines how the end of lines are drawn.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>GDK_CAP_NOT_LAST</entry>
|
||||
<entry>the same as %GDK_CAP_BUTT for lines of non-zero width.
|
||||
for zero width lines, the final point on the line
|
||||
will not be drawn.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_CAP_BUTT</entry>
|
||||
<entry>the ends of the lines are drawn squared off and extending
|
||||
to the coordinates of the end point.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_CAP_ROUND</entry>
|
||||
<entry>the ends of the lines are drawn as semicircles with the
|
||||
diameter equal to the line width and centered at the
|
||||
end point.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_CAP_PROJECTING</entry>
|
||||
<entry>the ends of the lines are drawn squared off and extending
|
||||
half the width of the line beyond the end point.</entry>
|
||||
</row>
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@GDK_CAP_NOT_LAST:
|
||||
@GDK_CAP_BUTT:
|
||||
@GDK_CAP_ROUND:
|
||||
@GDK_CAP_PROJECTING:
|
||||
|
||||
<!-- ##### ENUM GdkJoinStyle ##### -->
|
||||
<para>
|
||||
Determines how the joins between segments of a polygon are drawn.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>GDK_JOIN_MITER</entry>
|
||||
<entry>the sides of each line are extended to meet at an angle.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_JOIN_ROUND</entry>
|
||||
<entry>the sides of the two lines are joined by a circular arc.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_JOIN_BEVEL</entry>
|
||||
<entry>the sides of the two lines are joined by a straight line which
|
||||
makes an equal angle with each line.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@GDK_JOIN_MITER:
|
||||
@GDK_JOIN_ROUND:
|
||||
@GDK_JOIN_BEVEL:
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_set_dashes ##### -->
|
||||
<para>
|
||||
Sets the way dashed-lines are drawn. Lines will be
|
||||
drawn with alternating on and off segments of the
|
||||
lengths specified in @dash_list. The manner in
|
||||
which the on and off segments are drawn is determined
|
||||
by the @line_style value of the GC. (This can
|
||||
be changed with gdk_gc_set_line_attributes)
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
@dash_offset: the
|
||||
@dash_list: an array of dash lengths.
|
||||
@n: the number of elements in @dash_list.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_gc_copy ##### -->
|
||||
<para>
|
||||
Copy the set of values from one graphics context
|
||||
onto another graphics context.
|
||||
</para>
|
||||
|
||||
@dst_gc: the destination graphics context.
|
||||
@src_gc: the source graphics context.
|
||||
|
||||
|
||||
@@ -1,347 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
General
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
library initialization and miscellaneous functions.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
This section describes the GDK initialization functions and miscellaneous
|
||||
utility functions.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gdk_init ##### -->
|
||||
<para>
|
||||
Initializes the GDK library and connects to the X server.
|
||||
If initialization fails, a warning message is output and the application
|
||||
terminates with a call to exit(1).
|
||||
</para>
|
||||
<para>
|
||||
Any arguments used by GDK are removed from the array and @argc and @argv are
|
||||
updated accordingly.
|
||||
</para>
|
||||
<para>
|
||||
GTK+ initializes GDK in gtk_init() and so this function is not usually needed
|
||||
by GTK+ applications.
|
||||
</para>
|
||||
|
||||
@argc: the number of command line arguments.
|
||||
@argv: the array of command line arguments.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_init_check ##### -->
|
||||
<para>
|
||||
Initializes the GDK library and connects to the X server, returning TRUE on
|
||||
success.
|
||||
</para>
|
||||
<para>
|
||||
Any arguments used by GDK are removed from the array and @argc and @argv are
|
||||
updated accordingly.
|
||||
</para>
|
||||
<para>
|
||||
GTK+ initializes GDK in gtk_init() and so this function is not usually needed
|
||||
by GTK+ applications.
|
||||
</para>
|
||||
|
||||
@argc: the number of command line arguments.
|
||||
@argv: the array of command line arguments.
|
||||
@Returns: TRUE if initialization succeeded.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_exit ##### -->
|
||||
<para>
|
||||
Exits the application using the exit() system call.
|
||||
</para>
|
||||
<para>
|
||||
This routine is provided mainly for backwards compatability, since it used to
|
||||
perform tasks necessary to exit the application cleanly. Those tasks are now
|
||||
performed in a function which is automatically called on exit (via the use
|
||||
of g_atexit()).
|
||||
</para>
|
||||
|
||||
@error_code: the error code to pass to the exit() call.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_set_locale ##### -->
|
||||
<para>
|
||||
Initializes the support for internationalization by calling the setlocale()
|
||||
system call. This function is called by gtk_set_locale() and so GTK+
|
||||
applications should use that instead.
|
||||
</para>
|
||||
<para>
|
||||
The locale to use is determined by the LANG environment variable,
|
||||
so to run an application in a certain locale you can do something like this:
|
||||
<informalexample>
|
||||
<programlisting>
|
||||
export LANG="fr"
|
||||
... run application ...
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</para>
|
||||
<para>
|
||||
If the locale is not supported by X then it is reset to the standard "C"
|
||||
locale.
|
||||
</para>
|
||||
|
||||
@Returns: the resulting locale.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_set_sm_client_id ##### -->
|
||||
<para>
|
||||
Sets the SM_CLIENT_ID property on the application's leader window so that
|
||||
the window manager can save the application's state using the X11R6 ICCCM
|
||||
session management protocol.
|
||||
</para>
|
||||
<para>
|
||||
The leader window is automatically created by GDK and never shown. It's only
|
||||
use is for session management. The WM_CLIENT_LEADER property is automatically
|
||||
set on all X windows created by the application to point to the leader window.
|
||||
</para>
|
||||
<para>
|
||||
See the X Session Management Library documentation for more information on
|
||||
session management and the Inter-Client Communication Conventions Manual
|
||||
(ICCCM) for information on the WM_CLIENT_LEADER property. (Both documents are
|
||||
part of the X Windows distribution.)
|
||||
</para>
|
||||
|
||||
@sm_client_id: the client id assigned by the session manager when the
|
||||
connection was opened, or NULL to remove the property.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_get_display ##### -->
|
||||
<para>
|
||||
Gets the name of the display, which usually comes from the DISPLAY
|
||||
environment variable or the --display command line option.
|
||||
</para>
|
||||
|
||||
@Returns: the name of the display.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_flush ##### -->
|
||||
<para>
|
||||
Flushes the X output buffer and waits until all requests have been processed
|
||||
by the server. This is rarely needed by applications. It's main use is for
|
||||
trapping X errors with gdk_error_trap_push() and gdk_error_trap_pop().
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_screen_width ##### -->
|
||||
<para>
|
||||
Returns the width of the screen in pixels.
|
||||
</para>
|
||||
|
||||
@Returns: the width of the screen in pixels.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_screen_height ##### -->
|
||||
<para>
|
||||
Returns the height of the screen in pixels.
|
||||
</para>
|
||||
|
||||
@Returns: the height of the screen in pixels.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_screen_width_mm ##### -->
|
||||
<para>
|
||||
Returns the width of the screen in millimeters.
|
||||
Note that on many X servers this value will not be correct.
|
||||
</para>
|
||||
|
||||
@Returns: the width of the screen in millimeters, though it is not always
|
||||
correct.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_screen_height_mm ##### -->
|
||||
<para>
|
||||
Returns the height of the screen in millimeters.
|
||||
Note that on many X servers this value will not be correct.
|
||||
</para>
|
||||
|
||||
@Returns: the height of the screen in millimeters, though it is not always
|
||||
correct.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_pointer_grab ##### -->
|
||||
<para>
|
||||
Grabs the pointer (usually a mouse) so that all events are passed to this
|
||||
application until the pointer is ungrabbed with gdk_pointer_ungrab(), or
|
||||
the grab window becomes unviewable.
|
||||
This overrides any previous pointer grab by this client.
|
||||
</para>
|
||||
<para>
|
||||
Pointer grabs are used for operations which need complete control over mouse
|
||||
events, even if the mouse leaves the application.
|
||||
For example in GTK+ it is used for Drag and Drop, for dragging the handle in
|
||||
the #GtkHPaned and #GtkVPaned widgets, and for resizing columns in #GtkCList
|
||||
widgets.
|
||||
</para>
|
||||
<para>
|
||||
Note that if the event mask of an X window has selected both button press and
|
||||
button release events, then a button press event will cause an automatic
|
||||
pointer grab until the button is released.
|
||||
X does this automatically since most applications expect to receive button
|
||||
press and release events in pairs.
|
||||
It is equivalent to a pointer grab on the window with @owner_events set to
|
||||
TRUE.
|
||||
</para>
|
||||
|
||||
@window: the #GdkWindow which will own the grab (the grab window).
|
||||
@owner_events: if FALSE then all pointer events are reported with respect to
|
||||
@window and are only reported if selected by @event_mask. If TRUE then pointer
|
||||
events for this application are reported as normal, but pointer events outside
|
||||
this application are reported with respect to @window and only if selected by
|
||||
@event_mask. In either mode, unreported events are discarded.
|
||||
@event_mask: specifies the event mask, which is used in accordance with
|
||||
@owner_events.
|
||||
@confine_to: If non-%NULL, the pointer will be confined to this
|
||||
window during the grab. If the pointer is outside @confine_to, it will
|
||||
automatically be moved to the closest edge of @confine_to and enter
|
||||
and leave events will be generated as necessary.
|
||||
@cursor: the cursor to display while the grab is active. If this is NULL then
|
||||
the normal cursors are used for @window and its descendants, and the cursor
|
||||
for @window is used for all other windows.
|
||||
@time: the timestamp of the event which led to this pointer grab. This usually
|
||||
comes from a #GdkEventButton struct, though #GDK_CURRENT_TIME can be used if
|
||||
the time isn't known.
|
||||
@Returns: 0 if the grab was successful.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_pointer_ungrab ##### -->
|
||||
<para>
|
||||
Ungrabs the pointer, if it is grabbed by this application.
|
||||
</para>
|
||||
|
||||
@time: a timestamp from a #GdkEvent, or #GDK_CURRENT_TIME if no timestamp is
|
||||
available.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_pointer_is_grabbed ##### -->
|
||||
<para>
|
||||
Returns TRUE if the pointer is currently grabbed by this application.
|
||||
</para>
|
||||
<para>
|
||||
Note that the return value is not completely reliable since the X server may
|
||||
automatically ungrab the pointer, without informing the application, if the
|
||||
grab window becomes unviewable. It also does not take passive pointer grabs
|
||||
into account.
|
||||
</para>
|
||||
|
||||
@Returns: TRUE if the pointer is currently grabbed by this application.
|
||||
Though this value is not always correct.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_keyboard_grab ##### -->
|
||||
<para>
|
||||
Grabs the keyboard so that all events are passed to this
|
||||
application until the keyboard is ungrabbed with gdk_keyboard_ungrab().
|
||||
This overrides any previous keyboard grab by this client.
|
||||
</para>
|
||||
|
||||
@window: the #GdkWindow which will own the grab (the grab window).
|
||||
@owner_events: if FALSE then all keyboard events are reported with respect to
|
||||
@window. If TRUE then keyboard events for this application are reported as
|
||||
normal, but keyboard events outside this application are reported with respect
|
||||
to @window. Both key press and key release events are always reported,
|
||||
independant of the event mask set by the application.
|
||||
@time: a timestamp from a #GdkEvent, or #GDK_CURRENT_TIME if no timestamp is
|
||||
available.
|
||||
@Returns: 0 if the grab was successful.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_keyboard_ungrab ##### -->
|
||||
<para>
|
||||
Ungrabs the keyboard, if it is grabbed by this application.
|
||||
</para>
|
||||
|
||||
@time: a timestamp from a #GdkEvent, or #GDK_CURRENT_TIME if no timestamp is
|
||||
available.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_key_repeat_disable ##### -->
|
||||
<para>
|
||||
Disables the keyboard auto-repeat mode.
|
||||
This should be used with care as it may affect other applications.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_key_repeat_restore ##### -->
|
||||
<para>
|
||||
Restores the keyboard auto-repeat mode to its state when the application was
|
||||
started.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_beep ##### -->
|
||||
<para>
|
||||
Emits a short beep.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_get_use_xshm ##### -->
|
||||
<para>
|
||||
Returns TRUE if GDK will attempt to use the MIT-SHM shared memory extension.
|
||||
</para>
|
||||
<para>
|
||||
The shared memory extension is used for #GdkImage, and consequently for
|
||||
<link linkend="gdk-GdkRGB">GdkRGB</link>.
|
||||
It enables much faster drawing by communicating with the X server through
|
||||
SYSV shared memory calls. However, it can only be used if the X client and
|
||||
server are on the same machine and the server supports it.
|
||||
</para>
|
||||
|
||||
@Returns: TRUE if use of the MIT shared memory extension will be attempted.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_set_use_xshm ##### -->
|
||||
<para>
|
||||
Sets whether the use of the MIT shared memory extension should be attempted.
|
||||
This function is mainly for internal use. It is only safe for an application
|
||||
to set this to FALSE, since if it is set to TRUE and the server does not
|
||||
support the extension it may cause warning messages to be output.
|
||||
</para>
|
||||
|
||||
@use_xshm: TRUE if use of the MIT shared memory extension should be attempted.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_error_trap_push ##### -->
|
||||
<para>
|
||||
This function allows X errors to be trapped instead of the normal behavior
|
||||
of exiting the application. It should only be used if it is not possible to
|
||||
avoid the X error in any other way.
|
||||
</para>
|
||||
<example>
|
||||
<title>Trapping an X error.</title>
|
||||
<programlisting>
|
||||
gdk_error_trap_push ();
|
||||
|
||||
/* ... Call the X function which may cause an error here ... */
|
||||
|
||||
/* Flush the X queue to catch errors now. */
|
||||
gdk_flush ();
|
||||
|
||||
if (gdk_error_trap_pop ())
|
||||
{
|
||||
/* ... Handle the error here ... */
|
||||
}
|
||||
</programlisting>
|
||||
</example>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_error_trap_pop ##### -->
|
||||
<para>
|
||||
Removes the X error trap installed with gdk_error_trap_push().
|
||||
</para>
|
||||
|
||||
@Returns: the X error code, or 0 if no error occurred.
|
||||
|
||||
|
||||
@@ -1,156 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Images
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
an area for bit-mapped graphics stored on the X Windows client.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GdkImage type represents an area for drawing graphics.
|
||||
It has now been superceded to a large extent by the much more flexible
|
||||
<link linkend="gdk-GdkRGB">GdkRGB</link> functions.
|
||||
</para>
|
||||
<para>
|
||||
To create an empty #GdkImage use gdk_image_new().
|
||||
To create a #GdkImage from bitmap data use gdk_image_new_bitmap().
|
||||
To create an image from part of a #GdkWindow use gdk_image_get().
|
||||
</para>
|
||||
<para>
|
||||
The image can be manipulated with gdk_image_get_pixel() and
|
||||
gdk_image_put_pixel(), or alternatively by changing the actual pixel data.
|
||||
Though manipulating the pixel data requires complicated code to cope with
|
||||
the different formats that may be used.
|
||||
</para>
|
||||
<para>
|
||||
To draw a #GdkImage in a #GdkWindow or #GdkPixmap use gdk_draw_image().
|
||||
</para>
|
||||
<para>
|
||||
To destroy a #GdkImage use gdk_image_destroy().
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term><link linkend="gdk-Bitmaps-and-Pixmaps">Bitmaps and Pixmaps</link></term>
|
||||
<listitem><para>
|
||||
Graphics which are stored on the X Windows server.
|
||||
Since these are stored on the server they can be drawn very quickly, and all
|
||||
of the <link linkend="gdk-Drawing-Primitives">Drawing Primitives</link> can be
|
||||
used to draw on them. Their main disadvantage is that manipulating individual
|
||||
pixels can be very slow.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><link linkend="gdk-GdkRGB">GdkRGB</link></term>
|
||||
<listitem><para>
|
||||
Built on top of #GdkImage, this provides much more functionality,
|
||||
including the dithering of colors to produce better output on low-color
|
||||
displays.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GdkImage ##### -->
|
||||
<para>
|
||||
The #GdkImage struct contains information on the image and the pixel data.
|
||||
</para>
|
||||
|
||||
@type: the type of the image.
|
||||
@visual: the visual.
|
||||
@byte_order: the byte order.
|
||||
@width: the width of the image in pixels.
|
||||
@height: the height of the image in pixels.
|
||||
@depth: the depth of the image, i.e. the number of bits per pixel.
|
||||
@bpp: the number of bytes per pixel.
|
||||
@bpl: the number of bytes per line of the image.
|
||||
@mem: the pixel data.
|
||||
|
||||
<!-- ##### FUNCTION gdk_image_new ##### -->
|
||||
<para>
|
||||
Creates a new #GdkImage.
|
||||
</para>
|
||||
|
||||
@type: the type of the #GdkImage, one of %GDK_IMAGE_NORMAL, %GDK_IMAGE_SHARED
|
||||
and %GDK_IMAGE_FASTEST. %GDK_IMAGE_FASTEST is probably the best choice, since
|
||||
it will try creating a %GDK_IMAGE_SHARED image first and if that fails it will
|
||||
then use %GDK_IMAGE_NORMAL.
|
||||
@visual: the #GdkVisual to use for the image.
|
||||
@width: the width of the image in pixels.
|
||||
@height: the height of the image in pixels.
|
||||
@Returns: a new #GdkImage, or NULL if the image could not be created.
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkImageType ##### -->
|
||||
<para>
|
||||
Specifies the type of a #GdkImage.
|
||||
</para>
|
||||
|
||||
@GDK_IMAGE_NORMAL: The original X image type, which is quite slow since the
|
||||
image has to be transferred from the client to the server to display it.
|
||||
@GDK_IMAGE_SHARED: A faster image type, which uses shared memory to transfer
|
||||
the image data between client and server. However this will only be available
|
||||
if client and server are on the same machine and the shared memory extension
|
||||
is supported by the server.
|
||||
@GDK_IMAGE_FASTEST: Specifies that %GDK_IMAGE_SHARED should be tried first,
|
||||
and if that fails then %GDK_IMAGE_NORMAL will be used.
|
||||
|
||||
<!-- ##### FUNCTION gdk_image_new_bitmap ##### -->
|
||||
<para>
|
||||
Creates a new #GdkImage with a depth of 1 from the given data.
|
||||
</para>
|
||||
|
||||
@visual: the #GdkVisual to use for the image.
|
||||
@data: the pixel data.
|
||||
@width: the width of the image in pixels.
|
||||
@height: the height of the image in pixels.
|
||||
@Returns: a new #GdkImage.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_image_get ##### -->
|
||||
<para>
|
||||
Gets part of a #GdkWindow and stores it in a new #GdkImage.
|
||||
</para>
|
||||
|
||||
@window: the #GdkWindow to copy from.
|
||||
@x: the left edge of the rectangle to copy from @window.
|
||||
@y: the top edge of the rectangle to copy from @window.
|
||||
@width: the width of the area to copy, in pixels.
|
||||
@height: the height of the area to copy, in pixels.
|
||||
@Returns: a new #GdkImage with a copy of the given area of @window.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_image_destroy ##### -->
|
||||
<para>
|
||||
Destroys a #GdkImage, freeing any resources allocated for it.
|
||||
</para>
|
||||
|
||||
@image: a #GdkImage.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_image_put_pixel ##### -->
|
||||
<para>
|
||||
Sets a pixel in a #GdkImage to a given pixel value.
|
||||
</para>
|
||||
|
||||
@image: a #GdkImage.
|
||||
@x: the x coordinate of the pixel to set.
|
||||
@y: the y coordinate of the pixel to set.
|
||||
@pixel: the pixel value to set.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_image_get_pixel ##### -->
|
||||
<para>
|
||||
Gets a pixel value at a specified position in a #GdkImage.
|
||||
</para>
|
||||
|
||||
@image: a #GdkImage.
|
||||
@x: the x coordinate of the pixel to get.
|
||||
@y: the y coordinate of the pixel to get.
|
||||
@Returns: the pixel value at the given position.
|
||||
|
||||
|
||||
@@ -1,130 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Input
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Callbacks on file descriptors.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The functions in this section are used to establish
|
||||
callbacks when some condition becomes true for
|
||||
a file descriptor. They are currently just wrappers around
|
||||
the <link linkend="glib-IO-Channels">IO Channel</link>
|
||||
facility.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term><link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link></term>
|
||||
<listitem><para>The main loop in which input callbacks run.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><link linkend="glib-IO-Channels">IO Channels</link></term>
|
||||
<listitem><para>A newer and more flexible way of doing IO
|
||||
callbacks.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gdk_input_add_full ##### -->
|
||||
<para>
|
||||
Establish a callback when a condition becomes true on
|
||||
a file descriptor.
|
||||
</para>
|
||||
|
||||
@source: a file descriptor.
|
||||
@condition: the condition.
|
||||
@function: the callback function.
|
||||
@data: callback data passed to @function.
|
||||
@destroy: callback function to call with @data when the input
|
||||
handler is removed.
|
||||
@Returns: a tag that can later be used as an argument to
|
||||
gdk_input_remove().
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkInputCondition ##### -->
|
||||
<para>
|
||||
A set of bit flags used to specify conditions for which
|
||||
an input callback will be triggered. The three members
|
||||
of this enumeration correspond to the @readfds,
|
||||
@writefds, and @exceptfds arguments to the
|
||||
<function>select</function> system call.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="enum">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>GDK_INPUT_READ</entry>
|
||||
<entry>the file descriptor has become available for reading.
|
||||
(Or, as is standard in Unix, a socket or pipe was closed
|
||||
at the other end; this is the case if a subsequent read
|
||||
on the file descriptor returns a count of zero.)</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_INPUT_WRITE</entry>
|
||||
<entry>the file descriptor has become available for writing.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_INPUT_EXCEPTION</entry>
|
||||
<entry>an exception was raised on the file descriptor.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@GDK_INPUT_READ:
|
||||
@GDK_INPUT_WRITE:
|
||||
@GDK_INPUT_EXCEPTION:
|
||||
|
||||
<!-- ##### USER_FUNCTION GdkInputFunction ##### -->
|
||||
<para>
|
||||
A callback function that will be called when some condition
|
||||
occurs.
|
||||
</para>
|
||||
|
||||
@data: the user data passed to gdk_input_add() or gdk_input_add_full().
|
||||
@source: the source where the condition occurred.
|
||||
@condition: the triggering condition.
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GdkDestroyNotify ##### -->
|
||||
<para>
|
||||
A callback function called when a piece of user data is
|
||||
no longer being stored by GDK. Will typically free the
|
||||
structure or object that @data points to.
|
||||
</para>
|
||||
|
||||
@data: the user data.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_input_add ##### -->
|
||||
<para>
|
||||
Establish a callback when a condition becomes true on
|
||||
a file descriptor.
|
||||
</para>
|
||||
|
||||
@source: a file descriptor.
|
||||
@condition: the condition.
|
||||
@function: the callback function.
|
||||
@data: callback data passed to @function.
|
||||
@Returns: a tag that can later be used as an argument to
|
||||
gdk_input_remove().
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_input_remove ##### -->
|
||||
<para>
|
||||
Remove a callback added with gdk_input_add() or
|
||||
gdk_input_add_full().
|
||||
</para>
|
||||
|
||||
@tag: the tag returned when the callback was set up.
|
||||
|
||||
|
||||
@@ -1,243 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Input Contexts
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
internationalized text input properties.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
A #GdkIC input context is used for each user interface element which supports
|
||||
internationalized text input. See the
|
||||
<link linkend="gdk-Input-Methods">Input Methods</link> section for an overview
|
||||
of how internationalized text input works in GTK+.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GdkIC ##### -->
|
||||
<para>
|
||||
The #GdkIC struct is an opaque structure representing an input context
|
||||
for use with the global <link linkend="gdk-Input-Methods">Input Method</link>.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_ic_new ##### -->
|
||||
<para>
|
||||
Creates a new #GdkIC using the given attributes.
|
||||
</para>
|
||||
|
||||
@attr: a #GdkICAttr struct containing attributes to use for the input context.
|
||||
@mask: a #GdkICAttributesType mask specifying which of the attributes in @attr
|
||||
are set.
|
||||
@Returns: a new #GdkIC.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_ic_destroy ##### -->
|
||||
<para>
|
||||
Destroys the input context.
|
||||
</para>
|
||||
|
||||
@ic: a #GdkIC.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_ic_get_events ##### -->
|
||||
<para>
|
||||
Returns the mask of events that the input method needs to function properly.
|
||||
This is typically called in a widget's realize method after creating the
|
||||
#GdkIC. The returned event mask is then combined with the widget's
|
||||
own event mask and applied using gdk_window_set_events().
|
||||
</para>
|
||||
|
||||
@ic: a #GdkIC.
|
||||
@Returns: the mask of events that the input method needs to function
|
||||
properly.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_ic_get_style ##### -->
|
||||
<para>
|
||||
Returns the pre-edit and status style of the #GdkIC.
|
||||
</para>
|
||||
|
||||
@ic: a #GdkIC.
|
||||
@Returns: the pre-edit and status style of the #GdkIC.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_ic_get_attr ##### -->
|
||||
<para>
|
||||
Gets attributes of a #GdkIC.
|
||||
</para>
|
||||
|
||||
@ic: a #GdkIC.
|
||||
@attr: a #GdkICAttr struct to contain the returned attributes.
|
||||
@mask: a #GdkICAttributesType mask specifying which attributes to get.
|
||||
@Returns: a #GdkICAttributesType mask specifying which of the attributes
|
||||
were not retrieved succesfully.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_ic_set_attr ##### -->
|
||||
<para>
|
||||
Sets attributes of the #GdkIC.
|
||||
</para>
|
||||
<para>
|
||||
Note that the GDK_IC_STYLE and GDK_IC_CLIENT_WINDOW attributes can only be set
|
||||
when creating the #GdkIC, and the GDK_IC_FILTER_EVENTS attribute is read-only.
|
||||
</para>
|
||||
|
||||
@ic: a #GdkIC.
|
||||
@attr: a #GdkICAttr struct containing attributes to use for the input context.
|
||||
@mask: a #GdkICAttributesType mask specifying which of the attributes in @attr
|
||||
are set.
|
||||
@Returns: a #GdkICAttributesType mask indicating which of the attributes
|
||||
were not set successfully.
|
||||
|
||||
|
||||
<!-- ##### STRUCT GdkICAttr ##### -->
|
||||
<para>
|
||||
The #GdkICAttr struct is used when getting and setting attributes of the
|
||||
input context. It is used together with a #GdkICAttributesType mask which
|
||||
specifies which of the fields are being set or returned.
|
||||
</para>
|
||||
|
||||
@style: the pre-edit and status style. This attribute is required when
|
||||
creating the #GdkIC, and cannot be changed.
|
||||
@client_window: the #GdkWindow in which the input method will display its
|
||||
pre-edit and status areas or create subwindows.
|
||||
The preedit_area and status_area attributes are specified relative to this
|
||||
window. This attribute is required when creating the #GdkIC, and cannot be
|
||||
changed.
|
||||
@focus_window: the #GdkWindow which is to be used when editing text.
|
||||
gdk_im_begin() sets this attribute before starting the text input process,
|
||||
so it is normally not necessary to set it elsewhere.
|
||||
@filter_events: the mask of events that the input method requires.
|
||||
See the gdk_ic_get_events() function. This attribute is read-only and is
|
||||
never changed.
|
||||
@spot_location: the position of the insertion cursor, for use with the
|
||||
%GDK_IM_PREEDIT_POSITION style. The y coordinate specifies the baseline of
|
||||
the text.
|
||||
@line_spacing: the line spacing to be used in the pre-edit and status areas
|
||||
when displaying multi-line text.
|
||||
@cursor: the cursor to use in the input method's windows.
|
||||
If this attribute isn't set it is determined by the input method.
|
||||
@preedit_fontset: the font to use for the pre-edit area.
|
||||
If this attribute isn't set it is determined by the input method.
|
||||
@preedit_area: the area in which the input method will display pre-editing
|
||||
data, used for the %GDK_IM_PREEDIT_POSITION and %GDK_IM_PREEDIT_AREA styles.
|
||||
@preedit_area_needed: the area that the input method requests for displaying
|
||||
pre-editing data, used for the %GDK_IM_PREEDIT_POSITION and
|
||||
%GDK_IM_PREEDIT_AREA styles.
|
||||
@preedit_foreground: the foreground color to use for the pre-edit area.
|
||||
This color must already be allocated in the preedit_colormap.
|
||||
If this attribute isn't set it is determined by the input method.
|
||||
@preedit_background: the background color to use for the pre-edit area.
|
||||
This color must already be allocated in the preedit_colormap.
|
||||
If this attribute isn't set it is determined by the input method.
|
||||
@preedit_pixmap: the background pixmap to use for the pre-edit area.
|
||||
If this attribute isn't set it is determined by the input method.
|
||||
@preedit_colormap: the colormap the input method should use to allocate colors.
|
||||
The default value is the colormap of client_window.
|
||||
@status_fontset: the font to use for the status area.
|
||||
If this attribute isn't set it is determined by the input method.
|
||||
@status_area: the are that the input method will display status information in.
|
||||
This is used for the %GDK_IM_STATUS_AREA style.
|
||||
@status_area_needed: the size that the input method requests for displaying
|
||||
status information, for the %GDK_IM_STATUS_AREA style.
|
||||
@status_foreground: the foreground color to use for the status area.
|
||||
This color must already be allocated in the status_colormap.
|
||||
If this attribute isn't set it is determined by the input method.
|
||||
@status_background: the background color to use for the status area.
|
||||
This color must already be allocated in the status_colormap.
|
||||
If this attribute isn't set it is determined by the input method.
|
||||
@status_pixmap: the background pixmap to use for the status area.
|
||||
If this attribute isn't set it is determined by the input method.
|
||||
@status_colormap: the colormap the input method should use to allocate colors.
|
||||
The default value is the colormap of client_window.
|
||||
|
||||
<!-- ##### ENUM GdkICAttributesType ##### -->
|
||||
<para>
|
||||
The #GdkICAttributesType contains a set of bit-flags which are used to
|
||||
specify which of the attributes in a #GdkICAttr are being set or returned.
|
||||
</para>
|
||||
<para>
|
||||
It also contains several combinations of the flags which specify required
|
||||
attributes for the various styles:
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>%GDK_IC_ALL_REQ:</term>
|
||||
<listitem><para>
|
||||
the set of attributes required for all styles.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>%GDK_IC_PREEDIT_AREA_REQ:</term>
|
||||
<listitem><para>
|
||||
the set of additional attributes required for the
|
||||
%GDK_IM_PREEDIT_AREA pre-edit style.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>%GDK_IC_PREEDIT_POSITION_REQ:</term>
|
||||
<listitem><para>
|
||||
the set of additional attributes required for the
|
||||
%GDK_IM_PREEDIT_POSITION pre-edit style.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>%GDK_IC_STATUS_AREA_REQ:</term>
|
||||
<listitem><para>
|
||||
the set of additional attributes required for the
|
||||
%GDK_IM_STATUS_AREA status style.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
@GDK_IC_STYLE:
|
||||
@GDK_IC_CLIENT_WINDOW:
|
||||
@GDK_IC_FOCUS_WINDOW:
|
||||
@GDK_IC_FILTER_EVENTS:
|
||||
@GDK_IC_SPOT_LOCATION:
|
||||
@GDK_IC_LINE_SPACING:
|
||||
@GDK_IC_CURSOR:
|
||||
@GDK_IC_PREEDIT_FONTSET:
|
||||
@GDK_IC_PREEDIT_AREA:
|
||||
@GDK_IC_PREEDIT_AREA_NEEDED:
|
||||
@GDK_IC_PREEDIT_FOREGROUND:
|
||||
@GDK_IC_PREEDIT_BACKGROUND:
|
||||
@GDK_IC_PREEDIT_PIXMAP:
|
||||
@GDK_IC_PREEDIT_COLORMAP:
|
||||
@GDK_IC_STATUS_FONTSET:
|
||||
@GDK_IC_STATUS_AREA:
|
||||
@GDK_IC_STATUS_AREA_NEEDED:
|
||||
@GDK_IC_STATUS_FOREGROUND:
|
||||
@GDK_IC_STATUS_BACKGROUND:
|
||||
@GDK_IC_STATUS_PIXMAP:
|
||||
@GDK_IC_STATUS_COLORMAP:
|
||||
@GDK_IC_ALL_REQ:
|
||||
@GDK_IC_PREEDIT_AREA_REQ:
|
||||
@GDK_IC_PREEDIT_POSITION_REQ:
|
||||
@GDK_IC_STATUS_AREA_REQ:
|
||||
|
||||
<!-- ##### FUNCTION gdk_ic_attr_new ##### -->
|
||||
<para>
|
||||
Creates a new #GdkICAttr struct, with all fields set to 0.
|
||||
The #GdkICAttr struct should be freed with gdk_ic_attr_destroy() when no
|
||||
longer needed.
|
||||
</para>
|
||||
|
||||
@Returns: a new #GdkICAttr struct.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_ic_attr_destroy ##### -->
|
||||
<para>
|
||||
Destroys the given #GdkICAttr struct, freeing the allocated memory.
|
||||
</para>
|
||||
|
||||
@attr: a #GdkICAttr struct.
|
||||
|
||||
|
||||
@@ -1,301 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Input Devices
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Functions for handling extended input devices.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
In addition to the normal keyboard and mouse input devices, GTK+ also
|
||||
contains support for <firstterm>extended input devices</firstterm>. In
|
||||
particular, this support is targeted at graphics tablets. Graphics
|
||||
tablets typically return sub-pixel positioning information and possibly
|
||||
information about the pressure and tilt of the stylus. Under
|
||||
X, the support for extended devices is done through the
|
||||
<firstterm>XInput</firstterm> extension.
|
||||
</para>
|
||||
<para>
|
||||
Because handling extended input devices may involve considerable
|
||||
overhead, they need to be turned on for each #GdkWindow
|
||||
individually using gdk_input_set_extension_events().
|
||||
(Or, more typically, for GtkWidgets, using gtk_widget_set_extension_events()).
|
||||
As an additional complication, depending on the support from
|
||||
the windowing system, its possible that a normal mouse
|
||||
cursor will not be displayed for a particular extension
|
||||
device. If an application does not want to deal with displaying
|
||||
a cursor itself, it can ask only to get extension events
|
||||
from devices that will display a cursor, by passing the
|
||||
%GDK_EXTENSION_EVENTS_CURSOR value to
|
||||
gdk_input_set_extension_events(). Otherwise, the application
|
||||
must retrieve the device information using gdk_input_list_devices(),
|
||||
check the <structfield>has_cursor</structfield> field, and,
|
||||
if it is %FALSE, draw a cursor itself when it receives
|
||||
motion events.
|
||||
</para>
|
||||
<para>
|
||||
Each pointing device is assigned a unique integer ID; events from a
|
||||
particular device can be identified by the
|
||||
<structfield>deviceid</structfield> field in the event structure. The
|
||||
events generated by pointer devices have also been extended to contain
|
||||
<structfield>pressure</structfield>, <structfield>xtilt</structfield>
|
||||
and <structfield>ytilt</structfield> fields which contain the extended
|
||||
information reported as additional <firstterm>valuators</firstterm>
|
||||
from the device. The <structfield>pressure</structfield> field is a
|
||||
a double value ranging from 0.0 to 1.0, while the tilt fields are
|
||||
double values ranging from -1.0 to 1.0. (With -1.0 representing the
|
||||
maximum title to the left or up, and 1.0 representing the maximum
|
||||
tilt to the right or down.)
|
||||
</para>
|
||||
<para>
|
||||
One additional field in each event is the
|
||||
<structfield>source</structfield> field, which contains an
|
||||
enumeration value describing the type of device; this currently
|
||||
can be one of
|
||||
%GDK_SOURCE_MOUSE,
|
||||
%GDK_SOURCE_PEN,
|
||||
%GDK_SOURCE_ERASER,
|
||||
or %GDK_SOURCE_CURSOR. This field is present to allow simple
|
||||
applications to (for instance) delete when they detect eraser
|
||||
devices without having to keep track of complicated per-device
|
||||
settings.
|
||||
</para>
|
||||
<para>
|
||||
Various aspects of each device may be configured. The easiest way of
|
||||
creating a GUI to allow the user to conifigure such a device
|
||||
is to use to use the #GtkInputDialog widget in GTK+.
|
||||
However, even when using this widget, application writers
|
||||
will need to directly query and set the configuration parameters
|
||||
in order to save the state between invocations of the application.
|
||||
The configuration of devices is queried using gdk_input_list_devices.
|
||||
Each device must is activated using gdk_input_set_mode(), which
|
||||
also controls whether the device's range is mapped to the
|
||||
entire screen or to a single window. The mapping of the valuators of
|
||||
the device onto the predefined valuator types is set using
|
||||
gdk_input_set_axes. And the source type for each device
|
||||
can be set with gdk_input_set_source().
|
||||
</para>
|
||||
<para>
|
||||
Devices may also have associated <firstterm>keys</firstterm>
|
||||
or macro buttons. Such keys can be globally set to map
|
||||
into normal X keyboard events. The mapping is set using
|
||||
gdk_input_set_key().
|
||||
</para>
|
||||
<para>
|
||||
The interfaces in this section will most likely be considerably
|
||||
modified in the future to accomodate devices that may have different
|
||||
sets of additional valuators than the pressure xtilt and ytilt.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### MACRO GDK_CORE_POINTER ##### -->
|
||||
<para>
|
||||
This macro contains an integer value representing
|
||||
the device ID for the core pointer device.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_input_list_devices ##### -->
|
||||
<para>
|
||||
Lists all available input devices, along with their
|
||||
configuration information.
|
||||
</para>
|
||||
|
||||
@Returns: A #GList of #GdkDeviceInfo structures. This list
|
||||
is internal data of GTK+ and should not be modified
|
||||
or freed.
|
||||
|
||||
|
||||
<!-- ##### STRUCT GdkDeviceInfo ##### -->
|
||||
<para>
|
||||
The #GdkDeviceInfo structure contains information about a
|
||||
device. It has the following fields:
|
||||
</para>
|
||||
|
||||
@deviceid: a unique integer ID for this device.
|
||||
@name: the human-readable name for the device.
|
||||
@source: the type of device.
|
||||
@mode: a value indicating whether the device is enabled and
|
||||
how the device coordinates map to the screen.
|
||||
@has_cursor: if %TRUE, a cursor will be displayed indicating
|
||||
the current on-screen location to the user. Otherwise,
|
||||
the application is responsible for drawing a cursor
|
||||
itself.
|
||||
@num_axes: the number of axes for this device.
|
||||
@axes: a pointer to an array of GdkAxisUse values which
|
||||
give the mapping of axes onto the possible valuators
|
||||
for a GDK device.
|
||||
@num_keys: the number of macro buttons.
|
||||
@keys: a pointer to an array of #GdkDeviceKey structures
|
||||
which describe what key press events are generated
|
||||
for each macro button.
|
||||
|
||||
<!-- ##### STRUCT GdkDeviceKey ##### -->
|
||||
<para>
|
||||
The #GdkDeviceKey structure contains information
|
||||
about the mapping of one device macro button onto
|
||||
a normal X key event. It has the following fields:
|
||||
</para>
|
||||
|
||||
@keyval: the keyval to generate when the macro button is pressed.
|
||||
If this is 0, no keypress will be generated.
|
||||
@modifiers: the modifiers set for the generated key event.
|
||||
|
||||
<!-- ##### FUNCTION gdk_input_set_extension_events ##### -->
|
||||
<para>
|
||||
Turns extension events on or off for a particular window,
|
||||
and specifies the event mask for extension events.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow.
|
||||
@mask: the event mask
|
||||
@mode: the type of extension events that are desired.
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkExtensionMode ##### -->
|
||||
<para>
|
||||
An enumeration used to specify which extension events
|
||||
are desired for a particular widget.
|
||||
</para>
|
||||
|
||||
@GDK_EXTENSION_EVENTS_NONE: no extension events are desired.
|
||||
@GDK_EXTENSION_EVENTS_ALL: all extension events are desired.
|
||||
@GDK_EXTENSION_EVENTS_CURSOR: extension events are desired only if a cursor
|
||||
will be displayed for the device.
|
||||
|
||||
<!-- ##### FUNCTION gdk_input_set_source ##### -->
|
||||
<para>
|
||||
Sets the source type for a device.
|
||||
</para>
|
||||
|
||||
@deviceid: the device to configure
|
||||
@source: the new source type.
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkInputSource ##### -->
|
||||
<para>
|
||||
An enumeration describing the type of an input device
|
||||
in general terms.
|
||||
</para>
|
||||
|
||||
@GDK_SOURCE_MOUSE: the device is a mouse. (This will be reported for the core
|
||||
pointer, even if it is something else, such as a trackball.)
|
||||
@GDK_SOURCE_PEN: the device is a stylus of a graphics tablet or similar device.
|
||||
@GDK_SOURCE_ERASER: the device is an eraser. Typically, this would be the other end
|
||||
of a stylus on a graphics tablet.
|
||||
@GDK_SOURCE_CURSOR: the device is a graphics tablet "puck" or similar device.
|
||||
|
||||
<!-- ##### FUNCTION gdk_input_set_mode ##### -->
|
||||
<para>
|
||||
Enables or disables a device, and determines how the
|
||||
device maps onto the screen.
|
||||
</para>
|
||||
|
||||
@deviceid: the device to configure.
|
||||
@mode: the new mode.
|
||||
@Returns: %TRUE if the device supports the given mode, otherwise
|
||||
%FALSE and the device's mode is unchanged.
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkInputMode ##### -->
|
||||
<para>
|
||||
An enumeration that describes the mode of an input device.
|
||||
</para>
|
||||
|
||||
@GDK_MODE_DISABLED: the device is disabled and will not report any events.
|
||||
@GDK_MODE_SCREEN: the device is enabled. The device's coordinate space
|
||||
maps to the entire screen.
|
||||
@GDK_MODE_WINDOW: the device is enabled. The device's coordinate space
|
||||
is mapped to a single window. The manner in which this window
|
||||
is chosen is undefined, but it will typically be the same
|
||||
way in which the focus window for key events is determined.
|
||||
|
||||
<!-- ##### FUNCTION gdk_input_set_axes ##### -->
|
||||
<para>
|
||||
Sets the mapping of the axes (valuators) of a device
|
||||
onto the predefined valuator types that GTK+ understands.
|
||||
</para>
|
||||
|
||||
@deviceid: the device to configure.
|
||||
@axes: an array of GdkAxisUse. This length of this array
|
||||
must match the number of axes for the device.
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkAxisUse ##### -->
|
||||
<para>
|
||||
An enumeration describing the way in which a device
|
||||
axis (valuator) maps onto the predefined valuator
|
||||
types that GTK+ understands.
|
||||
</para>
|
||||
|
||||
@GDK_AXIS_IGNORE: the axis is ignored.
|
||||
@GDK_AXIS_X: the axis is used as the x axis.
|
||||
@GDK_AXIS_Y: the axis is used as the y axis.
|
||||
@GDK_AXIS_PRESSURE: the axis is used for pressure information.
|
||||
@GDK_AXIS_XTILT: the axis is used for x tilt information.
|
||||
@GDK_AXIS_YTILT: the axis is used for x tilt information.
|
||||
@GDK_AXIS_LAST: a constant equal to the numerically highest axis value.
|
||||
|
||||
<!-- ##### FUNCTION gdk_input_set_key ##### -->
|
||||
<para>
|
||||
Sets the key event generated when a macro button is pressed.
|
||||
</para>
|
||||
|
||||
@deviceid: the device to configure.
|
||||
@index: the index of the macro button.
|
||||
@keyval: the key value for the #GdkKeypressEvent to generate.
|
||||
(a value of 0 means no event will be generated.)
|
||||
@modifiers: the modifier field for the generated
|
||||
#GdkKeyPressEvent.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_input_window_get_pointer ##### -->
|
||||
<para>
|
||||
Returns information about the current position of the pointer
|
||||
within a window, including extended device information.
|
||||
Any of the return parameters may be %NULL, in which case,
|
||||
they will be ignored.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow.
|
||||
@deviceid: a device ID.
|
||||
@x: location to store current x postion.
|
||||
@y: location to store current y postion.
|
||||
@pressure: location to store current pressure.
|
||||
@xtilt: location to store current tilt in the x direction.
|
||||
@ytilt: location to store current tilt in the y direction.
|
||||
@mask: location to store the current modifier state.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_input_motion_events ##### -->
|
||||
<para>
|
||||
Retrieves the motion history for a given device/window pair.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow.
|
||||
@deviceid: the device for which to retrieve motion history.
|
||||
@start: the start time.
|
||||
@stop: the stop time.
|
||||
@nevents_return: location to store the number of events returned.
|
||||
@Returns: a newly allocated array containing all the events
|
||||
from @start to @stop. This array should be freed
|
||||
with g_free() when you are finished using it.
|
||||
|
||||
|
||||
<!-- ##### STRUCT GdkTimeCoord ##### -->
|
||||
<para>
|
||||
The #GdkTimeCoord structure stores a single event in a
|
||||
motion history. It contains the following fields:
|
||||
</para>
|
||||
|
||||
@time: The timestamp for this event.
|
||||
@x: the x position.
|
||||
@y: the y position.
|
||||
@pressure: the pressure.
|
||||
@xtilt: the tilt in the x direction.
|
||||
@ytilt: the tilt in the y direction.
|
||||
|
||||
@@ -1,213 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Input Methods
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
support for internationalized text input.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Input Methods provide a way for complex character sets to be used in GTK+.
|
||||
Languages such as Chinese, Japanese, and Korean (often abbreviated to CJK)
|
||||
use a large number of ideographs, making it impossible to support all
|
||||
characters with a simple keyboard. Instead, text is usually
|
||||
<emphasis>pre-edited</emphasis> using a phonetic alphabet and then
|
||||
<emphasis>composed</emphasis> to form the ideographs.
|
||||
</para>
|
||||
<para>
|
||||
GTK+ makes use of the input method mechanism provided by the X Windows
|
||||
platform. When a GTK+ application is started, it opens a connection to the
|
||||
input method appropriate for the current locale (if any).
|
||||
</para>
|
||||
<para>
|
||||
Widgets which handle textual input, such as #GtkEntry, need to do a number of
|
||||
things to support internationalized text input:
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>When the widget is realized:</term>
|
||||
<listitem><para>Check if an input method is being used with gdk_im_ready().
|
||||
If it is, create a new <link linkend="gdk-Input-Contexts">Input Context</link>
|
||||
using gdk_ic_new(). Find out which events the
|
||||
<link linkend="gdk-Input-Contexts">Input Context</link> needs to receive
|
||||
with gdk_ic_get_events(), and make sure that the widget's window receives
|
||||
these events using gdk_window_set_events().
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>When the widget's size, state or cursor position changes:</term>
|
||||
<listitem><para>
|
||||
Update the appropriate
|
||||
<link linkend="gdk-Input-Contexts">Input Context</link> attributes
|
||||
using gdk_ic_set_attr().
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>When the keyboard focus enters or leaves the widget:</term>
|
||||
<listitem><para>
|
||||
Call gdk_im_begin() or gdk_im_end() to start or finish editing the text.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>When the widget receives a key_press event:</term>
|
||||
<listitem><para>
|
||||
The <structfield>string</structfield> and <structfield>length</structfield>
|
||||
fields of the #GdkEventKey struct should be used to insert the composed text
|
||||
into the widget.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>When the widget is unrealized:</term>
|
||||
<listitem><para>
|
||||
Destroy the <link linkend="gdk-Input-Contexts">Input Context</link>.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
</para>
|
||||
<para>
|
||||
See the XLib reference manual for more detailed information on input methods,
|
||||
and the #GtkEntry and #GtkText widgets for some example code.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><link linkend="gdk-Input-Contexts">Input Contexts</link></term>
|
||||
<listitem><para>
|
||||
Used for each widget that handles internationalized text input using the
|
||||
global input method.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GdkIMStyle ##### -->
|
||||
<para>
|
||||
A set of bit-flags used to specify the input method styles which are supported
|
||||
or which are currently in use. The flags can be divided into 2 groups, the
|
||||
pre-edit flags and the status flags.
|
||||
</para>
|
||||
<para>
|
||||
The pre-edit flags specify how pre-editing data is displayed.
|
||||
For example, this could display the text being typed in the phonetic
|
||||
alphabet before it is composed and inserted as an ideograph.
|
||||
</para>
|
||||
<para>
|
||||
The status flags specify how status information is displayed.
|
||||
The status information can be thought of as an extension of the
|
||||
standard keyboard mode indicators, such as the Caps Lock indicator.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
The %GDK_IM_PREEDIT_CALLBACKS and %GDK_IM_STATUS_CALLBACKS styles are not
|
||||
currently supported in GTK+.
|
||||
</para>
|
||||
</note>
|
||||
|
||||
@GDK_IM_PREEDIT_AREA: The application provides the input method with an area
|
||||
in which to perform <emphasis>off-the-spot</emphasis> pre-editing.
|
||||
@GDK_IM_PREEDIT_CALLBACKS: The application registers a number of callback
|
||||
functions which are used to display pre-editing data.
|
||||
@GDK_IM_PREEDIT_POSITION: The application provides the input method with the
|
||||
position of the insertion cursor, for <emphasis>over-the-spot</emphasis>
|
||||
pre-editing. The input method creates its own window over the widget to
|
||||
display the pre-editing data.
|
||||
@GDK_IM_PREEDIT_NOTHING: The input method uses the root X window to perform
|
||||
pre-editing, so the application does not need to do anything.
|
||||
@GDK_IM_PREEDIT_NONE: No pre-editing is done by the input method, or no
|
||||
pre-editing data needs to be displayed.
|
||||
@GDK_IM_PREEDIT_MASK: A bit-mask containing all the pre-edit flags.
|
||||
@GDK_IM_STATUS_AREA: The application provides the input method with an area
|
||||
in which to display status information.
|
||||
@GDK_IM_STATUS_CALLBACKS: The applications registers a number of callback
|
||||
functions which are used to display status information.
|
||||
@GDK_IM_STATUS_NOTHING: The input method uses the root X window to display
|
||||
status information, so the application does not need to do anything.
|
||||
@GDK_IM_STATUS_NONE: The input method does not display status information.
|
||||
@GDK_IM_STATUS_MASK: A bit-mask containing all the status flags.
|
||||
|
||||
<!-- ##### FUNCTION gdk_im_ready ##### -->
|
||||
<para>
|
||||
Checks if an input method is to be used for the current locale.
|
||||
If GTK+ has been compiled without support for input methods, or the current
|
||||
locale doesn't need an input method, then this will return FALSE.
|
||||
</para>
|
||||
|
||||
@Returns: TRUE if an input method is available and should be used.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_im_decide_style ##### -->
|
||||
<para>
|
||||
Decides which input method style should be used, by comparing the styles given
|
||||
in @supported_style with those of the available input method.
|
||||
</para>
|
||||
|
||||
@supported_style: styles which are supported by the widget.
|
||||
@Returns: the best style in @supported_style that is also supported by the
|
||||
available input method.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_im_set_best_style ##### -->
|
||||
<para>
|
||||
Sets the best pre-edit and/or status style which should be used.
|
||||
This will affect the style chosen in gdk_im_decide_style().
|
||||
</para>
|
||||
<para>
|
||||
The order of the pre-edit styles is (from worst to best):
|
||||
%GDK_IM_PREEDIT_NONE, %GDK_IM_PREEDIT_NOTHING, %GDK_IM_PREEDIT_AREA,
|
||||
%GDK_IM_PREEDIT_POSITION, %GDK_IM_PREEDIT_CALLBACKS.
|
||||
The order of the status styles is:
|
||||
%GDK_IM_STATUS_NONE, %GDK_IM_STATUS_NOTHING, %GDK_IM_STATUS_AREA,
|
||||
%GDK_IM_STATUS_CALLBACKS.
|
||||
</para>
|
||||
<para>
|
||||
So, for example, to set the best allowed pre-edit style to %GDK_IM_PREEDIT_AREA
|
||||
you would do this:
|
||||
|
||||
<informalexample>
|
||||
<programlisting>
|
||||
gdk_im_set_best_style (GDK_IM_PREEDIT_AREA);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
|
||||
Or to set the best allowed pre-edit style to %GDK_IM_PREEDIT_POSITION and the
|
||||
best allowed status style to %GDK_IM_STATUS_NOTHING you can do this:
|
||||
|
||||
<informalexample>
|
||||
<programlisting>
|
||||
gdk_im_set_best_style (GDK_IM_PREEDIT_POSITION | GDK_IM_STATUS_NOTHING);
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
</para>
|
||||
|
||||
@best_allowed_style: a bit-mask with the best pre-edit style and/or the best
|
||||
status style to use. If 0 is used, then the current bit-mask of all allowed
|
||||
styles is returned.
|
||||
@Returns: a bit-mask of all the styles allowed.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_im_begin ##### -->
|
||||
<para>
|
||||
Starts editing, using the given input context and #GdkWindow.
|
||||
This should be called when the widget receives the input focus, typically in
|
||||
the widget's focus_in_event method.
|
||||
</para>
|
||||
|
||||
@ic: a #GdkIC.
|
||||
@window: the #GdkWindow which will be receiving the key press events.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_im_end ##### -->
|
||||
<para>
|
||||
Stops editing using the input method.
|
||||
This should be called when the widget loses the input focus, typically in
|
||||
the widget's focus_out_event method.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
@@ -1,93 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Key Values
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
functions for manipulating keyboard codes.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Key values are the codes which are sent whenever a key is pressed or released.
|
||||
They appear in the <structfield>keyval</structfield> field of the
|
||||
#GdkEventKey structure, which is passed to signal handlers for the
|
||||
"key-press-event" and "key-release-event" signals.
|
||||
The complete list of key values can be found in the <gdk/gdkkeysyms.h>
|
||||
header file.
|
||||
</para>
|
||||
<para>
|
||||
Key values can be converted into a string representation using
|
||||
gdk_keyval_name(). The reverse function, converting a string to a key value,
|
||||
is provided by gdk_keyval_from_name().
|
||||
</para>
|
||||
<para>
|
||||
The case of key values can be determined using gdk_keyval_is_upper() and
|
||||
gdk_keyval_is_lower(). Key values can be converted to upper or lower case
|
||||
using gdk_keyval_to_upper() and gdk_keyval_to_lower().
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gdk_keyval_name ##### -->
|
||||
<para>
|
||||
Converts a key value into a symbolic name.
|
||||
The names are the same as those in the <gdk/gdkkeysyms.h> header file
|
||||
but without the leading "GDK_".
|
||||
</para>
|
||||
|
||||
@keyval: a key value.
|
||||
@Returns: a string containing the name of the key, or NULL if @keyval is not
|
||||
a valid key. The string should not be modified.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_keyval_from_name ##### -->
|
||||
<para>
|
||||
Converts a key name to a key value.
|
||||
</para>
|
||||
|
||||
@keyval_name: a key name.
|
||||
@Returns: the corresponding key value, or %GDK_VoidSymbol if the key name is
|
||||
not a valid key.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_keyval_is_upper ##### -->
|
||||
<para>
|
||||
Returns TRUE if the given key value is in upper case.
|
||||
</para>
|
||||
|
||||
@keyval: a key value.
|
||||
@Returns: TRUE if @keyval is in upper case, or if @keyval is not subject to
|
||||
case conversion.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_keyval_is_lower ##### -->
|
||||
<para>
|
||||
Returns TRUE if the given key value is in lower case.
|
||||
</para>
|
||||
|
||||
@keyval: a key value.
|
||||
@Returns: TRUE if @keyval is in lower case, or if @keyval is not subject to
|
||||
case conversion.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_keyval_to_upper ##### -->
|
||||
<para>
|
||||
Converts a key value to upper case, if applicable.
|
||||
</para>
|
||||
|
||||
@keyval: a key value.
|
||||
@Returns: the upper case form of @keyval, or @keyval itself if it is already
|
||||
in upper case or it is not subject to case conversion.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_keyval_to_lower ##### -->
|
||||
<para>
|
||||
Converts a key value to lower case, if applicable.
|
||||
</para>
|
||||
|
||||
@keyval: a key value.
|
||||
@Returns: the lower case form of @keyval, or @keyval itself if it is already
|
||||
in lower case or it is not subject to case conversion.
|
||||
|
||||
|
||||
@@ -1,196 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Bitmaps and Pixmaps
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Offscreen drawables.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Pixmaps are offscreen drawables. They can be drawn upon with the
|
||||
standard drawing primitives, then copied to another drawable (such as
|
||||
a #GdkWindow) with gdk_pixmap_draw(). The depth of a pixmap
|
||||
is the number of bits per pixels. Bitmaps are simply pixmaps
|
||||
with a depth of 1. (That is, they are monochrome bitmaps - each
|
||||
pixel can be either on or off).
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GdkPixmap ##### -->
|
||||
<para>
|
||||
An opaque structure representing an offscreen drawable.
|
||||
Pointers to structures of type #GdkPixmap, #GdkBitmap,
|
||||
and #GdkWindow, can often be used interchangeably.
|
||||
The type #GdkDrawable refers generically to any of
|
||||
these types.
|
||||
</para>
|
||||
|
||||
@user_data:
|
||||
|
||||
<!-- ##### FUNCTION gdk_pixmap_new ##### -->
|
||||
<para>
|
||||
Create a new pixmap with a given size and depth.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow, used to determine default values for the
|
||||
new pixmap. Can be %NULL if @depth is specified,
|
||||
@width: The width of the new pixmap in pixels.
|
||||
@height: The height of the new pixmap in pixels.
|
||||
@depth: The depth (number of bits per pixel) of the new pixmap.
|
||||
If -1, and @window is not %NULL, the depth of the new
|
||||
pixmap will be equal to that of @window.
|
||||
@Returns: the #GdkBitmap
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_bitmap_create_from_data ##### -->
|
||||
<para>
|
||||
Creates a new bitmap from data in XBM format.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow, used to determine default values for the
|
||||
new pixmap. Can be %NULL, in which case the root window is
|
||||
used.
|
||||
@data: a pointer to the XBM data.
|
||||
@width: the width of the new pixmap in pixels.
|
||||
@height: the height of the new pixmap in pixels.
|
||||
@Returns: the #GdkBitmap
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_pixmap_create_from_data ##### -->
|
||||
<para>
|
||||
Create a two-color pixmap from data in XBM data.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow, used to determine default values for the
|
||||
new pixmap. Can be %NULL, if the depth is given.
|
||||
@data: a pointer to the data.
|
||||
@width: the width of the new pixmap in pixels.
|
||||
@height: the height of the new pixmap in pixels.
|
||||
@depth: the depth (number of bits per pixel) of the new pixmap.
|
||||
@fg: the foreground color.
|
||||
@bg: the background color.
|
||||
@Returns: the #GdkPixmap
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_pixmap_create_from_xpm ##### -->
|
||||
<para>
|
||||
Create a pixmap from a XPM file.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow, used to determine default values for the
|
||||
new pixmap.
|
||||
@mask: a pointer to a place to store a bitmap representing
|
||||
the transparency mask of the XPM file. Can be %NULL,
|
||||
in which case transparency will be ignored.
|
||||
@transparent_color: the color to be used for the pixels
|
||||
that are transparent in the input file. Can be %NULL,
|
||||
in which case a default color will be used.
|
||||
@filename: the filename of a file containing XPM data.
|
||||
@Returns: the #GdkPixmap
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_pixmap_colormap_create_from_xpm ##### -->
|
||||
<para>
|
||||
Create a pixmap from a XPM file using a particular colormap.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow, used to determine default values for the
|
||||
new pixmap. Can be %NULL if @colormap is given.
|
||||
@colormap: the #GdkColormap that the new pixmap will be use.
|
||||
If omitted, the colormap for @window will be used.
|
||||
@mask: a pointer to a place to store a bitmap representing
|
||||
the transparency mask of the XPM file. Can be %NULL,
|
||||
in which case transparency will be ignored.
|
||||
@transparent_color: the color to be used for the pixels
|
||||
that are transparent in the input file. Can be %NULL,
|
||||
in which case a default color will be used.
|
||||
@filename: the filename of a file containing XPM data.
|
||||
@Returns: the #GdkPixmap.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_pixmap_create_from_xpm_d ##### -->
|
||||
<para>
|
||||
Create a pixmap from data in XPM format.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow, used to determine default values for the
|
||||
new pixmap.
|
||||
@mask: Pointer to a place to store a bitmap representing
|
||||
the transparency mask of the XPM file. Can be %NULL,
|
||||
in which case transparency will be ignored.
|
||||
@transparent_color: This color will be used for the pixels
|
||||
that are transparent in the input file. Can be %NULL
|
||||
in which case a default color will be used.
|
||||
@data: Pointer to a string containing the XPM data.
|
||||
@Returns: the #GdkPixmap
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_pixmap_colormap_create_from_xpm_d ##### -->
|
||||
<para>
|
||||
Create a pixmap from data in XPM format using a particular
|
||||
colormap.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow, used to determine default values for the
|
||||
new pixmap. Can be %NULL if @colormap is given.
|
||||
@colormap: the #GdkColormap that the new pixmap will be use.
|
||||
If omitted, the colormap for @window will be used.
|
||||
@mask: a pointer to a place to store a bitmap representing
|
||||
the transparency mask of the XPM file. Can be %NULL,
|
||||
in which case transparency will be ignored.
|
||||
@transparent_color: the color to be used for the pixels
|
||||
that are transparent in the input file. Can be %NULL,
|
||||
in which case a default color will be used.
|
||||
@data: Pointer to a string containing the XPM data.
|
||||
@Returns: the #GdkPixmap.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_pixmap_ref ##### -->
|
||||
<para>
|
||||
Increase the reference count of a pixmap.
|
||||
</para>
|
||||
|
||||
@pixmap: a #GdkPixmap
|
||||
@Returns: @pixmap
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_pixmap_unref ##### -->
|
||||
<para>
|
||||
Decrease the reference count of a pixmap. If the resulting
|
||||
reference count is zero, destroy the pixmap.
|
||||
</para>
|
||||
|
||||
@pixmap: a #GdkPixmap
|
||||
|
||||
|
||||
<!-- ##### STRUCT GdkBitmap ##### -->
|
||||
<para>
|
||||
An opaque structure representing an offscreen drawable of depth
|
||||
1. Pointers to structures of type GdkPixmap, #GdkBitmap, and
|
||||
#GdkWindow, can often be used interchangeably. The type #GdkDrawable
|
||||
refers generically to any of these types.
|
||||
</para>
|
||||
|
||||
@user_data:
|
||||
|
||||
<!-- ##### FUNCTION gdk_bitmap_ref ##### -->
|
||||
<para>
|
||||
Increase the reference count of a bitmap. An alias
|
||||
for gdk_pixmap_ref().
|
||||
</para>
|
||||
|
||||
@pixmap:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_bitmap_unref ##### -->
|
||||
<para>
|
||||
Decrease the reference count of a bitmap. An alias
|
||||
for gdk_pixmap_unref().
|
||||
</para>
|
||||
|
||||
@pixmap:
|
||||
|
||||
|
||||
@@ -1,225 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Properties and Atoms
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
functions to manipulate properties on windows.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Each window under X can have any number of associated
|
||||
<firstterm>properties</firstterm> attached to it.
|
||||
Properties are arbitrary chunks of data identified by
|
||||
<firstterm>atom</firstterm>s. (An <firstterm>atom</firstterm>
|
||||
is a numeric index into a string table on the X server. They are used
|
||||
to transfer strings efficiently between clients without
|
||||
having to transfer the entire string.) A property
|
||||
has an associated type, which is also identified
|
||||
using an atom.
|
||||
</para>
|
||||
<para>
|
||||
A property has an associated <firstterm>format</firstterm>,
|
||||
an integer describing how many bits are in each unit
|
||||
of data inside the property. It must be 8, 16, or 32.
|
||||
When data is transfered between the server and client,
|
||||
if they are of different endianesses it will be byteswapped
|
||||
as necessary according to the format of the property.
|
||||
Note that on the client side, properties of format 32
|
||||
will be stored with one unit per <emphasis>long</emphasis>,
|
||||
even if a long integer has more than 32 bits on the platform.
|
||||
(This decision was apparently made for Xlib to maintain
|
||||
compatibility with programs that assumed longs were 32
|
||||
bits, at the expense of programs that knew better.)
|
||||
</para>
|
||||
<para>
|
||||
The functions in this section are used to add, remove
|
||||
and change properties on windows, to convert atoms
|
||||
to and from strings and to manipulate some types of
|
||||
data commonly stored in X window properties.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### TYPEDEF GdkAtom ##### -->
|
||||
<para>
|
||||
A numeric type representing a string as an index into a table
|
||||
of strings on the X server.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GDK_NONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_text_property_to_text_list ##### -->
|
||||
<para>
|
||||
Convert a text string from the encoding as it is stored in
|
||||
a property into an array of strings in the encoding of
|
||||
the current local. (The elements of the array represent
|
||||
the null-separated elements of the original text string.)
|
||||
</para>
|
||||
|
||||
@encoding: an atom representing the encoding. The most common
|
||||
values for this are <literal>STRING</literal>,
|
||||
or <literal>COMPOUND_TEXT</literal>. This is
|
||||
value used as the type for the property.
|
||||
@format: the format of the property.
|
||||
@text: the text data.
|
||||
@length: the length of the property, in item.s
|
||||
@list: location to store a terminated array of strings
|
||||
in the encoding of the current locale. This
|
||||
array should be freed using gdk_free_text_list().
|
||||
@Returns: the number of strings stored in @list, or 0,
|
||||
if the conversion failed.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_free_text_list ##### -->
|
||||
<para>
|
||||
Free the array of strings created by
|
||||
gdk_text_property_to_text_list().
|
||||
</para>
|
||||
|
||||
@list: the value stored in the @list parameter by
|
||||
a call to gdk_text_property_to_text_list().
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_string_to_compound_text ##### -->
|
||||
<para>
|
||||
Convert a string from the encoding of the current locale
|
||||
into a form suitable for storing in a window property.
|
||||
</para>
|
||||
|
||||
@str: a null-terminated string.
|
||||
@encoding: location to store the encoding atom (to be used as the type for the property).
|
||||
@format: location to store the format for the property.
|
||||
@ctext: location to store newly allocated data for the property.
|
||||
@length: location to store the length of @ctext in items.
|
||||
@Returns: 0 upon sucess, non-zero upon failure.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_free_compound_text ##### -->
|
||||
<para>
|
||||
Free the data returned from gdk_string_to_compound_text().
|
||||
</para>
|
||||
|
||||
@ctext: The pointer stored in @ctext from a call to gdk_string_to_compound_text().
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_atom_intern ##### -->
|
||||
<para>
|
||||
Find or create an atom corresponding to a given string.
|
||||
</para>
|
||||
|
||||
@atom_name: a string.
|
||||
@only_if_exists: if %TRUE, do not create a new atom, but
|
||||
just return the atom if it already exists.
|
||||
@Returns: the atom corresponding to @atom_name, or, if
|
||||
@only_if_exists is false, and an atom does not
|
||||
already exists for the string, %GDK_NONE.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_atom_name ##### -->
|
||||
<para>
|
||||
Determine the string corresponding to an atom.
|
||||
</para>
|
||||
|
||||
@atom: a #GdkAtom.
|
||||
@Returns: a newly allocated string containing the string
|
||||
corresponding to @atom. When you are done
|
||||
with the return value, you should free it
|
||||
using g_free().
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_property_get ##### -->
|
||||
<para>
|
||||
Retrieves a portion of the contents of a property. If the
|
||||
property does not exist, then the function returns FALSE,
|
||||
and %GDK_NONE will be stored in @actual_property_type.
|
||||
|
||||
Note: the <function>XGetWindowProperty()</function>
|
||||
function that gdk_property_get()
|
||||
uses has a very confusing and complicated set of semantics.
|
||||
Unfortunately, gdk_property_get() makes the situation
|
||||
worse instead of better (the semantics should be considered
|
||||
undefined), and also prints warnings to stderr in cases where it
|
||||
should return a useful error to the program. You are advised to use
|
||||
<function>XGetWindowProperty()</function>
|
||||
directly until a replacement function for gdk_property_get()
|
||||
is provided.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow.
|
||||
@property: the property to retrieve.
|
||||
@type: the desired property type, or 0, if any type of data
|
||||
is acceptable. If this does not match the actual
|
||||
type, then @actual_format and @actual_length will
|
||||
be filled in, a warning will be printed to stderr
|
||||
and no data will be returned.
|
||||
@offset: the offset into the property at which to begin
|
||||
retrieving data. (in 4 byte units!)
|
||||
@length: the length of the data to delete. (in bytes, but
|
||||
the actual retrieved length will be the next
|
||||
integer multiple multiple of four greater than
|
||||
this!)
|
||||
@pdelete: if %TRUE, delete the property after retrieving the
|
||||
data.
|
||||
@actual_property_type: location to store the actual type of
|
||||
the property.
|
||||
@actual_format: location to store the actual format of the data.
|
||||
@actual_length: location to store the length of the retrieved
|
||||
data, in bytes.
|
||||
@data: location to store a pointer to the data. The retrieved
|
||||
data should be freed with g_free() when you are finished
|
||||
using it.
|
||||
@Returns: %TRUE if data was sucessfully received and stored
|
||||
in @data, otherwise %FALSE.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_property_change ##### -->
|
||||
<para>
|
||||
Change the contents of a property on a window.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow.
|
||||
@property: the property to change.
|
||||
@type: the new type for the property. If @mode is
|
||||
%GDK_PROP_MODE_REPLACE or %GDK_PROP_MODE_APPEND, then this
|
||||
must match the existing type or an error will occur.
|
||||
@format: the new format for the property. If @mode is
|
||||
%GDK_PROP_MODE_REPLACE or %GDK_PROP_MODE_APPEND, then this
|
||||
must match the existing format or an error will occur.
|
||||
@mode: a value describing how the new data is to be combined
|
||||
with the current data.
|
||||
@data: the data
|
||||
(a <literal>guchar *</literal>
|
||||
<literal>gushort *</literal>, or
|
||||
<literal>gulong *</literal>, depending on @format), cast to a
|
||||
<literal>guchar *</literal>.
|
||||
@nelements: the number of elements of size determined by the format,
|
||||
contained in @data.
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkPropMode ##### -->
|
||||
<para>
|
||||
Describes how existing data is combined with new data when
|
||||
using gdk_property_change().
|
||||
</para>
|
||||
|
||||
@GDK_PROP_MODE_REPLACE: the new data replaces the existing data.
|
||||
@GDK_PROP_MODE_PREPEND: the new data is prepended to the existing data.
|
||||
@GDK_PROP_MODE_APPEND: the new data is appended to the existing data.
|
||||
|
||||
<!-- ##### FUNCTION gdk_property_delete ##### -->
|
||||
<para>
|
||||
Delete a property from a window.
|
||||
</para>
|
||||
|
||||
@window: a #GdkWindow.
|
||||
@property: the property to delete.
|
||||
|
||||
|
||||
@@ -1,259 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Points, Rectangles and Regions
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
simple graphical data types.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
GDK provides the #GdkPoint, #GdkRectangle and #GdkRegion data types for
|
||||
representing pixels and sets of pixels on the screen.
|
||||
</para>
|
||||
<para>
|
||||
#GdkPoint is a simple structure containing an x and y coordinate of a point.
|
||||
</para>
|
||||
<para>
|
||||
#GdkRectangle is a structure holding the position and size of a rectangle.
|
||||
The intersection of two rectangles can be computed with
|
||||
gdk_rectangle_intersect(). To find the union of two rectangles use
|
||||
gdk_rectangle_union().
|
||||
</para>
|
||||
<para>
|
||||
#GdkRegion is an opaque data type holding a set of arbitrary pixels, and is
|
||||
usually used for clipping graphical operations (see gdk_gc_set_clip_region()).
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GdkPoint ##### -->
|
||||
<para>
|
||||
Defines the x and y coordinates of a point.
|
||||
Note that both are defined as #gint16 values, so the coordinates are limited
|
||||
to between -32,768 and 32,767.
|
||||
</para>
|
||||
|
||||
@x: the x coordinate of the point.
|
||||
@y: the y coordinate of the point.
|
||||
|
||||
<!-- ##### STRUCT GdkRectangle ##### -->
|
||||
<para>
|
||||
Defines the position and size of a rectangle.
|
||||
</para>
|
||||
|
||||
@x: the x coordinate of the left edge of the rectangle.
|
||||
@y: the y coordinate of the top of the rectangle.
|
||||
@width: the width of the rectangle.
|
||||
@height: the height of the rectangle.
|
||||
|
||||
<!-- ##### FUNCTION gdk_rectangle_intersect ##### -->
|
||||
<para>
|
||||
Calculates the intersection of two rectangles.
|
||||
</para>
|
||||
|
||||
@src1: a #GdkRectangle.
|
||||
@src2: a #GdkRectangle.
|
||||
@dest: the intersection of @src1 and @src2.
|
||||
@Returns: TRUE if the rectangles intersect.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_rectangle_union ##### -->
|
||||
<para>
|
||||
Calculates the union of two rectangles.
|
||||
The union of rectangles @src1 and @src2 is the smallest rectangle which
|
||||
includes both @src1 and @src2 within it.
|
||||
</para>
|
||||
|
||||
@src1: a #GdkRectangle.
|
||||
@src2: a #GdkRectangle.
|
||||
@dest: the union of @src1 and @src2.
|
||||
|
||||
|
||||
<!-- ##### STRUCT GdkRegion ##### -->
|
||||
<para>
|
||||
A GdkRegion represents a set of pixels on the screen.
|
||||
The only user-visible field of the structure is the user_data member, which
|
||||
can be used to attach arbitrary data to the #GdkRegion.
|
||||
</para>
|
||||
|
||||
@user_data: arbitrary data attached to the #GdkRegion.
|
||||
|
||||
<!-- ##### FUNCTION gdk_region_new ##### -->
|
||||
<para>
|
||||
Creates a new empty #GdkRegion.
|
||||
</para>
|
||||
|
||||
@Returns: a new empty #GdkRegion.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_region_polygon ##### -->
|
||||
<para>
|
||||
Creates a new #GdkRegion using the polygon defined by a number of points.
|
||||
|
||||
</para>
|
||||
|
||||
@points: an array of #GdkPoint structs.
|
||||
@npoints: the number of elements in the @points array.
|
||||
@fill_rule: specifies which pixels are included in the region when the polygon
|
||||
overlaps itself.
|
||||
@Returns: a new #GdkRegion based on the given polygon.
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkFillRule ##### -->
|
||||
<para>
|
||||
The method for determining which pixels are included in a region, when
|
||||
creating a #GdkRegion from a polygon.
|
||||
The fill rule is only relevant for polygons which overlap themselves.
|
||||
</para>
|
||||
|
||||
@GDK_EVEN_ODD_RULE: areas which are overlapped an odd number of times are
|
||||
included in the region, while areas overlapped an even number of times are not.
|
||||
@GDK_WINDING_RULE: overlapping areas are always included.
|
||||
|
||||
<!-- ##### FUNCTION gdk_region_destroy ##### -->
|
||||
<para>
|
||||
Destroys a #GdkRegion.
|
||||
</para>
|
||||
|
||||
@region: a #GdkRegion.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_regions_intersect ##### -->
|
||||
<para>
|
||||
Returns the intersection of two regions.
|
||||
</para>
|
||||
|
||||
@source1: a #GdkRegion.
|
||||
@source2: a #GdkRegion.
|
||||
@Returns: the intersection of @source1 and @source2.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_regions_union ##### -->
|
||||
<para>
|
||||
Returns the union of two regions.
|
||||
This is all pixels in either of @source1 or @source2.
|
||||
</para>
|
||||
|
||||
@source1: a #GdkRegion.
|
||||
@source2: a #GdkRegion.
|
||||
@Returns: the union of @source1 and @source2.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_regions_subtract ##### -->
|
||||
<para>
|
||||
Subtracts one region from another.
|
||||
The result is a region containing all the pixels which are in @source1, but
|
||||
which are not in @source2.
|
||||
</para>
|
||||
|
||||
@source1: a #GdkRegion.
|
||||
@source2: a #GdkRegion to subtract from @source1.
|
||||
@Returns: @source1 - @source2.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_regions_xor ##### -->
|
||||
<para>
|
||||
Returns the difference between the union and the intersection of two regions.
|
||||
This is a region containing the pixels that are in one of the source regions,
|
||||
but which are not in both.
|
||||
</para>
|
||||
|
||||
@source1: a #GdkRegion.
|
||||
@source2: a #GdkRegion.
|
||||
@Returns: the difference between the union and the intersection of @source1
|
||||
and @source2.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_region_union_with_rect ##### -->
|
||||
<para>
|
||||
Returns the union of a region and a rectangle.
|
||||
</para>
|
||||
|
||||
@region: a #GdkRegion.
|
||||
@rect: a #GdkRectangle.
|
||||
@Returns: the union of @region and @rect.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_region_offset ##### -->
|
||||
<para>
|
||||
Moves a region the specified distance.
|
||||
</para>
|
||||
|
||||
@region: a #GdkRegion.
|
||||
@dx: the distance to move the region horizontally.
|
||||
@dy: the distance to move the region vertically.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_region_shrink ##### -->
|
||||
<para>
|
||||
Resizes a region by the specified amount.
|
||||
Positive values shrink the region. Negative values expand it.
|
||||
</para>
|
||||
|
||||
@region: a #GdkRegion.
|
||||
@dx: the number of pixels to shrink the region horizontally.
|
||||
@dy: the number of pixels to shrink the region vertically.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_region_empty ##### -->
|
||||
<para>
|
||||
Returns TRUE if the #GdkRegion is empty.
|
||||
</para>
|
||||
|
||||
@region: a #GdkRegion.
|
||||
@Returns: TRUE if @region is empty.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_region_equal ##### -->
|
||||
<para>
|
||||
Returns TRUE if the two regions are the same.
|
||||
</para>
|
||||
|
||||
@region1: a #GdkRegion.
|
||||
@region2: a #GdkRegion.
|
||||
@Returns: TRUE if @region1 and @region2 are equal.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_region_point_in ##### -->
|
||||
<para>
|
||||
Returns TRUE if a point is in a region.
|
||||
</para>
|
||||
|
||||
@region: a #GdkRegion.
|
||||
@x: the x coordinate of a point.
|
||||
@y: the y coordinate of a point.
|
||||
@Returns: TRUE if the point is in @region.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_region_rect_in ##### -->
|
||||
<para>
|
||||
Tests whether a rectangle is within a region.
|
||||
</para>
|
||||
|
||||
@region: a #GdkRegion.
|
||||
@rect: a #GdkRectangle.
|
||||
@Returns: GDK_OVERLAP_RECTANGLE_IN, GDK_OVERLAP_RECTANGLE_OUT, or
|
||||
GDK_OVERLAP_RECTANGLE_PART, depending on whether the rectangle is inside,
|
||||
outside, or partly inside the #GdkRegion, respectively.
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkOverlapType ##### -->
|
||||
<para>
|
||||
Specifies the possible values returned by gdk_region_rect_in().
|
||||
</para>
|
||||
|
||||
@GDK_OVERLAP_RECTANGLE_IN: if the rectangle is inside the #GdkRegion.
|
||||
@GDK_OVERLAP_RECTANGLE_OUT: if the rectangle is outside the #GdkRegion.
|
||||
@GDK_OVERLAP_RECTANGLE_PART: if the rectangle is partly inside the #GdkRegion.
|
||||
|
||||
<!-- ##### FUNCTION gdk_region_get_clipbox ##### -->
|
||||
<para>
|
||||
Returns the smallest rectangle which includes the entire #GdkRegion.
|
||||
</para>
|
||||
|
||||
@region: a #GdkRegion.
|
||||
@rectangle: returns the smallest rectangle which includes all of @region.
|
||||
|
||||
|
||||
@@ -1,458 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GdkRGB
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
displays RGB images (as well as grayscale and colormapped) to
|
||||
the native window.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
GdkRgb converts RGB, grayscale, and colormapped images into the native
|
||||
window pixel format and displays them. It takes care of colormaps,
|
||||
visuals, dithering, and management of the temporary buffers.
|
||||
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You must call gdk_rgb_init() before using any GdkRgb functionality. If
|
||||
you fail to do so, expect coredumps. All Gtk+ widgets that use GdkRgb
|
||||
(including #GtkPreview) call gdk_rgb_init() in their class_init method.
|
||||
Thus, if you use GdkRgb only indirectly, you don't need to worry
|
||||
about it.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
GdkRgb tries to use the system default visual and colormap, but
|
||||
doesn't always succeed. Thus, you have to be prepared to install the
|
||||
visual and colormap generated by GdkRgb. The following code sequence
|
||||
(before any widgets are created) should work in most applications:
|
||||
</para>
|
||||
|
||||
<informalexample>
|
||||
<programlisting>
|
||||
gdk_rgb_init ();
|
||||
|
||||
gtk_widget_set_default_colormap (gdk_rgb_get_cmap ());
|
||||
gtk_widget_set_default_visual (gdk_rgb_get_visual ());
|
||||
</programlisting>
|
||||
</informalexample>
|
||||
|
||||
<para>
|
||||
You can also push the colormap and visual, but in general it doesn't
|
||||
work unless the push wraps the window creation call. If you wrap the
|
||||
push around a widget which is embedded in a window without the GdkRgb
|
||||
colormap and visual, it probably won't work, and is likely to cause
|
||||
colormap flashing, as well.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
On 8-bit systems, the colormaps used by Imlib and GdkRgb may
|
||||
conflict. There is no good general solution to this other than phasing
|
||||
out the dependence on Imlib.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You can set the threshold for installing colormaps with
|
||||
gdk_rgb_set_min_colors (). The default is 5x5x5 (125). If a colorcube
|
||||
of this size or larger can be allocated in the default colormap, then
|
||||
that's done. Otherwise, GdkRgb creates its own private colormap.
|
||||
Setting it to 0 means that it always tries to use the default
|
||||
colormap, and setting it to 216 means that it always creates a private
|
||||
one if it cannot allocate the 6x6x6 colormap in the default. If you
|
||||
always want a private colormap (to avoid consuming too many colormap
|
||||
entries for other apps, say), you can use gdk_rgb_set_install(TRUE).
|
||||
Setting the value greater than 216 exercises a bug in older versions
|
||||
of GdkRgb. Note, however, that setting it to 0 doesn't let you get
|
||||
away with ignoring the colormap and visual - a colormap is always
|
||||
created in grayscale and direct color modes, and the visual is changed
|
||||
in cases where a "better" visual than the default is available.
|
||||
</para>
|
||||
|
||||
<example>
|
||||
<title>A simple example program using GdkRGB.</title>
|
||||
<programlisting>
|
||||
#include <gtk/gtk.h>
|
||||
|
||||
#define IMAGE_WIDTH 256
|
||||
#define IMAGE_HEIGHT 256
|
||||
|
||||
guchar rgbbuf[IMAGE_WIDTH * IMAGE_HEIGHT * 3];
|
||||
|
||||
gboolean on_darea_expose (GtkWidget *widget,
|
||||
GdkEventExpose *event,
|
||||
gpointer user_data);
|
||||
|
||||
int
|
||||
main (int argc, char *argv[])
|
||||
{
|
||||
GtkWidget *window, *darea;
|
||||
gint x, y;
|
||||
guchar *pos;
|
||||
|
||||
gtk_init (&argc, &argv);
|
||||
gdk_rgb_init ();
|
||||
window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
|
||||
darea = gtk_drawing_area_new ();
|
||||
gtk_drawing_area_size (GTK_DRAWING_AREA (darea), IMAGE_WIDTH, IMAGE_HEIGHT);
|
||||
gtk_container_add (GTK_CONTAINER (window), darea);
|
||||
gtk_signal_connect (GTK_OBJECT (darea), "expose-event",
|
||||
GTK_SIGNAL_FUNC (on_darea_expose), NULL);
|
||||
gtk_widget_show_all (window);
|
||||
|
||||
/* Set up the RGB buffer. */
|
||||
pos = rgbbuf;
|
||||
for (y = 0; y < IMAGE_HEIGHT; y++)
|
||||
{
|
||||
for (x = 0; x < IMAGE_WIDTH; x++)
|
||||
{
|
||||
*pos++ = x - x % 32; /* Red. */
|
||||
*pos++ = (x / 32) * 4 + y - y % 32; /* Green. */
|
||||
*pos++ = y - y % 32; /* Blue. */
|
||||
}
|
||||
}
|
||||
|
||||
gtk_main ();
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
||||
gboolean
|
||||
on_darea_expose (GtkWidget *widget,
|
||||
GdkEventExpose *event,
|
||||
gpointer user_data)
|
||||
{
|
||||
gdk_draw_rgb_image (widget->window, widget->style->fg_gc[GTK_STATE_NORMAL],
|
||||
0, 0, IMAGE_WIDTH, IMAGE_HEIGHT,
|
||||
GDK_RGB_DITHER_MAX, rgbbuf, IMAGE_WIDTH * 3);
|
||||
}
|
||||
</programlisting>
|
||||
</example>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GdkColor</term>
|
||||
<listitem><para>The underlying Gdk mechanism for allocating
|
||||
colors.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gdk_rgb_init ##### -->
|
||||
<para>
|
||||
Initializes GdkRgb statically. It may be called more than once with no
|
||||
ill effects. It must, however, be called before any other GdkRgb
|
||||
operations are performed.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The GdkRgb "context" is allocated statically. Thus, GdkRgb may be used
|
||||
to drive only one visual in any given application. GdkRgb
|
||||
automatically selects a best visual and sets its own colormap, if
|
||||
necessary. gdk_rgb_get_visual() and gdk_rgb_get_cmap () retrieve
|
||||
the chosen visual and colormap, respectively.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_rgb_image ##### -->
|
||||
<para>
|
||||
Draws an RGB image in the drawable. This is the core GdkRgb
|
||||
function, and likely the only one you will need to use other than the
|
||||
initialization stuff.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The @rowstride parameter allows for lines to be aligned more flexibly.
|
||||
For example, lines may be allocated to begin on 32-bit boundaries,
|
||||
even if the width of the rectangle is odd. Rowstride is also useful
|
||||
when drawing a subrectangle of a larger image in memory. Finally, to
|
||||
replicate the same line a number of times, the trick of setting
|
||||
@rowstride to 0 is allowed.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
In general, for 0 <= i < @width and 0 <= j < height,
|
||||
the pixel (x + i, y + j) is colored with red value @rgb_buf[@j *
|
||||
@rowstride + @i * 3], green value @rgb_buf[@j * @rowstride + @i * 3 +
|
||||
1], and blue value @rgb_buf[@j * @rowstride + @i * 3 + 2].
|
||||
</para>
|
||||
|
||||
@drawable: The #GdkDrawable to draw in (usually a #GdkWindow).
|
||||
@gc: The graphics context (all Gdk drawing operations require one; its
|
||||
contents are ignored).
|
||||
@x: The x coordinate of the top-left corner in the drawable.
|
||||
@y: The y coordinate of the top-left corner in the drawable.
|
||||
@width: The width of the rectangle to be drawn.
|
||||
@height: The height of the rectangle to be drawn.
|
||||
@dith: A #GdkRgbDither value, selecting the desired dither mode.
|
||||
@rgb_buf: The pixel data, represented as packed 24-bit data.
|
||||
@rowstride: The number of bytes from the start of one row in @rgb_buf to the
|
||||
start of the next.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_rgb_image_dithalign ##### -->
|
||||
<para>
|
||||
Draws an RGB image in the drawable, with an adjustment for dither alignment.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
This function is useful when drawing dithered images into a window
|
||||
that may be scrolled. Pixel (x, y) will be drawn dithered as if its
|
||||
actual location is (x + @xdith, y + @ydith). Thus, if you draw an
|
||||
image into a window using zero dither alignment, then scroll up one
|
||||
pixel, subsequent draws to the window should have @ydith = 1.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Setting the dither alignment correctly allows updating of small parts
|
||||
of the screen while avoiding visible "seams" between the different
|
||||
dither textures.
|
||||
</para>
|
||||
|
||||
@drawable: The #GdkDrawable to draw in (usually a #GdkWindow).
|
||||
@gc: The graphics context.
|
||||
@x: The x coordinate of the top-left corner in the drawable.
|
||||
@y: The y coordinate of the top-left corner in the drawable.
|
||||
@width: The width of the rectangle to be drawn.
|
||||
@height: The height of the rectangle to be drawn.
|
||||
@dith: A #GdkRgbDither value, selecting the desired dither mode.
|
||||
@rgb_buf: The pixel data, represented as packed 24-bit data.
|
||||
@rowstride: The number of bytes from the start of one row in @rgb_buf to the
|
||||
start of the next.
|
||||
@xdith: An x offset for dither alignment.
|
||||
@ydith: A y offset for dither alignment.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_indexed_image ##### -->
|
||||
<para>
|
||||
Draws an indexed image in the drawable, using a #GdkRgbCmap to assign
|
||||
actual colors to the color indices.
|
||||
</para>
|
||||
|
||||
@drawable: The #GdkDrawable to draw in (usually a #GdkWindow).
|
||||
@gc: The graphics context.
|
||||
@x: The x coordinate of the top-left corner in the drawable.
|
||||
@y: The y coordinate of the top-left corner in the drawable.
|
||||
@width: The width of the rectangle to be drawn.
|
||||
@height: The height of the rectangle to be drawn.
|
||||
@dith: A #GdkRgbDither value, selecting the desired dither mode.
|
||||
@buf: The pixel data, represented as 8-bit color indices.
|
||||
@rowstride: The number of bytes from the start of one row in @buf to the
|
||||
start of the next.
|
||||
@cmap: The #GdkRgbCmap used to assign colors to the color indices.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_gray_image ##### -->
|
||||
<para>
|
||||
Draws a grayscale image in the drawable.
|
||||
|
||||
</para>
|
||||
|
||||
@drawable: The #GdkDrawable to draw in (usually a #GdkWindow).
|
||||
@gc: The graphics context.
|
||||
@x: The x coordinate of the top-left corner in the drawable.
|
||||
@y: The y coordinate of the top-left corner in the drawable.
|
||||
@width: The width of the rectangle to be drawn.
|
||||
@height: The height of the rectangle to be drawn.
|
||||
@dith: A #GdkRgbDither value, selecting the desired dither mode.
|
||||
@buf: The pixel data, represented as 8-bit gray values.
|
||||
@rowstride: The number of bytes from the start of one row in @buf to the
|
||||
start of the next.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_draw_rgb_32_image ##### -->
|
||||
<para>
|
||||
Draws a padded RGB image in the drawable. The image is stored as one
|
||||
pixel per 32-bit word. It is laid out as a red byte, a green byte, a
|
||||
blue byte, and a padding byte.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
It's unlikely that this function will give significant performance
|
||||
gains in practice. In my experience, the performance gain from having
|
||||
pixels aligned to 32-bit boundaries is cancelled out by the increased
|
||||
memory bandwidth.
|
||||
</para>
|
||||
|
||||
@drawable: The #GdkDrawable to draw in (usually a #GdkWindow).
|
||||
@gc: The graphics context.
|
||||
@x: The x coordinate of the top-left corner in the drawable.
|
||||
@y: The y coordinate of the top-left corner in the drawable.
|
||||
@width: The width of the rectangle to be drawn.
|
||||
@height: The height of the rectangle to be drawn.
|
||||
@dith: A #GdkRgbDither value, selecting the desired dither mode.
|
||||
@buf: The pixel data, represented as padded 32-bit data.
|
||||
@rowstride: The number of bytes from the start of one row in @buf to the
|
||||
start of the next.
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkRgbDither ##### -->
|
||||
<para>
|
||||
|
||||
Selects whether or not GdkRgb applies dithering
|
||||
to the image on display. There are three values:
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
||||
<listitem>
|
||||
<para>
|
||||
%GDK_RGB_DITHER_NONE: Never use dithering.
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>
|
||||
%GDK_RGB_DITHER_NORMAL: Use dithering in 8 bits per pixel (and below)
|
||||
only.
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>
|
||||
%GDK_RGB_DITHER_MAX: Use dithering in 16 bits per pixel and below.
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
Since GdkRgb currently only handles images with 8 bits per component,
|
||||
dithering on 24 bit per pixel displays is a moot point.
|
||||
</para>
|
||||
|
||||
@GDK_RGB_DITHER_NONE:
|
||||
@GDK_RGB_DITHER_NORMAL:
|
||||
@GDK_RGB_DITHER_MAX:
|
||||
|
||||
<!-- ##### FUNCTION gdk_rgb_cmap_new ##### -->
|
||||
<para>
|
||||
Creates a new #GdkRgbCmap structure. The cmap maps color indexes to
|
||||
RGB colors. If @n_colors is less than 256, then images containing
|
||||
color values greater than or equal to @n_colors will produce undefined
|
||||
results, including possibly segfaults.
|
||||
</para>
|
||||
|
||||
@colors: The colors, represented as 0xRRGGBB integer values.
|
||||
@n_colors: The number of colors in the cmap.
|
||||
@Returns: The newly created #GdkRgbCmap
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_rgb_cmap_free ##### -->
|
||||
<para>
|
||||
Frees the memory associated with a #GdkRgbCmap created by gdk_rgb_cmap_new().
|
||||
</para>
|
||||
|
||||
@cmap: The #GdkRgbCmap to free.
|
||||
|
||||
|
||||
<!-- ##### STRUCT GdkRgbCmap ##### -->
|
||||
<para>
|
||||
A private data structure which maps color indices to actual RGB
|
||||
colors. This is used only for gdk_draw_indexed_image().
|
||||
</para>
|
||||
|
||||
@colors:
|
||||
@lut:
|
||||
|
||||
<!-- ##### FUNCTION gdk_rgb_gc_set_foreground ##### -->
|
||||
<para>
|
||||
Sets the foreground color in @gc to the specified color (or the
|
||||
closest approximation, in the case of limited visuals).
|
||||
</para>
|
||||
|
||||
@gc: The #GdkGC to modify.
|
||||
@rgb: The color, represented as a 0xRRGGBB integer value.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_rgb_gc_set_background ##### -->
|
||||
<para>
|
||||
Sets the background color in @gc to the specified color (or the
|
||||
closest approximation, in the case of limited visuals).
|
||||
</para>
|
||||
|
||||
@gc: The #GdkGC to modify.
|
||||
@rgb: The color, represented as a 0xRRGGBB integer value.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_rgb_xpixel_from_rgb ##### -->
|
||||
<para>
|
||||
Finds the X pixel closest in color to the @rgb color specified. This
|
||||
value may be used to set the <structfield>pixel</structfield> field of
|
||||
a #GdkColor struct.
|
||||
</para>
|
||||
|
||||
@rgb: The color, represented as a 0xRRGGBB integer value.
|
||||
@Returns: The X pixel value.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_rgb_set_install ##### -->
|
||||
<para>
|
||||
If @install is TRUE, directs GdkRgb to always install a new "private"
|
||||
colormap rather than trying to find a best fit with the colors already
|
||||
allocated. Ordinarily, GdkRgb will install a colormap only if a
|
||||
sufficient cube cannot be allocated.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
A private colormap has more colors, leading to better quality display,
|
||||
but also leads to the dreaded "colormap flashing" effect.
|
||||
</para>
|
||||
|
||||
@install: TRUE to set install mode.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_rgb_set_min_colors ##### -->
|
||||
<para>
|
||||
Sets the minimum number of colors for the color cube. Generally,
|
||||
GdkRgb tries to allocate the largest color cube it can. If it can't
|
||||
allocate a color cube at least as large as @min_colors, it installs a
|
||||
private colormap.
|
||||
</para>
|
||||
|
||||
@min_colors: The minimum number of colors accepted.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_rgb_get_visual ##### -->
|
||||
<para>
|
||||
Gets the visual chosen by GdkRgb. This visual and the corresponding
|
||||
colormap should be used when creating windows that will be drawn in by GdkRgb.
|
||||
</para>
|
||||
|
||||
@Returns: The #GdkVisual chosen by GdkRgb.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_rgb_get_cmap ##### -->
|
||||
<para>
|
||||
Gets the colormap set by GdkRgb. This colormap and the corresponding
|
||||
visual should be used when creating windows that will be drawn in by GdkRgb.
|
||||
</para>
|
||||
|
||||
@Returns: The #GdkColormap set by GdkRgb.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_rgb_ditherable ##### -->
|
||||
<para>
|
||||
Determine whether the visual is ditherable. This function may be
|
||||
useful for presenting a user interface choice to the user about which
|
||||
dither mode is desired; if the display is not ditherable, it may make
|
||||
sense to gray out or hide the corresponding UI widget.
|
||||
</para>
|
||||
|
||||
@Returns: TRUE if the visual is ditherable.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_rgb_set_verbose ##### -->
|
||||
<para>
|
||||
Sets the "verbose" flag. This is generally only useful for debugging.
|
||||
</para>
|
||||
|
||||
@verbose: TRUE if verbose messages are desired.
|
||||
|
||||
|
||||
@@ -1,185 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Selections
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
functions for transfering data via the X selection mechanism.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The X selection mechanism provides a way to transfer
|
||||
arbitrary chunks of data between programs.
|
||||
A <firstterm>selection</firstterm> is a essentially
|
||||
a named clipboard, identified by a string interned
|
||||
as a #GdkAtom. By claiming ownership of a selection,
|
||||
an application indicates that it will be responsible
|
||||
for supplying its contents. The most common
|
||||
selections are <literal>PRIMARY</literal> and
|
||||
<literal>CLIPBOARD</literal>.
|
||||
</para>
|
||||
<para>
|
||||
The contents of a selection can be represented in
|
||||
a number of formats, called <firstterm>targets</firstterm>.
|
||||
Each target is identified by an atom. A list of
|
||||
all possible targets supported by the selection owner
|
||||
can be retrieved by requesting the special target
|
||||
<literal>TARGETS</literal>. When a selection is
|
||||
retrieved, the data is accompanied by a type
|
||||
(an atom), and a format (an integer, representing
|
||||
the number of bits per item).
|
||||
See <link linkend="gdk-Properties-and-Atoms">Properties and Atoms</link>
|
||||
for more information.
|
||||
</para>
|
||||
<para>
|
||||
The functions in this section only contain the lowlevel
|
||||
parts of the selection protocol. A considerably more
|
||||
complicated implementation is needed on top of this.
|
||||
GTK+ contains such an implementation in the functions
|
||||
in <literal>gtkselection.h</literal> and programmers
|
||||
should use those functions instead of the ones presented
|
||||
here. If you plan to implement selection handling
|
||||
directly on top of the functions here, you should refer
|
||||
to the X Inter-client Communication Conventions Manual
|
||||
(ICCCM).
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GdkSelection ##### -->
|
||||
<para>
|
||||
The #GdkSelection enumeration contains predefined
|
||||
atom values for several common selections.
|
||||
</para>
|
||||
|
||||
@GDK_SELECTION_PRIMARY: The primary X selection. Programs
|
||||
typically claim this selection when the user
|
||||
selects text and paste its contents in response
|
||||
to a middle button press.
|
||||
@GDK_SELECTION_SECONDARY: An additional X selection.
|
||||
|
||||
<!-- ##### ENUM GdkSelectionType ##### -->
|
||||
<para>
|
||||
The #GdkSelectionType enumeration contains predefined
|
||||
atom values used to represent the types of data transferred
|
||||
in response to a request for a target. See the
|
||||
ICCCM for details about what data should be transferred
|
||||
for each of these types. Other atoms can be used,
|
||||
and the recommended practice for GTK+ is to to use mime
|
||||
types for this purpose. However, supporting these types
|
||||
may be useful for compatibility with older programs.
|
||||
</para>
|
||||
|
||||
@GDK_SELECTION_TYPE_ATOM: An atom. (format 32)
|
||||
@GDK_SELECTION_TYPE_BITMAP: A bitmap ID. (format 32)
|
||||
@GDK_SELECTION_TYPE_COLORMAP: A colormap ID. (format 32)
|
||||
@GDK_SELECTION_TYPE_DRAWABLE: A drawable ID. (format 32)
|
||||
@GDK_SELECTION_TYPE_INTEGER: An integer. (format 32)
|
||||
@GDK_SELECTION_TYPE_PIXMAP: A pixmap ID. (format 32)
|
||||
@GDK_SELECTION_TYPE_WINDOW: A window ID. (format 32)
|
||||
@GDK_SELECTION_TYPE_STRING: A string encoded
|
||||
in ISO Latin-1. (With the additional of <symbol>TAB</symbol>
|
||||
and <symbol>NEWLINE</symbol>.) (format 8)
|
||||
|
||||
<!-- ##### ENUM GdkTarget ##### -->
|
||||
<para>
|
||||
The #GdkTarget enumeration contains predefined atom values which are
|
||||
used to describe possible targets for a selection. Other atoms can be
|
||||
used, and the recommended practice for GTK+ is to to use mime types
|
||||
for this purpose. However, supporting these types may be useful for
|
||||
compatibility with older programs.
|
||||
</para>
|
||||
|
||||
@GDK_TARGET_BITMAP: A bitmap ID.
|
||||
@GDK_TARGET_COLORMAP: A colormap ID.
|
||||
@GDK_TARGET_DRAWABLE: A drawable ID.
|
||||
@GDK_TARGET_PIXMAP: A pixmap ID.
|
||||
@GDK_TARGET_STRING: A string encoded in ISO Latin-1.
|
||||
(With the additional of <symbol>TAB</symbol>
|
||||
and <symbol>NEWLINE</symbol>.)
|
||||
|
||||
<!-- ##### FUNCTION gdk_selection_owner_set ##### -->
|
||||
<para>
|
||||
Set the owner of the given selection.
|
||||
</para>
|
||||
|
||||
@owner: a #GdkWindow or NULL to indicate that the
|
||||
the owner for the given should be unset.
|
||||
@selection: an atom identifying a selection.
|
||||
@time: timestamp to use when setting the selection.
|
||||
If this is older than the timestamp given last
|
||||
time the owner was set for the given selection, the
|
||||
request will be ignored.
|
||||
@send_event: if %TRUE, and the new owner is different
|
||||
from the current owner, the current owner
|
||||
will be sent a SelectionClear event.
|
||||
@Returns: %TRUE if the selection owner was succesfully
|
||||
changed to @owner, otherwise %FALSE.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_selection_owner_get ##### -->
|
||||
<para>
|
||||
Determine the owner of the given selection.
|
||||
</para>
|
||||
|
||||
@selection: an atom indentifying a selection.
|
||||
@Returns: if there is a selection owner for this window,
|
||||
and it is a window known to the current process,
|
||||
the #GdkWindow that owns the selection, otherwise
|
||||
NULL. Note that the return value may be owned
|
||||
by a different process if a foreign window
|
||||
was previously created for that window, but
|
||||
a new foreign window will never be created by
|
||||
this call.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_selection_convert ##### -->
|
||||
<para>
|
||||
Retrieve the contents of a selection in a given
|
||||
form.
|
||||
</para>
|
||||
|
||||
@requestor: a #GdkWindow.
|
||||
@selection: an atom identifying the selection to get the
|
||||
contents of.
|
||||
@target: the form in which to retrieve the selection.
|
||||
@time: the timestamp to use when retrieving the
|
||||
selection. The selection owner may refuse the
|
||||
request if it did not own the selection at
|
||||
the time indicated by the timestamp.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_selection_property_get ##### -->
|
||||
<para>
|
||||
Retrieve selection data that was stored by the selection
|
||||
data in response to a call to gdk_selection_convert()
|
||||
</para>
|
||||
|
||||
@requestor: the window on which the data is stored
|
||||
@data: location to store a pointer to the retrieved data.
|
||||
If the retrieval failed, NULL we be stored here, otherwise, it
|
||||
will be non-NULL and the returned data should be freed with g_free()
|
||||
when you are finished using it. The length of the
|
||||
allocated memory is one more than the the length
|
||||
of the returned data, and the final byte will always
|
||||
be zero, to ensure null-termination of strings.
|
||||
@prop_type: location to store the type of the property.
|
||||
@prop_format: location to store the format of the property.
|
||||
@Returns: the length of the retrieved data.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_selection_send_notify ##### -->
|
||||
<para>
|
||||
Send a response to SelectionRequest event.
|
||||
</para>
|
||||
|
||||
@requestor: window to which to deliver response.
|
||||
@selection: selection that was requested.
|
||||
@target: target that was selected.
|
||||
@property: property in which the selection owner stored the
|
||||
data, or %GDK_NONE to indicate that the request
|
||||
was rejected.
|
||||
@time: timestamp.
|
||||
|
||||
|
||||
@@ -1,50 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Threads
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### VARIABLE gdk_threads_mutex ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GDK_THREADS_ENTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO GDK_THREADS_LEAVE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_threads_enter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_threads_leave ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
@@ -1,391 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Visuals
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
manipulation of visuals.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The way that the data stored on the screen is stored
|
||||
in memory can vary considerably between different X
|
||||
servers; some X servers even support multiple formats
|
||||
used simultaneously. An X <firstterm>visual</firstterm>
|
||||
represents a particular format for screen data.
|
||||
It includes information about the number of bits
|
||||
used for each color, the way the bits are translated
|
||||
into an RGB value for display, and the way the bits
|
||||
are stored in memory.
|
||||
</para>
|
||||
<para>
|
||||
There are several standard visuals. The visual returned
|
||||
by gdk_visual_get_system() is the system's default
|
||||
visual. gdk_rgb_get_visual() return the visual most
|
||||
suited to displaying full-color image data. If you
|
||||
use the calls in GdkRGB, you should create your windows
|
||||
using this visual (and the colormap returned by
|
||||
gdk_rgb_get_colormap()).
|
||||
</para>
|
||||
<para>
|
||||
A number of functions are provided for determining
|
||||
the "best" available visual. For the purposes of
|
||||
making this determination, higher bit depths are
|
||||
considered better, and for visuals of the same
|
||||
bit depth, %GDK_VISUAL_PSEUDO_COLOR is preferred at
|
||||
8bpp, otherwise, the visual types are ranked in the
|
||||
order of (highest to lowest) %GDK_VISUAL_DIRECT_COLOR,
|
||||
%GDK_VISUAL_TRUE_COLOR, %GDK_VISUAL_PSEUDO_COLOR,
|
||||
%GDK_VISUAL_STATIC_COLOR, %GDK_VISUAL_GRAYSCALE,
|
||||
then %GDK_VISUAL_STATIC_GRAY.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GdkVisual ##### -->
|
||||
<para>
|
||||
The GdkVisual structure contains information about
|
||||
a particular visual. It contains the following
|
||||
public fields.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry><structfield>type</structfield></entry>
|
||||
<entry>The type of this visual.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>depth</structfield></entry>
|
||||
<entry>The number of bits per pixel.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>byte_order</structfield></entry>
|
||||
<entry>The byte-order for this visual.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>colormap_size</structfield></entry>
|
||||
<entry>The number of entries in the colormap, for
|
||||
visuals of type GDK_VISUAL_PSEUDO_COLOR or
|
||||
GDK_VISUAL_GRAY_SCALE. For other visual types, it
|
||||
is the number of possible levels per color component.
|
||||
If the visual has different numbers of levels for
|
||||
different components, the value of this field is
|
||||
undefined.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>bits_per_rgb</structfield></entry>
|
||||
<entry>
|
||||
The number of significant bits per red, green, or blue
|
||||
when specifying colors for this visual. (For instance,
|
||||
for gdk_colormap_alloc_color())
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>red_mask</structfield></entry>
|
||||
<entry>
|
||||
A mask giving the bits in a pixel value that
|
||||
correspond to the red field. Significant only for
|
||||
%GDK_VISUAL_PSEUDOCOLOR and %GDK_VISUAL_DIRECTCOLOR.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>red_shift, red_prec</structfield></entry>
|
||||
<entry>
|
||||
The <structfield>red_shift</structfield> and
|
||||
<structfield>red_prec</structfield> give an alternate presentation
|
||||
of the information in <structfield>red_mask</structfield>.
|
||||
<structfield>red_mask</structfield> is a contiguous sequence
|
||||
of <structfield>red_prec</structfield> starting at bit
|
||||
number <structfield>red_shift</structfield>. For example,
|
||||
<xref linkend="rgbmask"> shows constructing a pixel value
|
||||
out of three 16 bit color values.
|
||||
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>green_mask</structfield></entry>
|
||||
<entry>
|
||||
A mask giving the bits in a pixel value that
|
||||
correspond to the green field.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>green_shift, green_prec</structfield></entry>
|
||||
<entry>
|
||||
The <structfield>green_shift</structfield> and
|
||||
<structfield>green_prec</structfield> give an alternate presentation
|
||||
of the information in <structfield>green_mask</structfield>.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>blue_mask</structfield></entry>
|
||||
<entry>
|
||||
A mask giving the bits in a pixel value that
|
||||
correspond to the blue field.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><structfield>blue_shift, blue_prec</structfield></entry>
|
||||
<entry>
|
||||
The <structfield>blue_shift</structfield> and
|
||||
<structfield>blue_prec</structfield> give an alternate presentation
|
||||
of the information in <structfield>blue_mask</structfield>.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
<figure float="1" id="rgbmask">
|
||||
<title>Constructing a pixel value from components</title>
|
||||
<programlisting>
|
||||
guint
|
||||
pixel_from_rgb (GdkVisual *visual,
|
||||
guchar r, guchar b, guchar g)
|
||||
{
|
||||
return ((r >> (16 - visual->red_prec)) << visual->red_shift) |
|
||||
((g >> (16 - visual->green_prec)) << visual->green_shift) |
|
||||
((r >> (16 - visual->blue_prec)) << visual->blue_shift);
|
||||
}
|
||||
</programlisting>
|
||||
</figure>
|
||||
|
||||
@type:
|
||||
@depth:
|
||||
@byte_order:
|
||||
@colormap_size:
|
||||
@bits_per_rgb:
|
||||
@red_mask:
|
||||
@red_shift:
|
||||
@red_prec:
|
||||
@green_mask:
|
||||
@green_shift:
|
||||
@green_prec:
|
||||
@blue_mask:
|
||||
@blue_shift:
|
||||
@blue_prec:
|
||||
|
||||
<!-- ##### ENUM GdkVisualType ##### -->
|
||||
<para>
|
||||
A set of values that describe the manner in which the
|
||||
pixel values for a visual are converted into RGB
|
||||
values for display.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="enum">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>GDK_VISUAL_STATIC_GRAY</entry>
|
||||
<entry>Each pixel value indexes a grayscale value directly.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_VISUAL_GRAYSCALE</entry>
|
||||
<entry>Each pixel is an index into a color map that maps
|
||||
pixel values into grayscale values. The color map can
|
||||
be changed by an application.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_VISUAL_STATIC_COLOR</entry>
|
||||
<entry>Each pixel value is an index into a predefined,
|
||||
unmodifiable color map that maps pixel values into
|
||||
rgb values.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_VISUAL_PSEUDO_COLOR</entry>
|
||||
<entry>Each pixel is an index into a color map that maps
|
||||
pixel values into rgb values. The color map can
|
||||
be changed by an application.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_TRUE_COLOR</entry>
|
||||
<entry>Each pixel value directly contains red, green,
|
||||
and blue components. The <structfield>red_mask</structfield>,
|
||||
<structfield>green_mask</structfield>, and
|
||||
<structfield>blue_mask</structfield> fields of the #GdkVisual
|
||||
structure describe how the components are assembled into
|
||||
a pixel value.
|
||||
.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_DIRECT_COLOR</entry>
|
||||
<entry>Each pixel value contains red, green, and blue
|
||||
components as for %GDK_TRUE_COLOR, but the components
|
||||
are mapped via a color table into the final output
|
||||
table instead of being converted directly..</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@GDK_VISUAL_STATIC_GRAY:
|
||||
@GDK_VISUAL_GRAYSCALE:
|
||||
@GDK_VISUAL_STATIC_COLOR:
|
||||
@GDK_VISUAL_PSEUDO_COLOR:
|
||||
@GDK_VISUAL_TRUE_COLOR:
|
||||
@GDK_VISUAL_DIRECT_COLOR:
|
||||
|
||||
<!-- ##### ENUM GdkByteOrder ##### -->
|
||||
<para>
|
||||
A set of values describing the possible byte-orders
|
||||
for storing pixel values in memory.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="enum">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>GDK_LSB_FIRST</entry>
|
||||
<entry>The values are stored with the least-significant byte
|
||||
first. For instance, the 32-bit value 0xffeecc would be stored
|
||||
in memory as 0xcc, 0xee, 0xff, 0x00.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GDK_MSB_FIRST</entry>
|
||||
<entry>The values are stored with the least-significant byte
|
||||
first. For instance, the 32-bit value 0xffeecc would be stored
|
||||
in memory as 0xff, 0xee, 0xcc, 0x00.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@GDK_LSB_FIRST:
|
||||
@GDK_MSB_FIRST:
|
||||
|
||||
<!-- ##### FUNCTION gdk_query_depths ##### -->
|
||||
<para>
|
||||
Lists the available color depths. The returned values
|
||||
are pointers to static storage and should not be
|
||||
modified or freed.
|
||||
</para>
|
||||
|
||||
@depths: a location to store a pointer to an array
|
||||
holding the available color depths.
|
||||
@count: a location to store the number of values in @depths.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_query_visual_types ##### -->
|
||||
<para>
|
||||
Lists the available visual types. The returned values
|
||||
are pointers to static storage and should not be
|
||||
modified or freed.
|
||||
</para>
|
||||
|
||||
@visual_types: a location to store a pointer to an
|
||||
array holding the available visual types.
|
||||
@count: a location to store the number of values in @visual types.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_list_visuals ##### -->
|
||||
<para>
|
||||
Lists the available visuals.
|
||||
</para>
|
||||
|
||||
@Returns: A #GList of the available visuals. The list
|
||||
should be freed this list with g_list_free().
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_visual_get_best_depth ##### -->
|
||||
<para>
|
||||
Returns the best available color depth.
|
||||
</para>
|
||||
|
||||
@Returns: the best available color depth.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_visual_get_best_type ##### -->
|
||||
<para>
|
||||
Returns the best available visual type.
|
||||
</para>
|
||||
|
||||
@Returns: the best available visual type.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_visual_get_system ##### -->
|
||||
<para>
|
||||
Returns the system's default visual.
|
||||
</para>
|
||||
|
||||
@Returns: the system's default visual.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_visual_get_best ##### -->
|
||||
<para>
|
||||
Returns the best available visual.
|
||||
</para>
|
||||
|
||||
@Returns: the best available visual.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_visual_get_best_with_depth ##### -->
|
||||
<para>
|
||||
Returns the best available visual with a certain depth.
|
||||
</para>
|
||||
|
||||
@depth: the desired color depth
|
||||
@Returns: the best available visual with @depth bits per pixel
|
||||
or %NULL if no visuals with that type are available.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_visual_get_best_with_type ##### -->
|
||||
<para>
|
||||
Returns the best available visual of a certain visual type.
|
||||
</para>
|
||||
|
||||
@visual_type: the desired visual type.
|
||||
@Returns: the visual of the given type with the highest depth
|
||||
or %NULL if no visuals of that type are available.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_visual_get_best_with_both ##### -->
|
||||
<para>
|
||||
Returns the best available visual
|
||||
</para>
|
||||
|
||||
@depth: the desired visual type.
|
||||
@visual_type: the desired depth.
|
||||
@Returns: the best available visual with the given depth
|
||||
and visual type, or %NULL if no matching visuals are
|
||||
available.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_visual_ref ##### -->
|
||||
<para>
|
||||
In theory, increases the reference count of a visual. However,
|
||||
the set of visuals is determined statically when GTK+ is
|
||||
initialized, so this operation does nothing.
|
||||
</para>
|
||||
|
||||
@visual: a #GdkVisual.
|
||||
@Returns: @visual.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_visual_unref ##### -->
|
||||
<para>
|
||||
In theory, decreases the reference count of a visual. Like
|
||||
gdk_visual_ref(), this operation does nothing.
|
||||
</para>
|
||||
|
||||
@visual: a #GdkVisual.
|
||||
|
||||
|
||||
@@ -1,783 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Windows
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GdkWindowAttr ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@title:
|
||||
@event_mask:
|
||||
@x:
|
||||
@y:
|
||||
@width:
|
||||
@height:
|
||||
@wclass:
|
||||
@visual:
|
||||
@colormap:
|
||||
@window_type:
|
||||
@cursor:
|
||||
@wmclass_name:
|
||||
@wmclass_class:
|
||||
@override_redirect:
|
||||
|
||||
<!-- ##### STRUCT GdkWindow ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@user_data:
|
||||
|
||||
<!-- ##### ENUM GdkWindowType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_WINDOW_ROOT:
|
||||
@GDK_WINDOW_TOPLEVEL:
|
||||
@GDK_WINDOW_CHILD:
|
||||
@GDK_WINDOW_DIALOG:
|
||||
@GDK_WINDOW_TEMP:
|
||||
@GDK_WINDOW_PIXMAP:
|
||||
@GDK_WINDOW_FOREIGN:
|
||||
|
||||
<!-- ##### ENUM GdkWindowClass ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_INPUT_OUTPUT:
|
||||
@GDK_INPUT_ONLY:
|
||||
|
||||
<!-- ##### ENUM GdkWindowAttributesType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_WA_TITLE:
|
||||
@GDK_WA_X:
|
||||
@GDK_WA_Y:
|
||||
@GDK_WA_CURSOR:
|
||||
@GDK_WA_COLORMAP:
|
||||
@GDK_WA_VISUAL:
|
||||
@GDK_WA_WMCLASS:
|
||||
@GDK_WA_NOREDIR:
|
||||
|
||||
<!-- ##### ENUM GdkWindowHints ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_HINT_POS:
|
||||
@GDK_HINT_MIN_SIZE:
|
||||
@GDK_HINT_MAX_SIZE:
|
||||
@GDK_HINT_BASE_SIZE:
|
||||
@GDK_HINT_ASPECT:
|
||||
@GDK_HINT_RESIZE_INC:
|
||||
|
||||
<!-- ##### STRUCT GdkGeometry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@min_width:
|
||||
@min_height:
|
||||
@max_width:
|
||||
@max_height:
|
||||
@base_width:
|
||||
@base_height:
|
||||
@width_inc:
|
||||
@height_inc:
|
||||
@min_aspect:
|
||||
@max_aspect:
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parent:
|
||||
@attributes:
|
||||
@attributes_mask:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_destroy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_ref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_unref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_at_pointer ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@win_x:
|
||||
@win_y:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_show ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_hide ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_is_visible ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_is_viewable ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_withdraw ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_move ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@x:
|
||||
@y:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_resize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@width:
|
||||
@height:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_move_resize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@x:
|
||||
@y:
|
||||
@width:
|
||||
@height:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_reparent ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@new_parent:
|
||||
@x:
|
||||
@y:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_clear ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_clear_area ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@x:
|
||||
@y:
|
||||
@width:
|
||||
@height:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_clear_area_e ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@x:
|
||||
@y:
|
||||
@width:
|
||||
@height:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_copy_area ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@gc:
|
||||
@x:
|
||||
@y:
|
||||
@source_window:
|
||||
@source_x:
|
||||
@source_y:
|
||||
@width:
|
||||
@height:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_raise ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_lower ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_register_dnd ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_user_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@user_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_override_redirect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@override_redirect:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_add_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@function:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_remove_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@function:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GdkFilterFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@xevent:
|
||||
@event:
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkFilterReturn ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_FILTER_CONTINUE:
|
||||
@GDK_FILTER_TRANSLATE:
|
||||
@GDK_FILTER_REMOVE:
|
||||
|
||||
<!-- ##### TYPEDEF GdkXEvent ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_shape_combine_mask ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@shape_mask:
|
||||
@offset_x:
|
||||
@offset_y:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_child_shapes ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_merge_child_shapes ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_static_gravities ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@use_static:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_hints ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@x:
|
||||
@y:
|
||||
@min_width:
|
||||
@min_height:
|
||||
@max_width:
|
||||
@max_height:
|
||||
@flags:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_title ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@title:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_background ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@color:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_back_pixmap ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@pixmap:
|
||||
@parent_relative:
|
||||
|
||||
|
||||
<!-- ##### MACRO GDK_PARENT_RELATIVE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_cursor ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@cursor:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_colormap ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@colormap:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_user_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_geometry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@x:
|
||||
@y:
|
||||
@width:
|
||||
@height:
|
||||
@depth:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_geometry_hints ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@geometry:
|
||||
@flags:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_position ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@x:
|
||||
@y:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_root_origin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@x:
|
||||
@y:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_size ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@width:
|
||||
@height:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_visual ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_colormap ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_origin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@x:
|
||||
@y:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_deskrelative_origin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@x:
|
||||
@y:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_pointer ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@x:
|
||||
@y:
|
||||
@mask:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkModifierType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_SHIFT_MASK:
|
||||
@GDK_LOCK_MASK:
|
||||
@GDK_CONTROL_MASK:
|
||||
@GDK_MOD1_MASK:
|
||||
@GDK_MOD2_MASK:
|
||||
@GDK_MOD3_MASK:
|
||||
@GDK_MOD4_MASK:
|
||||
@GDK_MOD5_MASK:
|
||||
@GDK_BUTTON1_MASK:
|
||||
@GDK_BUTTON2_MASK:
|
||||
@GDK_BUTTON3_MASK:
|
||||
@GDK_BUTTON4_MASK:
|
||||
@GDK_BUTTON5_MASK:
|
||||
@GDK_RELEASE_MASK:
|
||||
@GDK_MODIFIER_MASK:
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_parent ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_toplevel ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_children ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_events ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_events ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@event_mask:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_icon ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@icon_window:
|
||||
@pixmap:
|
||||
@mask:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_icon_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@name:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_transient_for ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@leader:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_role ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@role:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_group ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@leader:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_decorations ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@decorations:
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkWMDecoration ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_DECOR_ALL:
|
||||
@GDK_DECOR_BORDER:
|
||||
@GDK_DECOR_RESIZEH:
|
||||
@GDK_DECOR_TITLE:
|
||||
@GDK_DECOR_MENU:
|
||||
@GDK_DECOR_MINIMIZE:
|
||||
@GDK_DECOR_MAXIMIZE:
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_set_functions ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@window:
|
||||
@functions:
|
||||
|
||||
|
||||
<!-- ##### ENUM GdkWMFunction ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GDK_FUNC_ALL:
|
||||
@GDK_FUNC_RESIZE:
|
||||
@GDK_FUNC_MOVE:
|
||||
@GDK_FUNC_MINIMIZE:
|
||||
@GDK_FUNC_MAXIMIZE:
|
||||
@GDK_FUNC_CLOSE:
|
||||
|
||||
<!-- ##### FUNCTION gdk_window_get_toplevels ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GdkDrawable ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@user_data:
|
||||
|
||||
<!-- ##### FUNCTION gdk_drawable_set_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@drawable:
|
||||
@key:
|
||||
@data:
|
||||
@destroy_func:
|
||||
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
Makefile
|
||||
Makefile.in
|
||||
sgml
|
||||
html
|
||||
gtk-decl-list.txt
|
||||
gtk-unused.txt
|
||||
@@ -1,59 +0,0 @@
|
||||
## Process this file with automake to produce Makefile.in
|
||||
|
||||
# The name of the module.
|
||||
DOC_MODULE=gtk
|
||||
|
||||
# The top-level SGML file.
|
||||
DOC_MAIN_SGML_FILE=gtk-docs.sgml
|
||||
|
||||
# We could alternatively use this for using installed headers.
|
||||
INCLUDE_DIR=`gtk-config --prefix`/include/gtk
|
||||
|
||||
|
||||
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
|
||||
|
||||
CFLAGS=`gtk-config --cflags`
|
||||
LDFLAGS=`gtk-config --libs`
|
||||
|
||||
scan:
|
||||
CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) gtkdoc-scanobj --module=$(DOC_MODULE)
|
||||
gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers='gtkintl.h' $(INCLUDE_DIR)/*.h
|
||||
|
||||
templates: scan
|
||||
gtkdoc-mktmpl --module=$(DOC_MODULE)
|
||||
|
||||
sgml:
|
||||
gtkdoc-mkdb --module=$(DOC_MODULE)
|
||||
|
||||
html:
|
||||
if ! test -d html ; then mkdir html ; fi
|
||||
-cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
|
||||
|
||||
clean-local:
|
||||
rm -f *~ *.bak *.hierarchy *.signals *.args *-unused.txt
|
||||
|
||||
maintainer-clean-local: clean
|
||||
rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
|
||||
|
||||
install-data-local:
|
||||
install -d -m 0755 $(TARGET_DIR)
|
||||
install -m 0644 html/*.html $(TARGET_DIR)
|
||||
install -m 0644 html/index.sgml $(TARGET_DIR)
|
||||
gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)
|
||||
|
||||
EXTRA_DIST = \
|
||||
$(DOC_MAIN_SGML_FILE) \
|
||||
$(DOC_MODULE)-sections.txt \
|
||||
gtk-overrides.txt \
|
||||
gtk-decl.txt \
|
||||
gtk.hierarchy \
|
||||
gtk.signals \
|
||||
gtk.args \
|
||||
gtk.types \
|
||||
objects_grouped.sgml
|
||||
|
||||
dist-hook:
|
||||
mkdir $(distdir)/tmpl
|
||||
cp -p tmpl/*.sgml $(distdir)/tmpl
|
||||
|
||||
.PHONY : html sgml templates scan
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,293 +0,0 @@
|
||||
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
|
||||
<!entity hash "#">
|
||||
<!entity GtkAccelLabel SYSTEM "sgml/gtkaccellabel.sgml">
|
||||
<!entity GtkAdjustment SYSTEM "sgml/gtkadjustment.sgml">
|
||||
<!entity GtkAlignment SYSTEM "sgml/gtkalignment.sgml">
|
||||
<!entity GtkArrow SYSTEM "sgml/gtkarrow.sgml">
|
||||
<!entity GtkAspectFrame SYSTEM "sgml/gtkaspectframe.sgml">
|
||||
<!entity GtkButtonBox SYSTEM "sgml/gtkbbox.sgml">
|
||||
<!entity GtkBin SYSTEM "sgml/gtkbin.sgml">
|
||||
<!entity GtkBox SYSTEM "sgml/gtkbox.sgml">
|
||||
<!entity GtkButton SYSTEM "sgml/gtkbutton.sgml">
|
||||
<!entity GtkCalendar SYSTEM "sgml/gtkcalendar.sgml">
|
||||
<!entity GtkCheckButton SYSTEM "sgml/gtkcheckbutton.sgml">
|
||||
<!entity GtkCheckMenuItem SYSTEM "sgml/gtkcheckmenuitem.sgml">
|
||||
<!entity GtkCList SYSTEM "sgml/gtkclist.sgml">
|
||||
<!entity GtkColorSelection SYSTEM "sgml/gtkcolorsel.sgml">
|
||||
<!entity GtkColorSelectionDialog SYSTEM "sgml/gtkcolorseldlg.sgml">
|
||||
<!entity GtkCombo SYSTEM "sgml/gtkcombo.sgml">
|
||||
<!entity GtkContainer SYSTEM "sgml/gtkcontainer.sgml">
|
||||
<!entity GtkCTree SYSTEM "sgml/gtkctree.sgml">
|
||||
<!entity GtkCurve SYSTEM "sgml/gtkcurve.sgml">
|
||||
<!entity GtkData SYSTEM "sgml/gtkdata.sgml">
|
||||
<!entity GtkDialog SYSTEM "sgml/gtkdialog.sgml">
|
||||
<!entity GtkDrawingArea SYSTEM "sgml/gtkdrawingarea.sgml">
|
||||
<!entity GtkEditable SYSTEM "sgml/gtkeditable.sgml">
|
||||
<!entity GtkEntry SYSTEM "sgml/gtkentry.sgml">
|
||||
<!entity GtkEventBox SYSTEM "sgml/gtkeventbox.sgml">
|
||||
<!entity GtkFileSelection SYSTEM "sgml/gtkfilesel.sgml">
|
||||
<!entity GtkFixed SYSTEM "sgml/gtkfixed.sgml">
|
||||
<!entity GtkFontSelection SYSTEM "sgml/gtkfontsel.sgml">
|
||||
<!entity GtkFontSelectionDialog SYSTEM "sgml/gtkfontseldlg.sgml">
|
||||
<!entity GtkFrame SYSTEM "sgml/gtkframe.sgml">
|
||||
<!entity GtkGammaCurve SYSTEM "sgml/gtkgamma.sgml">
|
||||
<!entity GtkHandleBox SYSTEM "sgml/gtkhandlebox.sgml">
|
||||
<!entity GtkHButtonBox SYSTEM "sgml/gtkhbbox.sgml">
|
||||
<!entity GtkHBox SYSTEM "sgml/gtkhbox.sgml">
|
||||
<!entity GtkHPaned SYSTEM "sgml/gtkhpaned.sgml">
|
||||
<!entity GtkHRuler SYSTEM "sgml/gtkhruler.sgml">
|
||||
<!entity GtkHScale SYSTEM "sgml/gtkhscale.sgml">
|
||||
<!entity GtkHScrollbar SYSTEM "sgml/gtkhscrollbar.sgml">
|
||||
<!entity GtkHSeparator SYSTEM "sgml/gtkhseparator.sgml">
|
||||
<!entity GtkImage SYSTEM "sgml/gtkimage.sgml">
|
||||
<!entity GtkInputDialog SYSTEM "sgml/gtkinputdialog.sgml">
|
||||
<!entity GtkInvisible SYSTEM "sgml/gtkinvisible.sgml">
|
||||
<!entity GtkItem SYSTEM "sgml/gtkitem.sgml">
|
||||
<!entity GtkItemFactory SYSTEM "sgml/gtkitemfactory.sgml">
|
||||
<!entity GtkLabel SYSTEM "sgml/gtklabel.sgml">
|
||||
<!entity GtkLayout SYSTEM "sgml/gtklayout.sgml">
|
||||
<!entity GtkList SYSTEM "sgml/gtklist.sgml">
|
||||
<!entity GtkListItem SYSTEM "sgml/gtklistitem.sgml">
|
||||
<!entity GtkMenu SYSTEM "sgml/gtkmenu.sgml">
|
||||
<!entity GtkMenuBar SYSTEM "sgml/gtkmenubar.sgml">
|
||||
<!entity GtkMenuItem SYSTEM "sgml/gtkmenuitem.sgml">
|
||||
<!entity GtkMenuShell SYSTEM "sgml/gtkmenushell.sgml">
|
||||
<!entity GtkMisc SYSTEM "sgml/gtkmisc.sgml">
|
||||
<!entity GtkNotebook SYSTEM "sgml/gtknotebook.sgml">
|
||||
<!entity GtkObject SYSTEM "sgml/gtkobject.sgml">
|
||||
<!entity GtkOptionMenu SYSTEM "sgml/gtkoptionmenu.sgml">
|
||||
<!entity GtkPacker SYSTEM "sgml/gtkpacker.sgml">
|
||||
<!entity GtkPaned SYSTEM "sgml/gtkpaned.sgml">
|
||||
<!entity GtkPixmap SYSTEM "sgml/gtkpixmap.sgml">
|
||||
<!entity GtkPlug SYSTEM "sgml/gtkplug.sgml">
|
||||
<!entity GtkPreview SYSTEM "sgml/gtkpreview.sgml">
|
||||
<!entity GtkProgress SYSTEM "sgml/gtkprogress.sgml">
|
||||
<!entity GtkProgressBar SYSTEM "sgml/gtkprogressbar.sgml">
|
||||
<!entity GtkRadioButton SYSTEM "sgml/gtkradiobutton.sgml">
|
||||
<!entity GtkRadioMenuItem SYSTEM "sgml/gtkradiomenuitem.sgml">
|
||||
<!entity GtkRange SYSTEM "sgml/gtkrange.sgml">
|
||||
<!entity GtkRuler SYSTEM "sgml/gtkruler.sgml">
|
||||
<!entity GtkScale SYSTEM "sgml/gtkscale.sgml">
|
||||
<!entity GtkScrollbar SYSTEM "sgml/gtkscrollbar.sgml">
|
||||
<!entity GtkScrolledWindow SYSTEM "sgml/gtkscrolledwindow.sgml">
|
||||
<!entity GtkSeparator SYSTEM "sgml/gtkseparator.sgml">
|
||||
<!entity GtkSocket SYSTEM "sgml/gtksocket.sgml">
|
||||
<!entity GtkSpinButton SYSTEM "sgml/gtkspinbutton.sgml">
|
||||
<!entity GtkStatusbar SYSTEM "sgml/gtkstatusbar.sgml">
|
||||
<!entity GtkTable SYSTEM "sgml/gtktable.sgml">
|
||||
<!entity GtkTearoffMenuItem SYSTEM "sgml/gtktearoffmenuitem.sgml">
|
||||
<!entity GtkText SYSTEM "sgml/gtktext.sgml">
|
||||
<!entity GtkTipsQuery SYSTEM "sgml/gtktipsquery.sgml">
|
||||
<!entity GtkToggleButton SYSTEM "sgml/gtktogglebutton.sgml">
|
||||
<!entity GtkToolbar SYSTEM "sgml/gtktoolbar.sgml">
|
||||
<!entity GtkTooltips SYSTEM "sgml/gtktooltips.sgml">
|
||||
<!entity GtkTree SYSTEM "sgml/gtktree.sgml">
|
||||
<!entity GtkTreeItem SYSTEM "sgml/gtktreeitem.sgml">
|
||||
<!entity GtkVButtonBox SYSTEM "sgml/gtkvbbox.sgml">
|
||||
<!entity GtkVBox SYSTEM "sgml/gtkvbox.sgml">
|
||||
<!entity GtkViewport SYSTEM "sgml/gtkviewport.sgml">
|
||||
<!entity GtkVPaned SYSTEM "sgml/gtkvpaned.sgml">
|
||||
<!entity GtkVRuler SYSTEM "sgml/gtkvruler.sgml">
|
||||
<!entity GtkVScale SYSTEM "sgml/gtkvscale.sgml">
|
||||
<!entity GtkVScrollbar SYSTEM "sgml/gtkvscrollbar.sgml">
|
||||
<!entity GtkVSeparator SYSTEM "sgml/gtkvseparator.sgml">
|
||||
<!entity GtkWidget SYSTEM "sgml/gtkwidget.sgml">
|
||||
<!entity GtkWindow SYSTEM "sgml/gtkwindow.sgml">
|
||||
<!entity gtk-General SYSTEM "sgml/gtkmain.sgml">
|
||||
<!entity gtk-Feature-Test-Macros SYSTEM "sgml/gtkfeatures.sgml">
|
||||
<!entity gtk-Graphics-Contexts SYSTEM "sgml/gtkgc.sgml">
|
||||
<!entity gtk-Styles SYSTEM "sgml/gtkstyle.sgml">
|
||||
<!entity gtk-Themes SYSTEM "sgml/gtkthemes.sgml">
|
||||
<!entity gtk-Resource-Files SYSTEM "sgml/gtkrc.sgml">
|
||||
<!entity gtk-Keyboard-Accelerators SYSTEM "sgml/gtkaccelgroup.sgml">
|
||||
<!entity gtk-Selections SYSTEM "sgml/gtkselection.sgml">
|
||||
<!entity gtk-Drag-and-Drop SYSTEM "sgml/gtkdnd.sgml">
|
||||
<!entity gtk-Signals SYSTEM "sgml/gtksignal.sgml">
|
||||
<!entity gtk-Signal-Marshallers SYSTEM "sgml/gtkmarshal.sgml">
|
||||
<!entity gtk-Object-Properties SYSTEM "sgml/gtkarg.sgml">
|
||||
<!entity gtk-Types SYSTEM "sgml/gtktypeutils.sgml">
|
||||
<!entity gtk-Bindings SYSTEM "sgml/gtkbindings.sgml">
|
||||
<!entity gtk-Standard-Enumerations SYSTEM "sgml/gtkenums.sgml">
|
||||
<!entity gtk-Private-Information SYSTEM "sgml/gtkprivate.sgml">
|
||||
|
||||
<!entity index-Object-Tree SYSTEM "sgml/tree_index.sgml">
|
||||
|
||||
<!entity index-Objects-Grouped SYSTEM "objects_grouped.sgml">
|
||||
]>
|
||||
<book id="index">
|
||||
<bookinfo>
|
||||
<title>GTK+ Reference Manual</title>
|
||||
</bookinfo>
|
||||
|
||||
<chapter id="gtk">
|
||||
<title>GTK+ </title>
|
||||
<para>
|
||||
GTK+ is a multi-platform open source GUI Toolkit. Everything about
|
||||
GTK+ from the object-oriented design to the Free Software LGPL
|
||||
licensing allows you to code your project with the most freedom
|
||||
possible. You can develop open software, free software, or even
|
||||
commercial non-free software without having to spend a dime for
|
||||
licenses or royalties.
|
||||
</para>
|
||||
<para>
|
||||
GTK+ is a set of libraries to create graphical user interfaces. It
|
||||
works on many Unix-like platforms, and a Windows version is in
|
||||
development. GTK+ is released under the GNU Library General Public
|
||||
License (GNU LGPL), which allows for flexible licensing of client
|
||||
applications. GTK+ has a C-based object-oriented architecture that
|
||||
allows for maximum flexibility. Bindings for other languages have
|
||||
been written, including C++, Objective-C, Guile/Scheme, Perl, Python,
|
||||
TOM, Ada95, Free Pascal, and Eiffel.
|
||||
</para>
|
||||
<para>
|
||||
GTK+ consists of the following component libraries:
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term>GLib</term>
|
||||
<listitem><para>
|
||||
Provides many useful data types, macros, type conversions,
|
||||
string utilities and a lexical scanner. Includes Win32 support.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>GDK</term>
|
||||
<listitem><para>
|
||||
A wrapper for low-level windowing functions.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>GTK+</term>
|
||||
<listitem><para>
|
||||
An advanced widget set.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
>k-General;
|
||||
>k-Feature-Test-Macros;
|
||||
>k-Graphics-Contexts;
|
||||
>k-Styles;
|
||||
>k-Themes;
|
||||
>k-Resource-Files;
|
||||
>k-Keyboard-Accelerators;
|
||||
>k-Selections;
|
||||
>k-Drag-and-Drop;
|
||||
>k-Signals;
|
||||
>k-Signal-Marshallers;
|
||||
>k-Object-Properties;
|
||||
>k-Types;
|
||||
>k-Bindings;
|
||||
>k-Standard-Enumerations;
|
||||
>k-Private-Information;
|
||||
</chapter>
|
||||
|
||||
<chapter id="gtkobjects" role="no-toc">
|
||||
<title>GTK+ Widgets and Objects</title>
|
||||
&index-Objects-Grouped;
|
||||
|
||||
&GtkAccelLabel;
|
||||
&GtkAdjustment;
|
||||
&GtkAlignment;
|
||||
&GtkArrow;
|
||||
&GtkAspectFrame;
|
||||
&GtkButtonBox;
|
||||
&GtkBin;
|
||||
&GtkBox;
|
||||
&GtkButton;
|
||||
&GtkCalendar;
|
||||
&GtkCheckButton;
|
||||
&GtkCheckMenuItem;
|
||||
&GtkCList;
|
||||
&GtkColorSelection;
|
||||
&GtkColorSelectionDialog;
|
||||
&GtkCombo;
|
||||
&GtkContainer;
|
||||
&GtkCTree;
|
||||
&GtkCurve;
|
||||
&GtkData;
|
||||
&GtkDialog;
|
||||
&GtkDrawingArea;
|
||||
&GtkEditable;
|
||||
&GtkEntry;
|
||||
&GtkEventBox;
|
||||
&GtkFileSelection;
|
||||
&GtkFixed;
|
||||
&GtkFontSelection;
|
||||
&GtkFontSelectionDialog;
|
||||
&GtkFrame;
|
||||
&GtkGammaCurve;
|
||||
&GtkHandleBox;
|
||||
&GtkHButtonBox;
|
||||
&GtkHBox;
|
||||
&GtkHPaned;
|
||||
&GtkHRuler;
|
||||
&GtkHScale;
|
||||
&GtkHScrollbar;
|
||||
&GtkHSeparator;
|
||||
&GtkImage;
|
||||
&GtkInputDialog;
|
||||
&GtkInvisible;
|
||||
&GtkItem;
|
||||
&GtkItemFactory;
|
||||
&GtkLabel;
|
||||
&GtkLayout;
|
||||
&GtkList;
|
||||
&GtkListItem;
|
||||
&GtkMenu;
|
||||
&GtkMenuBar;
|
||||
&GtkMenuItem;
|
||||
&GtkMenuShell;
|
||||
&GtkMisc;
|
||||
&GtkNotebook;
|
||||
&GtkObject;
|
||||
&GtkOptionMenu;
|
||||
&GtkPacker;
|
||||
&GtkPaned;
|
||||
&GtkPixmap;
|
||||
&GtkPlug;
|
||||
&GtkPreview;
|
||||
&GtkProgress;
|
||||
&GtkProgressBar;
|
||||
&GtkRadioButton;
|
||||
&GtkRadioMenuItem;
|
||||
&GtkRange;
|
||||
&GtkRuler;
|
||||
&GtkScale;
|
||||
&GtkScrollbar;
|
||||
&GtkScrolledWindow;
|
||||
&GtkSeparator;
|
||||
&GtkSocket;
|
||||
&GtkSpinButton;
|
||||
&GtkStatusbar;
|
||||
&GtkTable;
|
||||
&GtkTearoffMenuItem;
|
||||
&GtkText;
|
||||
&GtkTipsQuery;
|
||||
&GtkToggleButton;
|
||||
&GtkToolbar;
|
||||
&GtkTooltips;
|
||||
&GtkTree;
|
||||
&GtkTreeItem;
|
||||
&GtkVButtonBox;
|
||||
&GtkVBox;
|
||||
&GtkViewport;
|
||||
&GtkVPaned;
|
||||
&GtkVRuler;
|
||||
&GtkVScale;
|
||||
&GtkVScrollbar;
|
||||
&GtkVSeparator;
|
||||
&GtkWidget;
|
||||
&GtkWindow;
|
||||
</chapter>
|
||||
|
||||
<chapter id="gtk-index">
|
||||
<title>Index</title>
|
||||
<sect1>
|
||||
<title>Object Hierarchy</title>
|
||||
&index-Object-Tree;
|
||||
</sect1>
|
||||
</chapter>
|
||||
</book>
|
||||
@@ -1,19 +0,0 @@
|
||||
# These are manually-edited to override or add declarations to those scanned
|
||||
# from the GTK header files.
|
||||
|
||||
# These haven't been given parameter names in the header files.
|
||||
<USER_FUNCTION>
|
||||
<NAME>GtkArgGetFunc</NAME>
|
||||
<RETURNS>void</RETURNS>
|
||||
GtkObject *object,
|
||||
GtkArg *arg,
|
||||
guint arg_id
|
||||
</USER_FUNCTION>
|
||||
|
||||
<USER_FUNCTION>
|
||||
<NAME>GtkArgSetFunc</NAME>
|
||||
<RETURNS>void</RETURNS>
|
||||
GtkObject *object,
|
||||
GtkArg *arg,
|
||||
guint arg_id
|
||||
</USER_FUNCTION>
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,846 +0,0 @@
|
||||
<ARG>
|
||||
<NAME>GtkAccelLabel::accel_widget</NAME>
|
||||
<TYPE>GtkWidget</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkAlignment::xalign</NAME>
|
||||
<TYPE>gfloat</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkAlignment::yalign</NAME>
|
||||
<TYPE>gfloat</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkAlignment::xscale</NAME>
|
||||
<TYPE>gfloat</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkAlignment::yscale</NAME>
|
||||
<TYPE>gfloat</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkArrow::arrow_type</NAME>
|
||||
<TYPE>GtkArrowType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkArrow::shadow_type</NAME>
|
||||
<TYPE>GtkShadowType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkBox::spacing</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkBox::homogeneous</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkButton::label</NAME>
|
||||
<TYPE>GtkString</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkButton::relief</NAME>
|
||||
<TYPE>GtkReliefStyle</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCList::n_columns</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rwX</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCList::shadow_type</NAME>
|
||||
<TYPE>GtkShadowType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCList::selection_mode</NAME>
|
||||
<TYPE>GtkSelectionMode</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCList::row_height</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCList::reorderable</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCList::titles_active</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCList::use_drag_icons</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkContainer::border_width</NAME>
|
||||
<TYPE>gulong</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkContainer::resize_mode</NAME>
|
||||
<TYPE>GtkResizeMode</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkContainer::child</NAME>
|
||||
<TYPE>GtkWidget</TYPE>
|
||||
<FLAGS>w</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCTree::n_columns</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rwX</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCTree::tree_column</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rwX</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCTree::indent</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCTree::spacing</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCTree::show_stub</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCTree::line_style</NAME>
|
||||
<TYPE>GtkCTreeLineStyle</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkCTree::expander_style</NAME>
|
||||
<TYPE>GtkCTreeExpanderStyle</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkEditable::text_position</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkEditable::editable</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkEntry::max_length</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkEntry::visibility</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkFrame::label</NAME>
|
||||
<TYPE>GtkString</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkFrame::label_xalign</NAME>
|
||||
<TYPE>gfloat</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkFrame::label_yalign</NAME>
|
||||
<TYPE>gfloat</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkFrame::shadow</NAME>
|
||||
<TYPE>GtkShadowType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkHandleBox::shadow</NAME>
|
||||
<TYPE>GtkShadowType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkHScale::adjustment</NAME>
|
||||
<TYPE>GtkAdjustment</TYPE>
|
||||
<FLAGS>rwx</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkHScrollbar::adjustment</NAME>
|
||||
<TYPE>GtkAdjustment</TYPE>
|
||||
<FLAGS>rwx</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkLabel::label</NAME>
|
||||
<TYPE>GtkString</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkLabel::pattern</NAME>
|
||||
<TYPE>GtkString</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkLabel::justify</NAME>
|
||||
<TYPE>GtkJustification</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkMenuBar::shadow</NAME>
|
||||
<TYPE>GtkShadowType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkMisc::xalign</NAME>
|
||||
<TYPE>gfloat</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkMisc::yalign</NAME>
|
||||
<TYPE>gfloat</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkMisc::xpad</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkMisc::ypad</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkNotebook::page</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkNotebook::tab_pos</NAME>
|
||||
<TYPE>GtkPositionType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkNotebook::tab_border</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>w</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkNotebook::tab_hborder</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkNotebook::tab_vborder</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkNotebook::show_tabs</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkNotebook::show_border</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkNotebook::scrollable</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkNotebook::enable_popup</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkObject::user_data</NAME>
|
||||
<TYPE>gpointer</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkObject::signal</NAME>
|
||||
<TYPE>GtkSignal</TYPE>
|
||||
<FLAGS>w</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkObject::signal_after</NAME>
|
||||
<TYPE>GtkSignal</TYPE>
|
||||
<FLAGS>w</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkObject::object_signal</NAME>
|
||||
<TYPE>GtkSignal</TYPE>
|
||||
<FLAGS>w</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkObject::object_signal_after</NAME>
|
||||
<TYPE>GtkSignal</TYPE>
|
||||
<FLAGS>w</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkPacker::spacing</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkPacker::default_border_width</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkPacker::default_pad_x</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkPacker::default_pad_y</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkPacker::default_ipad_x</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkPacker::default_ipad_y</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkProgress::activity_mode</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkProgress::show_text</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkProgress::text_xalign</NAME>
|
||||
<TYPE>gfloat</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkProgress::text_yalign</NAME>
|
||||
<TYPE>gfloat</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkProgressBar::adjustment</NAME>
|
||||
<TYPE>GtkAdjustment</TYPE>
|
||||
<FLAGS>rwx</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkProgressBar::orientation</NAME>
|
||||
<TYPE>GtkProgressBarOrientation</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkProgressBar::bar_style</NAME>
|
||||
<TYPE>GtkProgressBarStyle</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkProgressBar::activity_step</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkProgressBar::activity_blocks</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkProgressBar::discrete_blocks</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkRadioButton::group</NAME>
|
||||
<TYPE>GtkRadioButton</TYPE>
|
||||
<FLAGS>w</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkRange::update_policy</NAME>
|
||||
<TYPE>GtkUpdateType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkScale::digits</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkScale::draw_value</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkScale::value_pos</NAME>
|
||||
<TYPE>GtkPositionType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkScrolledWindow::hadjustment</NAME>
|
||||
<TYPE>GtkAdjustment</TYPE>
|
||||
<FLAGS>rwx</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkScrolledWindow::vadjustment</NAME>
|
||||
<TYPE>GtkAdjustment</TYPE>
|
||||
<FLAGS>rwx</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkScrolledWindow::hscrollbar_policy</NAME>
|
||||
<TYPE>GtkPolicyType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkScrolledWindow::vscrollbar_policy</NAME>
|
||||
<TYPE>GtkPolicyType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkScrolledWindow::window_placement</NAME>
|
||||
<TYPE>GtkCornerType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkSpinButton::adjustment</NAME>
|
||||
<TYPE>GtkAdjustment</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkSpinButton::climb_rate</NAME>
|
||||
<TYPE>gfloat</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkSpinButton::digits</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkSpinButton::snap_to_ticks</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkSpinButton::numeric</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkSpinButton::wrap</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkSpinButton::update_policy</NAME>
|
||||
<TYPE>GtkSpinButtonUpdatePolicy</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkSpinButton::shadow_type</NAME>
|
||||
<TYPE>GtkShadowType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkSpinButton::value</NAME>
|
||||
<TYPE>gfloat</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkTable::n_rows</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkTable::n_columns</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkTable::row_spacing</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkTable::column_spacing</NAME>
|
||||
<TYPE>guint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkTable::homogeneous</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkText::hadjustment</NAME>
|
||||
<TYPE>GtkAdjustment</TYPE>
|
||||
<FLAGS>rwx</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkText::vadjustment</NAME>
|
||||
<TYPE>GtkAdjustment</TYPE>
|
||||
<FLAGS>rwx</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkText::line_wrap</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkText::word_wrap</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkTipsQuery::emit_always</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkTipsQuery::caller</NAME>
|
||||
<TYPE>GtkWidget</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkTipsQuery::label_inactive</NAME>
|
||||
<TYPE>GtkString</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkTipsQuery::label_no_tip</NAME>
|
||||
<TYPE>GtkString</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkToggleButton::active</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkToggleButton::draw_indicator</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkViewport::hadjustment</NAME>
|
||||
<TYPE>GtkAdjustment</TYPE>
|
||||
<FLAGS>rwx</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkViewport::vadjustment</NAME>
|
||||
<TYPE>GtkAdjustment</TYPE>
|
||||
<FLAGS>rwx</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkViewport::shadow_type</NAME>
|
||||
<TYPE>GtkShadowType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkVScale::adjustment</NAME>
|
||||
<TYPE>GtkAdjustment</TYPE>
|
||||
<FLAGS>rwx</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkVScrollbar::adjustment</NAME>
|
||||
<TYPE>GtkAdjustment</TYPE>
|
||||
<FLAGS>rwx</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::name</NAME>
|
||||
<TYPE>GtkString</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::parent</NAME>
|
||||
<TYPE>GtkContainer</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::x</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::y</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::width</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::height</NAME>
|
||||
<TYPE>gint</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::visible</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::sensitive</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::app_paintable</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::can_focus</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::has_focus</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::can_default</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::has_default</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::receives_default</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::composite_child</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::style</NAME>
|
||||
<TYPE>GtkStyle</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::events</NAME>
|
||||
<TYPE>GdkEventMask</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWidget::extension_events</NAME>
|
||||
<TYPE>GdkEventMask</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWindow::type</NAME>
|
||||
<TYPE>GtkWindowType</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWindow::title</NAME>
|
||||
<TYPE>GtkString</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWindow::auto_shrink</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWindow::allow_shrink</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWindow::allow_grow</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWindow::modal</NAME>
|
||||
<TYPE>gboolean</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
<ARG>
|
||||
<NAME>GtkWindow::window_position</NAME>
|
||||
<TYPE>GtkWindowPosition</TYPE>
|
||||
<FLAGS>rw</FLAGS>
|
||||
</ARG>
|
||||
|
||||
@@ -1,93 +0,0 @@
|
||||
GtkObject
|
||||
GtkWidget
|
||||
GtkMisc
|
||||
GtkLabel
|
||||
GtkAccelLabel
|
||||
GtkTipsQuery
|
||||
GtkArrow
|
||||
GtkImage
|
||||
GtkPixmap
|
||||
GtkContainer
|
||||
GtkBin
|
||||
GtkAlignment
|
||||
GtkFrame
|
||||
GtkAspectFrame
|
||||
GtkButton
|
||||
GtkToggleButton
|
||||
GtkCheckButton
|
||||
GtkRadioButton
|
||||
GtkOptionMenu
|
||||
GtkItem
|
||||
GtkMenuItem
|
||||
GtkCheckMenuItem
|
||||
GtkRadioMenuItem
|
||||
GtkTearoffMenuItem
|
||||
GtkListItem
|
||||
GtkTreeItem
|
||||
GtkWindow
|
||||
GtkColorSelectionDialog
|
||||
GtkDialog
|
||||
GtkInputDialog
|
||||
GtkFileSelection
|
||||
GtkFontSelectionDialog
|
||||
GtkPlug
|
||||
GtkEventBox
|
||||
GtkHandleBox
|
||||
GtkScrolledWindow
|
||||
GtkViewport
|
||||
GtkBox
|
||||
GtkButtonBox
|
||||
GtkHButtonBox
|
||||
GtkVButtonBox
|
||||
GtkVBox
|
||||
GtkColorSelection
|
||||
GtkGammaCurve
|
||||
GtkHBox
|
||||
GtkCombo
|
||||
GtkStatusbar
|
||||
GtkCList
|
||||
GtkCTree
|
||||
GtkFixed
|
||||
GtkNotebook
|
||||
GtkFontSelection
|
||||
GtkPaned
|
||||
GtkHPaned
|
||||
GtkVPaned
|
||||
GtkLayout
|
||||
GtkList
|
||||
GtkMenuShell
|
||||
GtkMenu
|
||||
GtkMenuBar
|
||||
GtkPacker
|
||||
GtkSocket
|
||||
GtkTable
|
||||
GtkToolbar
|
||||
GtkTree
|
||||
GtkCalendar
|
||||
GtkDrawingArea
|
||||
GtkCurve
|
||||
GtkEditable
|
||||
GtkEntry
|
||||
GtkSpinButton
|
||||
GtkText
|
||||
GtkRuler
|
||||
GtkHRuler
|
||||
GtkVRuler
|
||||
GtkRange
|
||||
GtkScale
|
||||
GtkHScale
|
||||
GtkVScale
|
||||
GtkScrollbar
|
||||
GtkHScrollbar
|
||||
GtkVScrollbar
|
||||
GtkSeparator
|
||||
GtkHSeparator
|
||||
GtkVSeparator
|
||||
GtkInvisible
|
||||
GtkPreview
|
||||
GtkProgress
|
||||
GtkProgressBar
|
||||
GtkData
|
||||
GtkAdjustment
|
||||
GtkTooltips
|
||||
GtkItemFactory
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,96 +0,0 @@
|
||||
#include <gtk/gtk.h>
|
||||
|
||||
gtk_accel_label_get_type
|
||||
gtk_adjustment_get_type
|
||||
gtk_alignment_get_type
|
||||
gtk_arrow_get_type
|
||||
gtk_aspect_frame_get_type
|
||||
gtk_bin_get_type
|
||||
gtk_box_get_type
|
||||
gtk_button_get_type
|
||||
gtk_button_box_get_type
|
||||
gtk_calendar_get_type
|
||||
gtk_check_button_get_type
|
||||
gtk_check_menu_item_get_type
|
||||
gtk_clist_get_type
|
||||
gtk_color_selection_get_type
|
||||
gtk_color_selection_dialog_get_type
|
||||
gtk_combo_get_type
|
||||
gtk_container_get_type
|
||||
gtk_ctree_get_type
|
||||
gtk_curve_get_type
|
||||
gtk_data_get_type
|
||||
gtk_dialog_get_type
|
||||
gtk_drawing_area_get_type
|
||||
gtk_editable_get_type
|
||||
gtk_entry_get_type
|
||||
gtk_event_box_get_type
|
||||
gtk_file_selection_get_type
|
||||
gtk_fixed_get_type
|
||||
gtk_font_selection_get_type
|
||||
gtk_font_selection_dialog_get_type
|
||||
gtk_frame_get_type
|
||||
gtk_gamma_curve_get_type
|
||||
gtk_handle_box_get_type
|
||||
gtk_hbox_get_type
|
||||
gtk_hbutton_box_get_type
|
||||
gtk_hpaned_get_type
|
||||
gtk_hruler_get_type
|
||||
gtk_hscale_get_type
|
||||
gtk_hscrollbar_get_type
|
||||
gtk_hseparator_get_type
|
||||
gtk_identifier_get_type
|
||||
gtk_image_get_type
|
||||
gtk_input_dialog_get_type
|
||||
gtk_invisible_get_type
|
||||
gtk_item_get_type
|
||||
gtk_item_factory_get_type
|
||||
gtk_label_get_type
|
||||
gtk_layout_get_type
|
||||
gtk_list_get_type
|
||||
gtk_list_item_get_type
|
||||
gtk_menu_get_type
|
||||
gtk_menu_bar_get_type
|
||||
gtk_menu_item_get_type
|
||||
gtk_menu_shell_get_type
|
||||
gtk_misc_get_type
|
||||
gtk_notebook_get_type
|
||||
gtk_object_get_type
|
||||
gtk_option_menu_get_type
|
||||
gtk_packer_get_type
|
||||
gtk_paned_get_type
|
||||
gtk_pixmap_get_type
|
||||
gtk_plug_get_type
|
||||
gtk_preview_get_type
|
||||
gtk_progress_get_type
|
||||
gtk_progress_bar_get_type
|
||||
gtk_radio_button_get_type
|
||||
gtk_radio_menu_item_get_type
|
||||
gtk_range_get_type
|
||||
gtk_ruler_get_type
|
||||
gtk_scale_get_type
|
||||
gtk_scrollbar_get_type
|
||||
gtk_scrolled_window_get_type
|
||||
gtk_separator_get_type
|
||||
gtk_socket_get_type
|
||||
gtk_spin_button_get_type
|
||||
gtk_statusbar_get_type
|
||||
gtk_table_get_type
|
||||
gtk_tearoff_menu_item_get_type
|
||||
gtk_text_get_type
|
||||
gtk_tips_query_get_type
|
||||
gtk_toggle_button_get_type
|
||||
gtk_toolbar_get_type
|
||||
gtk_tooltips_get_type
|
||||
gtk_tree_get_type
|
||||
gtk_tree_item_get_type
|
||||
gtk_vbox_get_type
|
||||
gtk_vbutton_box_get_type
|
||||
gtk_viewport_get_type
|
||||
gtk_vpaned_get_type
|
||||
gtk_vruler_get_type
|
||||
gtk_vscale_get_type
|
||||
gtk_vscrollbar_get_type
|
||||
gtk_vseparator_get_type
|
||||
gtk_widget_get_type
|
||||
gtk_window_get_type
|
||||
@@ -1,130 +0,0 @@
|
||||
<informaltable pgwide=1 frame="none">
|
||||
<tgroup cols="4">
|
||||
<colspec colwidth="1*">
|
||||
<colspec colwidth="1*">
|
||||
<colspec colwidth="1*">
|
||||
<colspec colwidth="1*">
|
||||
<tbody><row>
|
||||
<entry><literallayout>
|
||||
<emphasis>Windows & Dialogs</emphasis>
|
||||
<link linkend="GtkWindow">GtkWindow</link>
|
||||
<link linkend="GtkDialog">GtkDialog</link>
|
||||
<link linkend="GtkColorSelectionDialog">GtkColorSelectionDialog</link>
|
||||
<link linkend="GtkFileSelection">GtkFileSelection</link>
|
||||
<link linkend="GtkFontSelectionDialog">GtkFontSelectionDialog</link>
|
||||
<link linkend="GtkInputDialog">GtkInputDialog</link>
|
||||
|
||||
<emphasis>Containers</emphasis>
|
||||
<link linkend="GtkHBox">GtkHBox</link>
|
||||
<link linkend="GtkVBox">GtkVBox</link>
|
||||
<link linkend="GtkTable">GtkTable</link>
|
||||
<link linkend="GtkToolbar">GtkToolbar</link>
|
||||
<link linkend="GtkHandleBox">GtkHandleBox</link>
|
||||
<link linkend="GtkNotebook">GtkNotebook</link>
|
||||
<link linkend="GtkFrame">GtkFrame</link>
|
||||
<link linkend="GtkAspectFrame">GtkAspectFrame</link>
|
||||
<link linkend="GtkFixed">GtkFixed</link>
|
||||
<link linkend="GtkPacker">GtkPacker</link>
|
||||
<link linkend="GtkLayout">GtkLayout</link>
|
||||
<link linkend="GtkScrolledWindow">GtkScrolledWindow</link>
|
||||
<link linkend="GtkViewport">GtkViewport</link>
|
||||
<link linkend="GtkEventBox">GtkEventBox</link>
|
||||
<link linkend="GtkAlignment">GtkAlignment</link>
|
||||
<link linkend="GtkHButtonBox">GtkHButtonBox</link>
|
||||
<link linkend="GtkVButtonBox">GtkVButtonBox</link>
|
||||
<link linkend="GtkHPaned">GtkHPaned</link>
|
||||
<link linkend="GtkVPaned">GtkVPaned</link>
|
||||
</literallayout></entry>
|
||||
<entry><literallayout>
|
||||
<emphasis>Labels & Buttons</emphasis>
|
||||
<link linkend="GtkLabel">GtkLabel</link>
|
||||
<link linkend="GtkAccelLabel">GtkAccelLabel</link>
|
||||
<link linkend="GtkButton">GtkButton</link>
|
||||
<link linkend="GtkCheckButton">GtkCheckButton</link>
|
||||
<link linkend="GtkToggleButton">GtkToggleButton</link>
|
||||
<link linkend="GtkRadioButton">GtkRadioButton</link>
|
||||
|
||||
<emphasis>Data Entry Widgets</emphasis>
|
||||
<link linkend="GtkEntry">GtkEntry</link>
|
||||
<link linkend="GtkText">GtkText</link>
|
||||
<link linkend="GtkSpinButton">GtkSpinButton</link>
|
||||
<link linkend="GtkOptionMenu">GtkOptionMenu</link>
|
||||
<link linkend="GtkCombo">GtkCombo</link>
|
||||
<link linkend="GtkHScale">GtkHScale</link>
|
||||
<link linkend="GtkVScale">GtkVScale</link>
|
||||
|
||||
<emphasis>Lists & Trees</emphasis>
|
||||
<link linkend="GtkCList">GtkCList</link>
|
||||
<link linkend="GtkCTree">GtkCTree</link>
|
||||
<link linkend="GtkList">GtkList</link>
|
||||
<link linkend="GtkListItem">GtkListItem</link>
|
||||
<link linkend="GtkTree">GtkTree</link>
|
||||
<link linkend="GtkTreeItem">GtkTreeItem</link>
|
||||
|
||||
<emphasis>Tooltips</emphasis>
|
||||
<link linkend="GtkTooltips">GtkTooltips</link>
|
||||
<link linkend="GtkTipsQuery">GtkTipsQuery</link>
|
||||
</literallayout></entry>
|
||||
<entry><literallayout>
|
||||
<emphasis>Menus & Menu Bars</emphasis>
|
||||
<link linkend="GtkMenuBar">GtkMenuBar</link>
|
||||
<link linkend="GtkMenu">GtkMenu</link>
|
||||
<link linkend="GtkMenuItem">GtkMenuItem</link>
|
||||
<link linkend="GtkCheckMenuItem">GtkCheckMenuItem</link>
|
||||
<link linkend="GtkRadioMenuItem">GtkRadioMenuItem</link>
|
||||
<link linkend="GtkTearoffMenuItem">GtkTearoffMenuItem</link>
|
||||
|
||||
<emphasis>Graphical Widgets</emphasis>
|
||||
<link linkend="GtkDrawingArea">GtkDrawingArea</link>
|
||||
<link linkend="GtkImage">GtkImage</link>
|
||||
<link linkend="GtkPixmap">GtkPixmap</link>
|
||||
<link linkend="GtkPreview">GtkPreview</link>
|
||||
<link linkend="GtkCurve">GtkCurve</link>
|
||||
<link linkend="GtkGammaCurve">GtkGammaCurve</link>
|
||||
|
||||
<emphasis>Misc. Widgets</emphasis>
|
||||
<link linkend="GtkArrow">GtkArrow</link>
|
||||
<link linkend="GtkCalendar">GtkCalendar</link>
|
||||
<link linkend="GtkProgressBar">GtkProgressBar</link>
|
||||
<link linkend="GtkStatusbar">GtkStatusbar</link>
|
||||
<link linkend="GtkHRuler">GtkHRuler</link>
|
||||
<link linkend="GtkVRuler">GtkVRuler</link>
|
||||
<link linkend="GtkHScrollbar">GtkHScrollbar</link>
|
||||
<link linkend="GtkVScrollbar">GtkVScrollbar</link>
|
||||
<link linkend="GtkHSeparator">GtkHSeparator</link>
|
||||
<link linkend="GtkVSeparator">GtkVSeparator</link>
|
||||
<link linkend="GtkColorSelection">GtkColorSelection</link>
|
||||
<link linkend="GtkFontSelection">GtkFontSelection</link>
|
||||
</literallayout></entry>
|
||||
<entry><literallayout>
|
||||
<emphasis>Abstract Base Classes</emphasis>
|
||||
<link linkend="GtkWidget">GtkWidget</link>
|
||||
<link linkend="GtkObject">GtkObject</link>
|
||||
<link linkend="GtkContainer">GtkContainer</link>
|
||||
<link linkend="GtkBin">GtkBin</link>
|
||||
<link linkend="GtkBox">GtkBox</link>
|
||||
<link linkend="GtkButtonBox">GtkButtonBox</link>
|
||||
<link linkend="GtkData">GtkData</link>
|
||||
<link linkend="GtkEditable">GtkEditable</link>
|
||||
<link linkend="GtkItem">GtkItem</link>
|
||||
<link linkend="GtkMenuShell">GtkMenuShell</link>
|
||||
<link linkend="GtkMisc">GtkMisc</link>
|
||||
<link linkend="GtkPaned">GtkPaned</link>
|
||||
<link linkend="GtkProgress">GtkProgress</link>
|
||||
<link linkend="GtkRange">GtkRange</link>
|
||||
<link linkend="GtkRuler">GtkRuler</link>
|
||||
<link linkend="GtkScale">GtkScale</link>
|
||||
<link linkend="GtkScrollbar">GtkScrollbar</link>
|
||||
<link linkend="GtkSeparator">GtkSeparator</link>
|
||||
|
||||
<emphasis>Integrating with other X Applications</emphasis>
|
||||
<link linkend="GtkPlug">GtkPlug</link>
|
||||
<link linkend="GtkSocket">GtkSocket</link>
|
||||
|
||||
<emphasis>Misc. Objects</emphasis>
|
||||
<link linkend="GtkAdjustment">GtkAdjustment</link>
|
||||
<link linkend="GtkItemFactory">GtkItemFactory</link>
|
||||
<link linkend="GtkInvisible">GtkInvisible</link>
|
||||
</literallayout></entry>
|
||||
</row>
|
||||
</tbody></tgroup></informaltable>
|
||||
@@ -1,629 +0,0 @@
|
||||
<!-- ##### SECTION ./tmpl/gtkmenufactory.sgml:Title ##### -->
|
||||
Menu Factory
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__INT_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### STRUCT GtkMenuFactory ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@path:
|
||||
@type:
|
||||
@accel_group:
|
||||
@widget:
|
||||
@subfactories:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_BOOL__POINTER_INT_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__UINT_STRING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__INT_FLOAT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER_INT_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_INT__POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_menu_factory_find ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
@path:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__ENUM_FLOAT_BOOL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__POINTER_STRING_STRING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__INT_POINTER_INT_INT_INT_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_BOOL__POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__UINT_POINTER_UINT_ENUM_ENUM_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ENUM GtkMenuFactoryType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_MENU_FACTORY_MENU:
|
||||
@GTK_MENU_FACTORY_MENU_BAR:
|
||||
@GTK_MENU_FACTORY_OPTION_MENU:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_INT__POINTER_CHAR_CHAR ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER_INT_INT_POINTER_INT_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__INT_FLOAT_BOOL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__BOXED ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_menu_factory_add_entries ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
@entries:
|
||||
@nentries:
|
||||
|
||||
<!-- ##### STRUCT GtkMenuPath ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@path:
|
||||
@widget:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__UINT_POINTER_UINT_UINT_ENUM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ARG GtkPreview:expand ##### -->
|
||||
<para>
|
||||
Determines the way that the the preview widget behaves
|
||||
when the size it is allocated is larger than the requested
|
||||
size. See gtk_preview_set_expand().
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__STRING_INT_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__POINTER_INT_INT_POINTER_UINT_UINT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_BOOL__POINTER_INT_INT_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### SECTION ./tmpl/gtkmenufactory.sgml:Short_Description ##### -->
|
||||
|
||||
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_BOOL__POINTER_STRING_STRING_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__ENUM_FLOAT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__INT_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__POINTER_POINTER_UINT_UINT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_menu_factory_remove_paths ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
@paths:
|
||||
@npaths:
|
||||
|
||||
<!-- ##### FUNCTION gtk_menu_factory_destroy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_BOOL__POINTER_INT_INT_UINT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_INT__INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_ENUM__ENUM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__INT_POINTER_INT_INT_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### MACRO GTK_NOTE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@action:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER_INT_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__POINTER_UINT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER_POINTER_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### SECTION ./tmpl/gtkmenufactory.sgml:See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__BOOL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER_POINTER_INT_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_BOOL__POINTER_POINTER_POINTER_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__OBJECT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ENUM GtkDebugFlag ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_DEBUG_OBJECTS:
|
||||
@GTK_DEBUG_MISC:
|
||||
@GTK_DEBUG_SIGNALS:
|
||||
@GTK_DEBUG_DND:
|
||||
@GTK_DEBUG_PLUGSOCKET:
|
||||
|
||||
<!-- ##### ARG GtkHandleBox:snap_edge ##### -->
|
||||
<para>
|
||||
Determines the snap edge of a handlebox. The snap edge is
|
||||
the edge of the detached child that must be aligned
|
||||
with the corresponding edge of the "ghost" left
|
||||
behind when the child was detached to reattach
|
||||
the torn-off window. See gtk_handle_box_set_snap_edge().
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ARG GtkHandleBox:handle_position ##### -->
|
||||
<para>
|
||||
Determines the side of the handlebox where the handle is drawn.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__STRING ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__UINT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__ENUM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__C_CALLBACK_C_CALLBACK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_menu_factory_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:Short_Description ##### -->
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__INT_INT_POINTER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__C_CALLBACK ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_BOOL__POINTER_POINTER_INT_INT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_menu_factory_remove_entries ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
@entries:
|
||||
@nentries:
|
||||
|
||||
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION GtkMenuCallback ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@widget:
|
||||
@user_data:
|
||||
|
||||
<!-- ##### VARIABLE gtk_debug_flags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_menu_factory_remove_subfactory ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
@subfactory:
|
||||
@path:
|
||||
|
||||
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:Title ##### -->
|
||||
Debugging
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_ruler_draw_pos ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@ruler: the gtkruler
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__POINTER_UINT_UINT ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO gtk_marshal_NONE__POINTER_UINT_ENUM ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_NONE__NONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_marshal_BOOL__NONE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
<!-- ##### FUNCTION gtk_menu_factory_add_subfactory ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@factory:
|
||||
@subfactory:
|
||||
@path:
|
||||
|
||||
<!-- ##### STRUCT GtkMenuEntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@path:
|
||||
@accelerator:
|
||||
@callback:
|
||||
@callback_data:
|
||||
@widget:
|
||||
|
||||
<!-- ##### FUNCTION gtk_ruler_draw_ticks ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@ruler: the gtkruler
|
||||
|
||||
<!-- ##### SECTION ./tmpl/gtkmenufactory.sgml:Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
@@ -1,314 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Keyboard Accelerators
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkAccelGroup ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@ref_count:
|
||||
@lock_count:
|
||||
@modifier_mask:
|
||||
@attach_objects:
|
||||
|
||||
<!-- ##### STRUCT GtkAccelEntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
@accelerator_key:
|
||||
@accelerator_mods:
|
||||
@accel_flags:
|
||||
@object:
|
||||
@signal_id:
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_get_default ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_ref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_unref ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_activate ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
@accel_key:
|
||||
@accel_mods:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_groups_activate ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@accel_key:
|
||||
@accel_mods:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_attach ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
@object:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_detach ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
@object:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_lock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_unlock ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_get_entry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
@accel_key:
|
||||
@accel_mods:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_lock_entry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
@accel_key:
|
||||
@accel_mods:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_unlock_entry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
@accel_key:
|
||||
@accel_mods:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_add ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
@accel_key:
|
||||
@accel_mods:
|
||||
@accel_flags:
|
||||
@object:
|
||||
@accel_signal:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_remove ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accel_group:
|
||||
@accel_key:
|
||||
@accel_mods:
|
||||
@object:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_handle_add ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@accel_signal_id:
|
||||
@accel_group:
|
||||
@accel_key:
|
||||
@accel_mods:
|
||||
@accel_flags:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_handle_remove ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@accel_group:
|
||||
@accel_key:
|
||||
@accel_mods:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_create_add ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class_type:
|
||||
@signal_flags:
|
||||
@handler_offset:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_create_remove ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class_type:
|
||||
@signal_flags:
|
||||
@handler_offset:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_marshal_add ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_marshal_remove ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@func:
|
||||
@func_data:
|
||||
@args:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_groups_from_object ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_group_entries_from_object ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accelerator_valid ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@keyval:
|
||||
@modifiers:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accelerator_parse ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accelerator:
|
||||
@accelerator_key:
|
||||
@accelerator_mods:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accelerator_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@accelerator_key:
|
||||
@accelerator_mods:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accelerator_set_default_mod_mask ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@default_mod_mask:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accelerator_get_default_mod_mask ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
@@ -1,132 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkAccelLabel
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a label which displays an accelerator key on the right of the text.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkAccelLabel widget is a subclass of #GtkLabel that also displays an
|
||||
accelerator key on the right of the label text, e.g. 'Ctl+S'.
|
||||
It is commonly used in menus to show the keyboard short-cuts for commands.
|
||||
</para>
|
||||
<para>
|
||||
The accelerator key to display is not set explicitly.
|
||||
Instead, the #GtkAccelLabel displays the accelerators which have been added to
|
||||
a particular widget. This widget is set by calling
|
||||
gtk_accel_label_set_accel_widget().
|
||||
</para>
|
||||
<para>
|
||||
For example, a #GtkMenuItem widget may have an accelerator added to emit the
|
||||
"activate" signal when the 'Ctl+S' key combination is pressed.
|
||||
A #GtkAccelLabel is created and added to the #GtkMenuItem, and
|
||||
gtk_accel_label_set_accel_widget() is called with the #GtkMenuItem as the
|
||||
second argument. The #GtkAccelLabel will now display 'Ctl+S' after its label.
|
||||
</para>
|
||||
<para>
|
||||
Note that creating a #GtkMenuItem with gtk_menu_item_new_with_label() (or
|
||||
one of the similar functions for #GtkCheckMenuItem and #GtkRadioMenuItem)
|
||||
automatically adds a #GtkAccelLabel to the #GtkMenuItem and calls
|
||||
gtk_accel_label_set_accel_widget() to set it up for you.
|
||||
</para>
|
||||
<para>
|
||||
A #GtkAccelLabel will only display accelerators which have GTK_ACCEL_VISIBLE
|
||||
set (see #GtkAccelFlags).
|
||||
A #GtkAccelLabel can display multiple accelerators and even signal names,
|
||||
though it is almost always used to display just one accelerator key.
|
||||
</para>
|
||||
|
||||
<example>
|
||||
<title>Creating a simple menu item with an accelerator key.</title>
|
||||
<programlisting>
|
||||
GtkWidget *save_item;
|
||||
GtkAccelGroup *accel_group;
|
||||
|
||||
/* Create a #GtkAccelGroup and add it to the window. */
|
||||
accel_group = gtk_accel_group_new ();
|
||||
gtk_window_add_accel_group (GTK_WINDOW (window), accel_group);
|
||||
|
||||
/* Create the menu item using the convenience function. */
|
||||
save_item = gtk_menu_item_new_with_label ("Save");
|
||||
gtk_widget_show (save_item);
|
||||
gtk_container_add (GTK_CONTAINER (menu), save_item);
|
||||
|
||||
/* Now add the accelerator to the #GtkMenuItem. Note that since we called
|
||||
gtk_menu_item_new_with_label() to create the #GtkMenuItem the
|
||||
#GtkAccelLabel is automatically set up to display the #GtkMenuItem
|
||||
accelerators. We just need to make sure we use GTK_ACCEL_VISIBLE here. */
|
||||
gtk_widget_add_accelerator (save_item, "activate", accel_group,
|
||||
GDK_s, GDK_CONTROL_MASK, GTK_ACCEL_VISIBLE);
|
||||
</programlisting>
|
||||
</example>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term><link linkend="gtk-keyboard-accelerators">Keyboard Accelerators</link>
|
||||
</term>
|
||||
<listitem><para>installing and using keyboard short-cuts.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkItemFactory</term>
|
||||
<listitem><para>an easier way to create menus.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkAccelLabel ##### -->
|
||||
<para>
|
||||
The #GtkAccelLabel-struct struct contains private data only, and
|
||||
should be accessed using the functions below.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_label_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkAccelLabel.
|
||||
</para>
|
||||
|
||||
@string: the label string.
|
||||
@Returns: a new #GtkAccelLabel.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_label_set_accel_widget ##### -->
|
||||
<para>
|
||||
Sets the widget whose accelerators are to be shown.
|
||||
</para>
|
||||
|
||||
@accel_label: a #GtkAccelLabel.
|
||||
@accel_widget: the widget whose accelerators are to be displayed.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_label_get_accel_width ##### -->
|
||||
<para>
|
||||
Returns the width needed to display the accelerator key(s).
|
||||
This is used by menus to align all of the #GtkMenuItem widgets, and shouldn't
|
||||
be needed by applications.
|
||||
</para>
|
||||
|
||||
@accel_label: a #GtkAccelLabel.
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_accel_label_refetch ##### -->
|
||||
<para>
|
||||
Recreates the string representing the accelerator keys.
|
||||
This should not be needed since the string is automatically updated whenever
|
||||
accelerators are added or removed from the associated widget.
|
||||
</para>
|
||||
|
||||
@accel_label: a #GtkAccelLabel.
|
||||
@Returns: always returns FALSE.
|
||||
|
||||
|
||||
<!-- ##### ARG GtkAccelLabel:accel_widget ##### -->
|
||||
<para>
|
||||
The widget whose accelerators are to be shown by the #GtkAccelLabel.
|
||||
</para>
|
||||
|
||||
@@ -1,154 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkAdjustment
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a #GtkObject representing an adjustable bounded value.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkAdjustment object represents a value which has an associated lower
|
||||
and upper bound, together with step and page increments, and a page size.
|
||||
It is used within several GTK+ widgets, including
|
||||
#GtkSpinButton, #GtkViewport, and #GtkRange (which is a base class for
|
||||
#GtkHScrollbar, #GtkVScrollbar, #GtkHScale, and #GtkVScale).
|
||||
</para>
|
||||
<para>
|
||||
The #GtkAdjustment object does not update the value itself. Instead
|
||||
it is left up to the owner of the #GtkAdjustment to control the value.
|
||||
</para>
|
||||
<para>
|
||||
The owner of the #GtkAdjustment typically calls the
|
||||
gtk_adjustment_value_changed() and gtk_adjustment_changed() functions
|
||||
after changing the value and its bounds. This results in the emission of the
|
||||
"value_changed" or "changed" signal respectively.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkAdjustment ##### -->
|
||||
<para>
|
||||
The #GtkAdjustment-struct struct contains the following fields.
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#gfloat lower;</entry>
|
||||
<entry>the minimum value.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gfloat upper;</entry>
|
||||
<entry>the maximum value.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gfloat value;</entry>
|
||||
<entry>the current value.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gfloat step_increment;</entry>
|
||||
<entry>the increment to use to make minor changes to the value.
|
||||
In a #GtkScrollbar this increment is used when the mouse is clicked on the
|
||||
arrows at the top and bottom of the scrollbar, to scroll by a small amount.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gfloat page_increment;</entry>
|
||||
<entry>the increment to use to make major changes to the value.
|
||||
In a #GtkScrollbar this increment is used when the mouse is clicked in the
|
||||
trough, to scroll by a large amount.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gfloat page_size;</entry>
|
||||
<entry>the page size.
|
||||
In a #GtkScrollbar this is the size of the area which is currently visible.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_adjustment_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkAdjustment.
|
||||
</para>
|
||||
|
||||
@value: the initial value.
|
||||
@lower: the minimum value.
|
||||
@upper: the maximum value.
|
||||
@step_increment: the step increment.
|
||||
@page_increment: the page increment.
|
||||
@page_size: the page size.
|
||||
@Returns: a new #GtkAdjustment.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_adjustment_set_value ##### -->
|
||||
<para>
|
||||
Sets the #GtkAdjustment value.
|
||||
</para>
|
||||
|
||||
@adjustment: a #GtkAdjustment.
|
||||
@value: the new value.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_adjustment_clamp_page ##### -->
|
||||
<para>
|
||||
Updates the #GtkAdjustment @value to ensure that the range between @lower
|
||||
and @upper is in the current page (i.e. between @value and @value +
|
||||
@page_size).
|
||||
If the range is larger than the page size, then only the start of it will
|
||||
be in the current page.
|
||||
A "changed" signal will be emitted if the value is changed.
|
||||
</para>
|
||||
|
||||
@adjustment: a #GtkAdjustment.
|
||||
@lower: the lower value.
|
||||
@upper: the upper value.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_adjustment_changed ##### -->
|
||||
<para>
|
||||
Emits a "changed" signal from the #GtkAdjustment.
|
||||
This is typically called by the owner of the #GtkAdjustment after it has
|
||||
changed any of the #GtkAdjustment fields other than the value.
|
||||
</para>
|
||||
|
||||
@adjustment:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_adjustment_value_changed ##### -->
|
||||
<para>
|
||||
Emits a "value_changed" signal from the #GtkAdjusmtent.
|
||||
This is typically called by the owner of the #GtkAdjustment after it has
|
||||
changed the #GtkAdjustment value field.
|
||||
</para>
|
||||
|
||||
@adjustment:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GtkAdjustment::changed ##### -->
|
||||
<para>
|
||||
Emitted when one or more of the #GtkAdjustment fields have been changed,
|
||||
other than the value field.
|
||||
</para>
|
||||
|
||||
@adjustment: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkAdjustment::value-changed ##### -->
|
||||
<para>
|
||||
Emitted when the #GtkAdjustment value field has been changed.
|
||||
</para>
|
||||
|
||||
@adjustment: the object which received the signal.
|
||||
|
||||
@@ -1,99 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkAlignment
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a widget which controls the alignment and size of its child.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkAlignment widget controls the alignment and size of its child widget.
|
||||
It has four settings: xscale, yscale, xalign, and yalign.
|
||||
</para>
|
||||
<para>
|
||||
The scale settings are used to specify how much the child widget should
|
||||
expand to fill the space allocated to the #GtkAlignment.
|
||||
The values can range from 0 (meaning the child doesn't expand at all) to
|
||||
1 (meaning the child expands to fill all of the available space).
|
||||
</para>
|
||||
<para>
|
||||
The align settings are used to place the child widget within the available
|
||||
area. The values range from 0 (top or left) to 1 (bottom or right).
|
||||
Of course, if the scale settings are both set to 1, the alignment settings
|
||||
have no effect.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkAlignment ##### -->
|
||||
<para>
|
||||
The #GtkAlignment-struct struct contains private data only, and should
|
||||
be accessed using the functions below.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_alignment_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkAlignment.
|
||||
</para>
|
||||
|
||||
@xalign: the horizontal alignment of the child widget, from 0 (left) to 1
|
||||
(right).
|
||||
@yalign: the vertical alignment of the child widget, from 0 (top) to 1
|
||||
(bottom).
|
||||
@xscale: the amount that the child widget expands horizontally to fill up
|
||||
unused space, from 0 to 1.
|
||||
A value of 0 indicates that the child widget should never expand.
|
||||
A value of 1 indicates that the child widget will expand to fill all of the
|
||||
space allocated for the #GtkAlignment.
|
||||
@yscale: the amount that the child widget expands vertically to fill up
|
||||
unused space, from 0 to 1. The values are similar to @xscale.
|
||||
@Returns: the new #GtkAlignment.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_alignment_set ##### -->
|
||||
<para>
|
||||
Sets the #GtkAlignment values.
|
||||
</para>
|
||||
|
||||
@alignment: a #GtkAlignment.
|
||||
@xalign: the horizontal alignment of the child widget, from 0 (left) to 1
|
||||
(right).
|
||||
@yalign: the vertical alignment of the child widget, from 0 (top) to 1
|
||||
(bottom).
|
||||
@xscale: the amount that the child widget expands horizontally to fill up
|
||||
unused space, from 0 to 1.
|
||||
A value of 0 indicates that the child widget should never expand.
|
||||
A value of 1 indicates that the child widget will expand to fill all of the
|
||||
space allocated for the #GtkAlignment.
|
||||
@yscale: the amount that the child widget expands vertically to fill up
|
||||
unused space, from 0 to 1. The values are similar to @xscale.
|
||||
|
||||
|
||||
<!-- ##### ARG GtkAlignment:xalign ##### -->
|
||||
<para>
|
||||
the horizontal alignment of the child widget, from 0 (left) to 1 (right).
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkAlignment:yalign ##### -->
|
||||
<para>
|
||||
the vertical alignment of the child widget, from 0 (top) to 1 (bottom).
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkAlignment:xscale ##### -->
|
||||
<para>
|
||||
the amount that the child widget expands horizontally to fill up
|
||||
unused space, from 0 to 1.
|
||||
A value of 0 indicates that the child widget should never expand.
|
||||
A value of 1 indicates that the child widget will expand to fill all of the
|
||||
space allocated for the #GtkAlignment.
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkAlignment:yscale ##### -->
|
||||
<para>
|
||||
the amount that the child widget expands vertically to fill up
|
||||
unused space, from 0 to 1. The values are similar to @xscale.
|
||||
</para>
|
||||
|
||||
@@ -1,202 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Implementation of Object Properties
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Utility function to manipulate lists of named, typed arguments.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
All the functions in here are marked a Non-public.
|
||||
We describe it anyway because it is occasionally useful
|
||||
to understand how the work is done.
|
||||
</para>
|
||||
<para>
|
||||
Arguments are a way of describing a named parameter to a function.
|
||||
They have two important roles within gtk+:
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
they describe <wordasword>object properties</wordasword>.
|
||||
This means that they present an interface to get and set a named-type
|
||||
for any type of object in a consistent way.
|
||||
(All the relevant functions to do this start with gtk_object_set
|
||||
or gtk_object_get).
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
they describe <wordasword>signal arguments</wordasword>.
|
||||
This is a lot less often needed but still useful.
|
||||
Usually if you are just emitting or creating a particular signal
|
||||
it is more convenient to just use gtk_signal_emit() or gtk_signal_new().
|
||||
However if you are writing a function to emit or create an arbitrary
|
||||
signal, you must use gtk_signal_emitv() or gtk_signal_newv().
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
#GtkObject.
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkArgInfo ##### -->
|
||||
<para>
|
||||
A structure containing information about the argument.
|
||||
Returned by gtk_arg_get_info().
|
||||
</para>
|
||||
|
||||
@class_type: if the argument is an object, this is the object class type.
|
||||
@name: the name of the argument.
|
||||
@type: the type of the argument; it may be an object's type
|
||||
or a fundamental type.
|
||||
@arg_flags: flags applicable to the argument (i.e. readable, writable,
|
||||
and whether it needs to be constructed).
|
||||
@full_name: the object name and argument name separated by ::,
|
||||
e.g. "GtkObject::user_data" or "GtkButton::label".
|
||||
@arg_id: the unique argument identified.
|
||||
@seq_id: ???
|
||||
|
||||
<!-- ##### FUNCTION gtk_arg_new ##### -->
|
||||
<para>
|
||||
Creates a new argument of a certain type, set to 0 or NULL.
|
||||
</para>
|
||||
|
||||
@arg_type: the type of the argument.
|
||||
@Returns: the newly created #GtkArg.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_arg_copy ##### -->
|
||||
<para>
|
||||
It will either copy data into an existing argument or allocate a new argument
|
||||
and copy the data. Strings are duplicated. All other pointers and
|
||||
values are copied (shallowly-- that is the pointers themselves are
|
||||
copied, not the data they point to.)
|
||||
</para>
|
||||
<para>
|
||||
You should call gtk_arg_reset() on dest_arg before calling this
|
||||
if the argument may contain string data that you want freed.
|
||||
</para>
|
||||
|
||||
@src_arg: the argument to duplicate.
|
||||
@dest_arg: the argument to copy over (or NULL to create a new #GtkArg).
|
||||
@Returns: the new #GtkArg (or dest_arg, if it was not NULL).
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_arg_free ##### -->
|
||||
<para>
|
||||
Frees the argument, and optionally its contents.
|
||||
</para>
|
||||
|
||||
@arg: the argument to free.
|
||||
@free_contents: whether to free the string, if it is a string.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_args_collect ##### -->
|
||||
<para>
|
||||
Private: given a hashtable of argument information it takes a vararg
|
||||
list and parses it into arguments (in the form of lists of #GtkArgs
|
||||
and lists of #GtkArgInfos.
|
||||
</para>
|
||||
<para>
|
||||
The list of arguments starts with first_arg_name then the first argument's
|
||||
value. Followed by any number of additional name/argument pairs,
|
||||
terminated with NULL.
|
||||
</para>
|
||||
|
||||
@object_type: the type of object we are collecting arguments for.
|
||||
@arg_info_hash_table: a hashtable mapping from names of arguments
|
||||
to their #GtkArgInfos.
|
||||
@arg_list_p: a returned list of arguments obtained from parsing the
|
||||
varargs.
|
||||
@info_list_p: a returned list of the #GtkArgInfos.
|
||||
@first_arg_name: the name of the first argument.
|
||||
@var_args: a va_list containing the value of the first argument,
|
||||
followed by name/value pairs, followed by NULL.
|
||||
@Returns: an error message on failure, or NULL otherwise.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_args_collect_cleanup ##### -->
|
||||
<para>
|
||||
Private: erase lists of arguments returned from gtk_args_collect().
|
||||
</para>
|
||||
|
||||
@arg_list: arg_list_p returned from gtk_args_collect().
|
||||
@info_list: info_list_p returned from gtk_args_collect().
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_arg_get_info ##### -->
|
||||
<para>
|
||||
Private: get information about an argument.
|
||||
</para>
|
||||
|
||||
@object_type: the type of object.
|
||||
@arg_info_hash_table: the hashtable of #GtkArgInfos.
|
||||
@arg_name: the name of the argument to lookup.
|
||||
@info_p: the argument info.
|
||||
@Returns: an error message on failure, or NULL otherwise.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_arg_type_new_static ##### -->
|
||||
<para>
|
||||
Create a new argument registered with a class.
|
||||
</para>
|
||||
|
||||
@base_class_type: the basic type having the arguments, almost alway
|
||||
GTK_TYPE_OBJECT, except if your defining a different type argument
|
||||
that gets a different namespace. #GtkContainer does this to define
|
||||
per-child arguments of the container.
|
||||
@arg_name: name of the argument to create. (must be a static constant string)
|
||||
@class_n_args_offset: offset into the base class structure that tells
|
||||
the number of arguments.
|
||||
@arg_info_hash_table: hashtable of #GtkArgInfos.
|
||||
@arg_type: type of the argument.
|
||||
@arg_flags: flags of the argument.
|
||||
@arg_id: ???
|
||||
@Returns: the new #GtkArgInfo.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_args_query ##### -->
|
||||
<para>
|
||||
Private: from a class type and its arginfo hashtable,
|
||||
get an array of #GtkArgs that this object accepts.
|
||||
</para>
|
||||
|
||||
@class_type: the class type.
|
||||
@arg_info_hash_table: the hashtable of #GtkArgInfos.
|
||||
@arg_flags: returned array of argument flags.
|
||||
@n_args_p: the number of arguments this object accepts.
|
||||
@Returns: the array of arguments (or NULL on error).
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_arg_name_strip_type ##### -->
|
||||
<para>
|
||||
Given a fully qualified argument name (e.g. "GtkButton::label")
|
||||
it returns just the argument name (e.g. "label") unless
|
||||
the argument name was invalid, in which case it returns NULL.
|
||||
</para>
|
||||
|
||||
@arg_name: the fully-qualified argument name.
|
||||
@Returns: the base argument name.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_arg_info_equal ##### -->
|
||||
<para>
|
||||
A #GCompareFunc for hashing #GtkArgInfos.
|
||||
</para>
|
||||
|
||||
@arg_info_1: a #GtkArgInfo.
|
||||
@arg_info_2: a #GtkArgInfo.
|
||||
@Returns: whether the arguments are the same.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_arg_info_hash ##### -->
|
||||
<para>
|
||||
A #GHashFunc for hashing #GtkArgInfos.
|
||||
</para>
|
||||
|
||||
@arg_info: a #GtkArgInfo.
|
||||
@Returns: a hash value for that #GtkArgInfo.
|
||||
|
||||
|
||||
@@ -1,89 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkArrow
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
produces an arrow pointing in one of the four cardinal directions.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
GtkArrow should be used to draw simple arrows that need to point in
|
||||
one of the four cardinal directions (up, down, left, or right). The
|
||||
style of the arrow can be one of shadow in, shadow out, etched in, or
|
||||
etched out. Note that these directions and style types may be
|
||||
ammended in versions of Gtk to come.
|
||||
</para>
|
||||
<para>
|
||||
GtkArrow will fill any space alloted to it, but since it is inherited
|
||||
from #GtkMisc, it can be padded and/or aligned, to fill exactly the
|
||||
space the programmer desires.
|
||||
</para>
|
||||
<para>
|
||||
Arrows are created with a call to gtk_arrow_new(). The direction or
|
||||
style of an arrow can be changed after creation by using gtk_arrow_set().
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term>gtk_paint_arrow()</term>
|
||||
<listitem><para>the function used internally to paint the arrow.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkArrow ##### -->
|
||||
<para>
|
||||
The #GtkArrow-struct containes the following fields.
|
||||
(These fields should be considered read-only. They should never be set by
|
||||
an application.)
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#gint16 <structfield>arrow_type</structfield>;</entry>
|
||||
<entry>the direction of the arrow, one of #GtkArrowType.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gint16 <structfield>shadow_type</structfield>;</entry>
|
||||
<entry>the style of the arrow, one of #GtkShadowType.</entry>
|
||||
</row>
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_arrow_new ##### -->
|
||||
<para>
|
||||
Creates a new arrow widget.
|
||||
</para>
|
||||
|
||||
@arrow_type: a valid #GtkArrowType.
|
||||
@shadow_type: a valid #GtkShadowType.
|
||||
@Returns: the new #GtkArrow widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_arrow_set ##### -->
|
||||
<para>
|
||||
Sets the direction and style of the #GtkArrow, @arrow.
|
||||
</para>
|
||||
|
||||
@arrow: a widget of type #GtkArrow.
|
||||
@arrow_type: a valid #GtkArrowType.
|
||||
@shadow_type: a valid #GtkShadowType.
|
||||
|
||||
|
||||
<!-- ##### ARG GtkArrow:arrow_type ##### -->
|
||||
<para>
|
||||
the arrow direction, one of #GtkArrowType.
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkArrow:shadow_type ##### -->
|
||||
<para>
|
||||
the arrow style, one of #GtkShadowType.
|
||||
</para>
|
||||
|
||||
@@ -1,65 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkAspectFrame
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
A frame that constrains its child to a particular aspect ratio.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkAspectFrame is useful when you want
|
||||
pack a widget so that it can resize but always retains
|
||||
the same aspect ratio. For instance, one might be
|
||||
drawing a small preview of a larger image. #GtkAspectFrame
|
||||
derives from #GtkFrame, so it can draw a label and
|
||||
a frame around the child. The frame will be
|
||||
"shrink-wrapped" to the size of the child.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkAspectFrame ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_aspect_frame_new ##### -->
|
||||
<para>
|
||||
Create a new #GtkAspectFrame.
|
||||
</para>
|
||||
|
||||
@label: Label text.
|
||||
@xalign: Horizontal alignment of the child within the allocation of
|
||||
the #GtkAspectFrame. This ranges from 0.0 (left aligned)
|
||||
to 1.0 (right aligned)
|
||||
@yalign: Vertical alignment of the child within the allocation of
|
||||
the #GtkAspectFrame. This ranges from 0.0 (left aligned)
|
||||
to 1.0 (right aligned)
|
||||
@ratio: The desired aspect ratio.
|
||||
@obey_child: If %TRUE, @ratio is ignored, and the aspect
|
||||
ratio is taken from the requistion of the child.
|
||||
@Returns: the new #GtkAspectFrame.
|
||||
<!-- # Unused Parameters # -->
|
||||
@ratio: The desired aspect ratio.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_aspect_frame_set ##### -->
|
||||
<para>
|
||||
Set parameters for an existing #GtkAspectFrame.
|
||||
</para>
|
||||
|
||||
@aspect_frame: a #GtkAspectFrame
|
||||
@xalign: Horizontal alignment of the child within the allocation of
|
||||
the #GtkAspectFrame. This ranges from 0.0 (left aligned)
|
||||
to 1.0 (right aligned)
|
||||
@yalign: Vertical alignment of the child within the allocation of
|
||||
the #GtkAspectFrame. This ranges from 0.0 (left aligned)
|
||||
to 1.0 (right aligned)
|
||||
@ratio: The desired aspect ratio.
|
||||
@obey_child: If %TRUE, @ratio is ignored, and the aspect
|
||||
ratio is taken from the requistion of the child.
|
||||
|
||||
|
||||
@@ -1,202 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkButtonBox
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Base class for #GtkHButtonBox and #GtkVButtonBox
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The primary purpose of this class is to keep track of the various properties
|
||||
of #GtkHButtonBox and #GtkVButtonBox widgets.
|
||||
</para>
|
||||
<para>
|
||||
gtk_button_box_get_child_size_default() retrieves the default minimum width and height
|
||||
for widgets in any button box. gtk_button_box_set_child_size_default()
|
||||
changes the default minimum child widget size.
|
||||
</para>
|
||||
<para>
|
||||
gtk_button_box_get_child_size() retrieves the minimum width and height
|
||||
for widgets in a given button box. gtk_button_box_set_child_size()
|
||||
allows those properties to be changed.
|
||||
</para>
|
||||
<para>
|
||||
gtk_button_box_get_child_ipadding_default() gets the default number of pixels of
|
||||
horizontal and vertical padding that are applied to each button in every button box.
|
||||
gtk_button_box_set_child_ipadding_default() allows these defaults to be
|
||||
changed.
|
||||
</para>
|
||||
<para>
|
||||
The internal padding of buttons can be retrieved and changed per button box using
|
||||
gtk_button_box_get_child_ipadding() and gtk_button_box_set_child_ipadding()
|
||||
respectively.
|
||||
</para>
|
||||
<para>
|
||||
gtk_button_box_get_spacing() and gtk_button_box_set_spacing() retrieve and
|
||||
change default number of pixels between buttons, respectively.
|
||||
</para>
|
||||
<para>
|
||||
gtk_button_box_get_layout() and gtk_button_box_set_layout() retrieve and alter the method
|
||||
used to spread the buttons in a button box across the container, respectively.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>#GtkVButtonBox</term>
|
||||
<listitem><para>Vertical sub-class of #GtkButtonBox.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>#GtkHButtonBox</term>
|
||||
<listitem><para>Horizontal sub-class of #GtkButtonBox.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkButtonBox ##### -->
|
||||
<para>
|
||||
This is a read-only struct; no members should be modified directly.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GTK_BUTTONBOX_DEFAULT ##### -->
|
||||
<para>
|
||||
Used internally only.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_get_child_size_default ##### -->
|
||||
<para>
|
||||
Retrieves the default minimum width and height for all button boxes, and
|
||||
places the values in @min_width and @min_height, respectively.
|
||||
</para>
|
||||
|
||||
@min_width: the default minimum width of a child widget.
|
||||
@min_height: the default minimum height of a child widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_get_child_ipadding_default ##### -->
|
||||
<para>
|
||||
The internal padding of a button is the amount of space between the outside
|
||||
of the button and the widget it contains. This function gets the default
|
||||
amount of horizontal and vertical padding, placing the results in @ipad_x
|
||||
and @ipad_y, respectively.
|
||||
</para>
|
||||
|
||||
@ipad_x: the default horizontal internal button padding.
|
||||
@ipad_y: the default vertical internal button padding.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_set_child_size_default ##### -->
|
||||
<para>
|
||||
Sets the default size of child buttons.
|
||||
</para>
|
||||
|
||||
@min_width: minimum default width for child buttons.
|
||||
@min_height: minimum default height for child buttons.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_set_child_ipadding_default ##### -->
|
||||
<para>
|
||||
Sets the default number of pixels that pad each button in every button box.
|
||||
</para>
|
||||
|
||||
@ipad_x: new default horizontal padding.
|
||||
@ipad_y: new default vertical padding.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_get_spacing ##### -->
|
||||
<para>
|
||||
Retrieves how much space a button box is placing between each child button.
|
||||
</para>
|
||||
|
||||
@widget: a #GtkButtonBox.
|
||||
@Returns: the current spacing applied to the buttons in @widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_get_layout ##### -->
|
||||
<para>
|
||||
Retrieves the method being used to arrange the buttons in a button box.
|
||||
</para>
|
||||
|
||||
@widget: a #GtkButtonBox.
|
||||
@Returns: the method used to layout buttons in @widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_get_child_size ##### -->
|
||||
<para>
|
||||
Retrieves the current width and height of all child widgets in a button box.
|
||||
@min_width and @min_height are filled with those values, respectively.
|
||||
</para>
|
||||
|
||||
@widget: a #GtkButtonBox.
|
||||
@min_width: the width of the buttons contained by @widget.
|
||||
@min_height: the height of the buttons contained by @widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_get_child_ipadding ##### -->
|
||||
<para>
|
||||
Gets the default number of pixels that pad the buttons in a given button box.
|
||||
</para>
|
||||
|
||||
@widget: a #GtkButtonBox.
|
||||
@ipad_x: the horizontal padding used by buttons in @widget.
|
||||
@ipad_y: the vertical padding used by buttons in @widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_set_spacing ##### -->
|
||||
<para>
|
||||
Sets the amount of spacing between buttons in a given button box.
|
||||
</para>
|
||||
|
||||
@widget: a #GtkButtonBox.
|
||||
@spacing: the number of pixels of spacing.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_set_layout ##### -->
|
||||
<para>
|
||||
Changes the way buttons are arranged in their container.
|
||||
</para>
|
||||
|
||||
@widget: a #GtkButtonBox.
|
||||
@layout_style: the new layout style.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_set_child_size ##### -->
|
||||
<para>
|
||||
Sets a new default size for the children of a given button box.
|
||||
</para>
|
||||
|
||||
@widget: a #GtkButtonBox.
|
||||
@min_width: a default width for buttons in @widget.
|
||||
@min_height: a default height for buttons in @widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_set_child_ipadding ##### -->
|
||||
<para>
|
||||
Changes the amount of internal padding used by all buttons in a given button
|
||||
box.
|
||||
</para>
|
||||
|
||||
@widget: a #GtkButtonBox.
|
||||
@ipad_x: the horizontal padding that should be used by each button in @widget.
|
||||
@ipad_y: the vertical padding that should be used by each button in @widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_box_child_requisition ##### -->
|
||||
<para>
|
||||
This is an internally used function and should never be called from an
|
||||
application.
|
||||
</para>
|
||||
|
||||
@widget:
|
||||
@nvis_children:
|
||||
@width:
|
||||
@height:
|
||||
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkBin
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a container with just one child.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkBin widget is a container with just one child.
|
||||
It is not very useful itself, but it is useful for deriving subclasses,
|
||||
since it provides common code needed for handling a single child widget.
|
||||
</para>
|
||||
<para>
|
||||
Many GTK+ widgets are subclasses of #GtkBin, including #GtkWindow, #GtkButton,
|
||||
#GtkFrame, #GtkHandleBox, and #GtkScrolledWindow.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkBin ##### -->
|
||||
<para>
|
||||
The #GtkBin-struct struct contains the following fields.
|
||||
(These fields should be considered read-only. They should never be set by
|
||||
an application.)
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#GtkWidget *child;</entry>
|
||||
<entry>the child widget.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
@@ -1,243 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Bindings
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkPatternSpec ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@match_type:
|
||||
@pattern_length:
|
||||
@pattern:
|
||||
@pattern_reversed:
|
||||
@user_data:
|
||||
@seq_id:
|
||||
|
||||
<!-- ##### FUNCTION gtk_pattern_spec_init ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@pattern:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_pattern_spec_free_segs ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_pattern_match ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@string_length:
|
||||
@string:
|
||||
@string_reversed:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_pattern_match_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pspec:
|
||||
@string:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_pattern_match_simple ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pattern:
|
||||
@string:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### STRUCT GtkBindingSet ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@set_name:
|
||||
@priority:
|
||||
@widget_path_pspecs:
|
||||
@widget_class_pspecs:
|
||||
@class_branch_pspecs:
|
||||
@entries:
|
||||
@current:
|
||||
|
||||
<!-- ##### STRUCT GtkBindingEntry ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@keyval:
|
||||
@modifiers:
|
||||
@binding_set:
|
||||
@destroyed:
|
||||
@in_emission:
|
||||
@set_next:
|
||||
@hash_next:
|
||||
@signals:
|
||||
|
||||
<!-- ##### STRUCT GtkBindingSignal ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@next:
|
||||
@signal_name:
|
||||
@n_args:
|
||||
@args:
|
||||
|
||||
<!-- ##### STRUCT GtkBindingArg ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@arg_type:
|
||||
|
||||
<!-- ##### FUNCTION gtk_binding_set_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@set_name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_binding_set_by_class ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object_class:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_binding_set_find ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@set_name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_bindings_activate ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@keyval:
|
||||
@modifiers:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_binding_set_activate ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@binding_set:
|
||||
@keyval:
|
||||
@modifiers:
|
||||
@object:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### MACRO gtk_binding_entry_add ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_binding_entry_clear ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@binding_set:
|
||||
@keyval:
|
||||
@modifiers:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_binding_entry_add_signal ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@binding_set:
|
||||
@keyval:
|
||||
@modifiers:
|
||||
@signal_name:
|
||||
@n_args:
|
||||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_binding_set_add_path ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@binding_set:
|
||||
@path_type:
|
||||
@path_pattern:
|
||||
@priority:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_binding_entry_remove ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@binding_set:
|
||||
@keyval:
|
||||
@modifiers:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_binding_entry_add_signall ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@binding_set:
|
||||
@keyval:
|
||||
@modifiers:
|
||||
@signal_name:
|
||||
@binding_args:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_binding_parse_binding ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@scanner:
|
||||
@Returns:
|
||||
|
||||
|
||||
@@ -1,366 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkBox
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a base class for box containers
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
GtkBox is an abstract widget which encapsulates functionallity for a
|
||||
particular kind of container, one that organizes a variable number of
|
||||
widgets into a rectangular area. GtkBox currently has two derived
|
||||
classes, #GtkHBox and #GtkVBox.
|
||||
</para>
|
||||
<para>
|
||||
The rectangular area of a GtkBox is organized into either a single row
|
||||
or a single column of child widgets depending upon whether the box is
|
||||
of type #GtkHBox or #GtkVBox, respectively. Thus, all children of a
|
||||
GtkBox are allocated one dimension in common, which is the height of a
|
||||
row, or the width of a column.
|
||||
</para>
|
||||
<para>
|
||||
GtkBox uses a notion of <emphasis>packing</emphasis>. Packing refers to
|
||||
adding widgets with reference to a particular position in a
|
||||
#GtkContainer. For a GtkBox, there are two reference positions: the
|
||||
<emphasis>start</emphasis> and the <emphasis>end</emphasis> of the box. For a
|
||||
#GtkVBox, the start is defined as the top of the box and the end is
|
||||
defined as the bottom. For a #GtkHBox the start is defined as the
|
||||
left side and the end is defined as the right side.
|
||||
</para>
|
||||
<para>
|
||||
Use repeated calls to gtk_box_pack_start() to pack widgets into a
|
||||
GtkBox from start to end. Use gtk_box_pack_end() to add widgets from
|
||||
end to start. You may intersperse these calls and add widgets from
|
||||
both ends of the same GtkBox.
|
||||
</para>
|
||||
<para>
|
||||
Use gtk_box_pack_start_defaults() or gtk_box_pack_end_defaults()
|
||||
to pack widgets into a GtkBox if you do not need to specify the
|
||||
<structfield>expand</structfield>, <structfield>fill</structfield>, or
|
||||
<structfield>padding</structfield> attributes of the child to be
|
||||
added.
|
||||
</para>
|
||||
<para>
|
||||
Because GtkBox is a #GtkContainer, you may also use
|
||||
gtk_container_add() to insert widgets into the box, and they will be
|
||||
packed as if with gtk_box_pack_start_defaults(). Use
|
||||
gtk_container_remove() to remove widgets from the GtkBox.
|
||||
</para>
|
||||
<para>
|
||||
Use gtk_box_set_homogeneous() to specify whether or not all children
|
||||
of the GtkBox are forced to get the same amount of space.
|
||||
</para>
|
||||
<para>
|
||||
Use gtk_box_set_spacing() to determine how much space will be
|
||||
minimally placed between all children in the GtkBox.
|
||||
</para>
|
||||
<para>
|
||||
Use gtk_box_reorder_child() to move a GtkBox child to a different
|
||||
place in the box.
|
||||
</para>
|
||||
<para>
|
||||
Use gtk_box_set_child_packing() to reset the
|
||||
<structfield>expand</structfield>, <structfield>fill</structfield>,
|
||||
and <structfield>padding</structfield> attributes of any GtkBox child.
|
||||
Use gtk_box_query_child_packing() to query these fields.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkHBox</term>
|
||||
<listitem><para>a derived class that organizes widgets into a row.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkVBox</term>
|
||||
<listitem><para>a derived class that organizes widgets into a column.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkFrame</term>
|
||||
<listitem><para>a #GtkWidget useful for drawing a border around a GtkBox.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkTable</term>
|
||||
<listitem><para>a #GtkContainer for organizing widgets into a grid,
|
||||
rather than independent rows or columns.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkLayout</term>
|
||||
<listitem><para>a #GtkContainer for organizing widgets into arbitrary
|
||||
layouts.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkBox ##### -->
|
||||
<para>
|
||||
The #GtkBox-struct describes an instance of GtkBox and contains the following fields.
|
||||
(These fields should be considered read-only. They should never be set by
|
||||
an application.)
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#GList * <structfield>children</structfield>;</entry>
|
||||
<entry>a list of children belonging the GtkBox. The data is a list of
|
||||
structures of type #GtkBoxChild-struct.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gint16 <structfield>spacing</structfield>;</entry>
|
||||
<entry>the number of pixels to put between children of the GtkBox, zero
|
||||
by default. Use gtk_box_set_spacing() to set this field.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#guint <structfield>homogeneous</structfield>;</entry>
|
||||
<entry>a flag that if %TRUE forces all children to get equal space in
|
||||
the GtkBox; %FALSE by default. Use gtk_box_set_homogeneous() to set this
|
||||
field.</entry>
|
||||
</row>
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GtkBoxChild ##### -->
|
||||
<para>
|
||||
The #GtkBoxChild-struct holds a child widget of GtkBox and describes
|
||||
how the child is to be packed into the GtkBox. Use
|
||||
gtk_box_query_child_packing() and gtk_box_set_child_packing() to query
|
||||
and reset the <structfield>padding</structfield>,
|
||||
<structfield>expand</structfield>, <structfield>fill</structfield>,
|
||||
and <structfield>pack</structfield> fields.
|
||||
</para>
|
||||
<para>
|
||||
#GtkBoxChild-struct contains the following fields. (These fields
|
||||
should be considered read-only. They should never be directly set by an
|
||||
application.)
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#GtkWidget * <structfield>widget</structfield>;</entry>
|
||||
<entry>the child widget, packed into the GtkBox.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#guint16 <structfield>padding</structfield>;</entry>
|
||||
<entry>the number of extra pixels to put between this child and its
|
||||
neighbors, set when packed, zero by default.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#guint <structfield>expand</structfield>;</entry>
|
||||
<entry>flag indicates whether extra space should be given to this
|
||||
child. Any extra space given to the parent GtkBox is divided up among
|
||||
all children with this attribute set to %TRUE; set when packed, %TRUE by
|
||||
default.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#guint <structfield>fill</structfield>;</entry>
|
||||
<entry>flag indicates whether any extra space given to this child due to its
|
||||
<structfield>expand</structfield> attribute being set is actually
|
||||
allocated to the child, rather than being used as padding
|
||||
around the widget; set when packed, %TRUE by default.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#guint <structfield>pack</structfield>;</entry> <entry>one of
|
||||
#GtkPackType indicating whether the child is packed with reference to
|
||||
the start (top/left) or end (bottom/right) of the GtkBox.</entry>
|
||||
</row>
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@widget:
|
||||
@padding:
|
||||
@expand:
|
||||
@fill:
|
||||
@pack:
|
||||
|
||||
<!-- ##### FUNCTION gtk_box_pack_start ##### -->
|
||||
<para>
|
||||
Adds @child to @box, packed with reference to the start of @box. The
|
||||
@child is packed after any other child packed with reference to the
|
||||
start of @box.
|
||||
</para>
|
||||
|
||||
@box: a #GtkBox.
|
||||
@child: the #GtkWidget to be added to @box.
|
||||
@expand: %TRUE if the new child is to be given extra space allocated to
|
||||
@box. The extra space will be divided evenly between all children of
|
||||
@box that use this option.
|
||||
@fill: %TRUE if space given to @child by the @expand option is
|
||||
actually allocated to @child, rather than just padding it. This
|
||||
parameter has no effect if @expand is set to %FALSE. A child is
|
||||
always allocated the full height of a #GtkHBox and the full width of a
|
||||
#GtkVBox. This option affects the other dimension.
|
||||
@padding: extra space in pixels to put between this child and its
|
||||
neighbors, over and above the global amount specified by
|
||||
<structfield>spacing</structfield> in #GtkBox-struct. If @child is a
|
||||
widget at one of the reference ends of @box, then @padding pixels are also put
|
||||
between @child and the reference edge of @box.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_box_pack_end ##### -->
|
||||
<para>
|
||||
Adds @child to @box, packed with reference to the end of @box. The
|
||||
@child is packed after (away from end of) any other child packed with reference to the
|
||||
end of @box.
|
||||
</para>
|
||||
|
||||
@box: a #GtkBox.
|
||||
@child: the #GtkWidget to be added to @box.
|
||||
@expand: %TRUE if the new child is to be given extra space allocated to
|
||||
@box. The extra space will be divided evenly between all children of
|
||||
@box that use this option.
|
||||
@fill: %TRUE if space given to @child by the @expand option is
|
||||
actually allocated to @child, rather than just padding it. This
|
||||
parameter has no effect if @expand is set to %FALSE. A child is
|
||||
always allocated the full height of a #GtkHBox and the full width of a
|
||||
#GtkVBox. This option affects the other dimension.
|
||||
@padding: extra space in pixels to put between this child and its
|
||||
neighbors, over and above the global amount specified by
|
||||
<structfield>spacing</structfield> in #GtkBox-struct. If @child is a
|
||||
widget at one of the reference ends of @box, then @padding pixels are also put
|
||||
between @child and the reference edge of @box.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_box_pack_start_defaults ##### -->
|
||||
<para>
|
||||
Adds @widget to @box, packed with reference to the start of @box. The
|
||||
child is packed after any other child packed with reference to the
|
||||
start of @box.
|
||||
</para>
|
||||
<para>
|
||||
Parameters for how to pack the child @widget,
|
||||
<structfield>expand</structfield>, <structfield>fill</structfield>,
|
||||
and <structfield>padding</structfield> in #GtkBoxChild-struct, are given their default
|
||||
values, %TRUE, %TRUE, and 0, respectively.
|
||||
</para>
|
||||
|
||||
@box: a #GtkBox.
|
||||
@widget: the #GtkWidget to be added to @box.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_box_pack_end_defaults ##### -->
|
||||
<para>
|
||||
Adds @widget to @box, packed with reference to the end of @box. The
|
||||
child is packed after (away from end of) any other child packed with
|
||||
reference to the end of @box.
|
||||
</para>
|
||||
<para>
|
||||
Parameters for how to pack the child @widget,
|
||||
<structfield>expand</structfield>, <structfield>fill</structfield>,
|
||||
and <structfield>padding</structfield> in #GtkBoxChild-struct, are given their default
|
||||
values, %TRUE, %TRUE, and 0, respectively.
|
||||
</para>
|
||||
|
||||
@box: a #GtkBox.
|
||||
@widget: the #GtkWidget to be added to @box.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_box_set_homogeneous ##### -->
|
||||
<para>
|
||||
Sets the <structfield>homogeneous</structfield> field of
|
||||
#GtkBox-struct, controlling whether or not all children of @box are
|
||||
given equal space in the box.
|
||||
</para>
|
||||
|
||||
@box: a #GtkBox.
|
||||
@homogeneous: a boolean value, %TRUE to create equal allotments,
|
||||
%FALSE for variable allotments.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_box_set_spacing ##### -->
|
||||
<para>
|
||||
Sets the <structfield>spacing</structfield> field of #GtkBox-struct,
|
||||
which is the number of pixels to place between children of @box.
|
||||
</para>
|
||||
|
||||
@box: a #GtkBox.
|
||||
@spacing: the number of pixels to put between children.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_box_reorder_child ##### -->
|
||||
<para>
|
||||
Moves @child to a new @position in the list of @box children. The
|
||||
list is the <structfield>children</structfield> field of
|
||||
#GtkBox-struct, and contains both widgets packed #GTK_PACK_START as
|
||||
well as widgets packed #GTK_PACK_END, in the order that these widgets
|
||||
were added to @box.
|
||||
</para>
|
||||
<para>
|
||||
A widget's position in the @box children list determines where the
|
||||
widget is packed into @box. A child widget at some position in the
|
||||
list will be packed just after all other widgets of the same packing
|
||||
type that appear earlier in the list. A negative value of @position is
|
||||
interpreted as position 0.
|
||||
</para>
|
||||
|
||||
@box: a #GtkBox.
|
||||
@child: the #GtkWidget to move.
|
||||
@position: the new position for @child in the
|
||||
<structfield>children</structfield> list of #GtkBox-struct, starting
|
||||
from 0.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_box_query_child_packing ##### -->
|
||||
<para>
|
||||
Returns information about how @child is packed into @box.
|
||||
</para>
|
||||
|
||||
@box: a #GtkBox.
|
||||
@child: the #GtkWidget of the child to query.
|
||||
@expand: the returned value of the <structfield>expand</structfield>
|
||||
field in #GtkBoxChild-struct.
|
||||
@fill: the returned value of the <structfield>fill</structfield> field
|
||||
in #GtkBoxChild-struct.
|
||||
@padding: the returned value of the <structfield>padding</structfield>
|
||||
field in #GtkBoxChild-struct.
|
||||
@pack_type: the returned value of the <structfield>pack</structfield>
|
||||
field in #GtkBoxChild-struct.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_box_set_child_packing ##### -->
|
||||
<para>
|
||||
Sets the way @child is packed into @box.
|
||||
</para>
|
||||
|
||||
@box: a #GtkBox.
|
||||
@child: the #GtkWidget of the child to set.
|
||||
@expand: the new value of the <structfield>expand</structfield> field
|
||||
in #GtkBoxChild-struct.
|
||||
@fill: the new value of the <structfield>fill</structfield> field in
|
||||
#GtkBoxChild-struct.
|
||||
@padding: the new value of the <structfield>padding</structfield>
|
||||
field in #GtkBoxChild-struct.
|
||||
@pack_type: the new value of the <structfield>pack</structfield> field
|
||||
in #GtkBoxChild-struct.
|
||||
|
||||
|
||||
<!-- ##### ARG GtkBox:spacing ##### -->
|
||||
<para>
|
||||
the minimum amount of space to put between children. Refers to the
|
||||
<structfield>spacing</structfield> field of #GtkBox-struct.
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkBox:homogeneous ##### -->
|
||||
<para>
|
||||
how to allocate space for children, equally or variably. Refers to
|
||||
the <structfield>homogeneous</structfield> field of #GtkBox-struct.
|
||||
</para>
|
||||
|
||||
@@ -1,158 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkButton
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
A widget that creates a signal when clicked on.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkButton widget is generally used to attach a function to that
|
||||
is called when the button is pressed. The various signals and how to use
|
||||
them are outlined below.
|
||||
</para>
|
||||
<para>
|
||||
The #GtkButton widget can hold any valid child widget. That is it can
|
||||
hold most any other standard #GtkWidget. The most commonly used child is
|
||||
the #GtkLabel.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkButton ##### -->
|
||||
<para>
|
||||
This should not be accessed directly. Use the accessor functions below.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkButton widget.
|
||||
</para>
|
||||
|
||||
@Returns: The newly created #GtkButton widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_new_with_label ##### -->
|
||||
<para>
|
||||
Creates a #GtkButton widget with a #GtkLabel child containing the given
|
||||
text.
|
||||
</para>
|
||||
|
||||
@label: The text you want the #GtkLabel to hold.
|
||||
@Returns: The newly created #GtkButton widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_pressed ##### -->
|
||||
<para>
|
||||
Emits a #GtkButton::pressed signal to the given #GtkButton.
|
||||
</para>
|
||||
|
||||
@button: The #GtkButton you want to send the signal to.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_released ##### -->
|
||||
<para>
|
||||
Emits a #GtkButton::released signal to the given #GtkButton.
|
||||
</para>
|
||||
|
||||
@button: The #GtkButton you want to send the signal to.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_clicked ##### -->
|
||||
<para>
|
||||
Emits a #GtkButton::clicked signal to the given #GtkButton.
|
||||
</para>
|
||||
|
||||
@button: The #GtkButton you want to send the signal to.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_enter ##### -->
|
||||
<para>
|
||||
Emits a #GtkButton::enter signal to the given #GtkButton.
|
||||
</para>
|
||||
|
||||
@button: The #GtkButton you want to send the signal to.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_leave ##### -->
|
||||
<para>
|
||||
Emits a #GtkButton::leave signal to the given #GtkButton.
|
||||
</para>
|
||||
|
||||
@button: The #GtkButton you want to send the signal to.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_set_relief ##### -->
|
||||
<para>
|
||||
Sets the relief style of the edges of the given #GtkButton widget.
|
||||
Three styles exist, GTK_RELIEF_NORMAL, GTK_RELIEF_HALF, GTK_RELIEF_NONE.
|
||||
The default style is, as one can guess, GTK_RELIEF_NORMAL.
|
||||
|
||||
<!-- FIXME: put pictures of each style -->
|
||||
</para>
|
||||
|
||||
@button: The #GtkButton you want to set relief styles of.
|
||||
@newstyle: The GtkReliefStyle as described above.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_button_get_relief ##### -->
|
||||
<para>
|
||||
Returns the current relief style of the given #GtkButton.
|
||||
</para>
|
||||
|
||||
@button: The #GtkButton you want the #GtkReliefStyle from.
|
||||
@Returns: The current #GtkReliefStyle
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GtkButton::pressed ##### -->
|
||||
<para>
|
||||
Emitted when the button is initially pressed.
|
||||
</para>
|
||||
|
||||
@button: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkButton::released ##### -->
|
||||
<para>
|
||||
Emitted when a button which is pressed is released, no matter where the
|
||||
mouse cursor is.
|
||||
</para>
|
||||
|
||||
@button: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkButton::clicked ##### -->
|
||||
<para>
|
||||
Emitted when a button clicked on by the mouse and the cursor stays on the
|
||||
button. If the cursor is not on the button when the mouse button is released,
|
||||
the signal is not emitted.
|
||||
</para>
|
||||
|
||||
@button: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkButton::enter ##### -->
|
||||
<para>
|
||||
Emitted when the mouse cursor enters the region of the button.
|
||||
</para>
|
||||
|
||||
@button: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkButton::leave ##### -->
|
||||
<para>
|
||||
Emitted when the mouse cursor leaves the region of the button.
|
||||
</para>
|
||||
|
||||
@button: the object which received the signal.
|
||||
|
||||
<!-- ##### ARG GtkButton:label ##### -->
|
||||
<para>
|
||||
The text within the child #GtkLabel of the #GtkButton. Only useful if
|
||||
there is actually a #GtkLabel inside of the #GtkButton.
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkButton:relief ##### -->
|
||||
<para>
|
||||
The #GtkReliefStyle as outlined in gtk_button_set_relief().
|
||||
</para>
|
||||
|
||||
@@ -1,240 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkCalendar
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
display a calendar and/or allow the user to select a date.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
#GtkCalendar is a widget that displays a calendar, one month at a time.
|
||||
It can be created with gtk_calendar_new().
|
||||
</para>
|
||||
<para>
|
||||
The month and year currently displayed can be altered with
|
||||
gtk_calendar_select_month(). The exact day can be selected from the displayed
|
||||
month using gtk_calendar_select_day().
|
||||
</para>
|
||||
<para>
|
||||
FIXME: (check)To place a visual marker on a particular day, use
|
||||
gtk_calendar_mark_day() and to remove the marker, gtk_calendar_unmark_day().
|
||||
Alternative, all marks can be cleared with gtk_calendar_clear_marks().
|
||||
</para>
|
||||
<para>
|
||||
The way in which the calendar itself is displayed can be altered using
|
||||
gtk_calendar_display_options().
|
||||
</para>
|
||||
<para>
|
||||
The selected date can be retrieved from a #GtkCalendar using
|
||||
gtk_calendar_get_date().
|
||||
</para>
|
||||
<para>
|
||||
If performing many 'mark' operations, the calendar can be frozen to prevent
|
||||
flicker, using gtk_calendar_freeze(), and 'thawed' again using
|
||||
gtk_calendar_thaw().
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkCalendar ##### -->
|
||||
<para>
|
||||
<structfield>num_marked_dates</structfield> is an integer containing the
|
||||
number of days that have a mark over them.
|
||||
</para>
|
||||
<para>
|
||||
<structfield>marked_date</structfield> is an array containing the day numbers
|
||||
that currently have a mark over them.
|
||||
</para>
|
||||
<para>
|
||||
<structfield>month</structfield>, <structfield>year</structfield>, and
|
||||
<structfield>selected_day</structfield> contain the currently visible month,
|
||||
year, and selected day respectively.
|
||||
</para>
|
||||
<para>
|
||||
All of these fields should be considered read only, and everything in this
|
||||
struct should only be modified using the functions provided below.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### ENUM GtkCalendarDisplayOptions ##### -->
|
||||
<para>
|
||||
<informaltable pgwide=1 frame="none" role="enum">
|
||||
<tgroup cols="2"><colspec colwidth="*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>GTK_CALENDAR_SHOW_HEADING</entry>
|
||||
<entry>Specifies that the month and year should be displayed.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>GTK_CALENDAR_SHOW_DAY_NAMES</entry>
|
||||
<entry>Specifies that three letter day descriptions should be present.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>GTK_CALENDAR_NO_MONTH_CHANGE</entry>
|
||||
<entry>Prevents the user from switching months with the calendar.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>GTK_CALENDAR_SHOW_WEEK_NUMBERS</entry>
|
||||
<entry>Displays each week numbers of the current year, down the left side of
|
||||
the calendar.</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>GTK_CALENDAR_WEEK_START_MONDAY</entry>
|
||||
<entry>Starts the calendar week on Monday, instead of the default Sunday.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@GTK_CALENDAR_SHOW_HEADING:
|
||||
@GTK_CALENDAR_SHOW_DAY_NAMES:
|
||||
@GTK_CALENDAR_NO_MONTH_CHANGE:
|
||||
@GTK_CALENDAR_SHOW_WEEK_NUMBERS:
|
||||
@GTK_CALENDAR_WEEK_START_MONDAY:
|
||||
|
||||
<!-- ##### FUNCTION gtk_calendar_new ##### -->
|
||||
<para>
|
||||
Creates a new calendar. FIXME:default date.
|
||||
</para>
|
||||
|
||||
@Returns: a #GtkCalendar.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_calendar_select_month ##### -->
|
||||
<para>
|
||||
Shifts the calendar to a different month.
|
||||
</para>
|
||||
|
||||
@calendar: a #GtkCalendar.
|
||||
@month: a month number.
|
||||
@year: the year the month is in.
|
||||
@Returns: FIXME.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_calendar_select_day ##### -->
|
||||
<para>
|
||||
Selects a day from the current month.
|
||||
</para>
|
||||
|
||||
@calendar: a #GtkCalendar.
|
||||
@day: the day number to select.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_calendar_mark_day ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@calendar:
|
||||
@day:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_calendar_unmark_day ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@calendar:
|
||||
@day:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_calendar_clear_marks ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@calendar:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_calendar_display_options ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@calendar:
|
||||
@flags:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_calendar_get_date ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@calendar:
|
||||
@year:
|
||||
@month:
|
||||
@day:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_calendar_freeze ##### -->
|
||||
<para>
|
||||
Locks the display of the calendar until it is thawed with gtk_calendar_thaw().
|
||||
</para>
|
||||
|
||||
@calendar: a #GtkCalendar.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_calendar_thaw ##### -->
|
||||
<para>
|
||||
Defrosts a calendar; all the changes made since the last
|
||||
gtk_calendar_freeze() are displayed.
|
||||
</para>
|
||||
|
||||
@calendar: a #GtkCalendar.
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GtkCalendar::month-changed ##### -->
|
||||
<para>
|
||||
Emitted when the user clicks a button to change the selected month on a
|
||||
calendar.
|
||||
</para>
|
||||
|
||||
@calendar: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkCalendar::day-selected ##### -->
|
||||
<para>
|
||||
Emitted when the user selects a day.
|
||||
</para>
|
||||
|
||||
@calendar: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkCalendar::day-selected-double-click ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@calendar: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkCalendar::prev-month ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@calendar: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkCalendar::next-month ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@calendar: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkCalendar::prev-year ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@calendar: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkCalendar::next-year ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@calendar: the object which received the signal.
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkCheckButton
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
create widgets with a discrete toggle button.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
A #GtkCheckButton places a discrete #GtkToggleButton next to a widget, (usually a #GtkLabel). See the section on #GtkToggleButton widgets for more information about toggle/check buttons.
|
||||
</para>
|
||||
<para>
|
||||
The important signal ('toggled') is also inherited from #GtkToggleButton.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>#GtkCheckMenuItem</term>
|
||||
<listitem><para>add check buttons to your menus.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>#GtkButton</term>
|
||||
<listitem><para>a more general button.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>#GtkToggleButton</term>
|
||||
<listitem><para>#GtkCheckButton's parent.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>#GtkRadioButton</term>
|
||||
<listitem><para>group check buttons together.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkCheckButton ##### -->
|
||||
<para>
|
||||
<structfield>toggle_button</structfield> is a #GtkToggleButton representing the actual toggle button that composes the check button.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_check_button_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkCheckButton.
|
||||
</para>
|
||||
|
||||
@Returns: a #GtkWidget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_check_button_new_with_label ##### -->
|
||||
<para>
|
||||
Creates a new #GtkCheckButton with a #GtkLabel to the right of it.
|
||||
</para>
|
||||
|
||||
@label: the text for the check button.
|
||||
@Returns: a #GtkWidget.
|
||||
|
||||
|
||||
@@ -1,108 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkCheckMenuItem
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a menu item with a check box.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
A #GtkCheckMenuItem is a menu item that maintains the state of a boolean
|
||||
value in addition to a #GtkMenuItem's usual role in activating application
|
||||
code.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
A check box indicating the state of the boolean value is displayed
|
||||
at the left side of the #GtkMenuItem. Activating the #GtkMenuItem
|
||||
toggles the value.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkCheckMenuItem ##### -->
|
||||
<para>
|
||||
The #GtkCheckMenuItem-struct struct contains the following fields.
|
||||
(These fields should be considered read-only. They should never be set by
|
||||
an application.)
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#guint active;</entry>
|
||||
<entry>TRUE if the check box is active.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_check_menu_item_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkCheckMenuItem.
|
||||
</para>
|
||||
|
||||
@Returns: a new #GtkCheckMenuItem.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_check_menu_item_new_with_label ##### -->
|
||||
<para>
|
||||
Creates a new #GtkCheckMenuItem with a label.
|
||||
</para>
|
||||
|
||||
@label: the string to use for the label.
|
||||
@Returns: a new #GtkCheckMenuItem.
|
||||
|
||||
|
||||
<!-- ##### MACRO gtk_check_menu_item_set_state ##### -->
|
||||
<para>
|
||||
This macro is provided to preserve compatibility with older code.
|
||||
New code should use gtk_check_menu_item_set_active() function instead.
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_check_menu_item_set_active ##### -->
|
||||
<para>
|
||||
Sets the active state of the menu item's check box.
|
||||
</para>
|
||||
|
||||
@check_menu_item: a #GtkCheckMenuItem.
|
||||
@is_active: boolean value indicating whether the check box is active.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_check_menu_item_set_show_toggle ##### -->
|
||||
<para>
|
||||
Controls whether the check box is shown at all times.
|
||||
Normally the check box is shown only when it is active or while the
|
||||
menu item is selected.
|
||||
</para>
|
||||
|
||||
@menu_item: a #GtkCheckMenuItem.
|
||||
@always: boolean value indicating whether to always show the check box.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_check_menu_item_toggled ##### -->
|
||||
<para>
|
||||
Emits the GtkCheckMenuItem::toggled signal.
|
||||
</para>
|
||||
|
||||
@check_menu_item: a #GtkCheckMenuItem.
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GtkCheckMenuItem::toggled ##### -->
|
||||
<para>
|
||||
This signal is emitted when the state of the check box is changed.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
A signal handler can examine the <structfield>active</structfield>
|
||||
field of the #GtkCheckMenuItem-struct struct to discover the new state.
|
||||
</para>
|
||||
|
||||
@checkmenuitem: the object which received the signal.
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,109 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkColorSelection
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a widget used to select a color.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkColorSelection is a widget that is used to select
|
||||
a color. It consists of a color wheel and number of sliders
|
||||
and entry boxes for color parameters such as hue, saturation,
|
||||
value, red, green, blue, and opacity. It is found on the standard
|
||||
color selection dialog box #GtkColorSelectionDialog.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkColorSelection ##### -->
|
||||
<para>
|
||||
The #GtkColorSelection-struct struct contains private data only,
|
||||
and should be accessed using the functions below.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_color_selection_new ##### -->
|
||||
<para>
|
||||
Create a new #GtkColorSelection.
|
||||
</para>
|
||||
|
||||
@Returns: a #GtkColorSelection.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_color_selection_set_update_policy ##### -->
|
||||
<para>
|
||||
Sets the policy controlling when the color_changed signals are emitted.
|
||||
The available policies are:
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
%GTK_UPDATE_CONTINUOUS - signals are sent continuously as the color
|
||||
selection changes.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
%GTK_UPDATE_DISCONTINUOUS - signals are sent only when the mouse
|
||||
button is released.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
%GTK_UPDATE_DELAYED - signals are sent when the mouse button is
|
||||
released or when the mouse has been motionless for a period of
|
||||
time.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
|
||||
@colorsel: a #GtkColorSelection.
|
||||
@policy: a #GtkUpdateType value indicating the desired policy.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
|
||||
<para>
|
||||
Controls whether opacity can be set with the #GtkColorSelection.
|
||||
If this functionality is enabled, the necessary additional widgets
|
||||
are added to the #GtkColorSelection and the opacity value can be
|
||||
retrieved via the fourth value in the color array returned by
|
||||
the gtk_color_selection_get_color() function.
|
||||
</para>
|
||||
|
||||
@colorsel: a #GtkColorSelection.
|
||||
@use_opacity: a boolean indicating whether the opacity selection
|
||||
is enabled.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_color_selection_set_color ##### -->
|
||||
<para>
|
||||
Sets the color in the #GtkColorSelection. The widgets are updated
|
||||
to reflect the new color.
|
||||
</para>
|
||||
|
||||
@colorsel: a #GtkColorSelection.
|
||||
@color: a color array consisting of 4 gfloat values for red, green,
|
||||
blue, and opacity.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_color_selection_get_color ##### -->
|
||||
<para>
|
||||
Retrieve the currently selected color value.
|
||||
</para>
|
||||
|
||||
@colorsel: a #GtkColorSelection
|
||||
@color: a color array consisting of 4 gfloat values for red, green,
|
||||
blue, and opacity.
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GtkColorSelection::color-changed ##### -->
|
||||
<para>
|
||||
This signal is emitted when the color changes in the #GtkColorSelection
|
||||
according to its update policy.
|
||||
</para>
|
||||
|
||||
@colorselection: the object which received the signal.
|
||||
|
||||
@@ -1,70 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkColorSelectionDialog
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a standard dialog box for selecting a color.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkColorSelectionDialog provides a standard dialog which
|
||||
allows the user to select a color much like the #GtkFileSelection
|
||||
provides a standard dialog for file selection.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkColorSelectionDialog ##### -->
|
||||
<para>
|
||||
The #GtkColorSelectionDialog-struct struct contains the following fields.
|
||||
(These fields should be considered read-only. They should never be set by
|
||||
an application.)
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#GtkWidget *colorsel;</entry>
|
||||
<entry>The #GtkColorSelection widget contained within the
|
||||
dialog. Use this widget and its gtk_color_selection_get_color()
|
||||
function to gain access to the selected color. Connect a handler
|
||||
for this widget's color_changed signal to be notified when the
|
||||
color changes.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GtkWidget *ok_button;</entry>
|
||||
<entry>The OK button widget contained within the dialog.
|
||||
Connect a handler for the clicked event.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GtkWidget *cancel_button;</entry>
|
||||
<entry>The cancel button widget contained within the dialog.
|
||||
Connect a handler for the clicked event.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GtkWidget *help_button;</entry>
|
||||
<entry>The help button widget contained within the dialog.
|
||||
Connect a handler for the clicked event.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_color_selection_dialog_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkColorSelectionDialog.
|
||||
</para>
|
||||
|
||||
@title: a string containing the title text for the dialog.
|
||||
@Returns: a #GtkColorSelectionDialog.
|
||||
@@ -1,204 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkCombo
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a text entry field with a dropdown list.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkCombo widget consists of a single-line text entry field and a drop-down
|
||||
list. The drop-down list is displayed when the user clicks on a small arrow
|
||||
button to the right of the entry field.
|
||||
</para>
|
||||
<para>
|
||||
The drop-down list is a #GtkList widget and can be accessed using the
|
||||
<structfield>list</structfield> member of the #GtkCombo-struct.
|
||||
List elements can contain arbitrary widgets, but if an element is not a
|
||||
plain label, then you must use the gtk_list_set_item_string() function.
|
||||
This sets the string which will be placed in the text entry field when the
|
||||
item is selected.
|
||||
</para>
|
||||
<para>
|
||||
By default, the user can step through the items in the list using the
|
||||
arrow (cursor) keys, though this behaviour can be turned off with
|
||||
gtk_combo_set_use_arrows().
|
||||
</para>
|
||||
<para>
|
||||
Normally the arrow keys are only active when the contents of the text entry
|
||||
field matches one of the items in the list. If the contents of the entry field
|
||||
do not match any of the list items, then pressing the arrow keys does nothing.
|
||||
However, by calling gtk_combo_set_use_arrows_always() you can specify that the
|
||||
arrow keys are always active. If the contents of the entry field does not match
|
||||
any of the items in the list, then pressing the up or down arrow key will set
|
||||
the entry field to the last or first item in the list, respectively.
|
||||
</para>
|
||||
|
||||
<example id="gtkcombo-simple-example">
|
||||
<title>Creating a #GtkCombo widget with simple text items.</title>
|
||||
<programlisting>
|
||||
GtkWidget *combo;
|
||||
GList *items = NULL;
|
||||
|
||||
items = g_list_append (items, "First Item");
|
||||
items = g_list_append (items, "Second Item");
|
||||
items = g_list_append (items, "Third Item");
|
||||
items = g_list_append (items, "Fourth Item");
|
||||
items = g_list_append (items, "Fifth Item");
|
||||
|
||||
combo = gtk_combo_new ();
|
||||
gtk_combo_set_popdown_strings (GTK_COMBO (combo), items);
|
||||
</programlisting>
|
||||
</example>
|
||||
|
||||
<example>
|
||||
<title>Creating a #GtkCombo widget with a complex item.</title>
|
||||
<programlisting>
|
||||
GtkWidget *combo, *item, *hbox, *arrow, *label;
|
||||
|
||||
combo = gtk_combo_new ();
|
||||
|
||||
item = gtk_list_item_new ();
|
||||
gtk_widget_show (item);
|
||||
|
||||
/* You can put almost anything into the GtkListItem widget. Here we will use
|
||||
a horizontal box with an arrow and a label in it. */
|
||||
hbox = gtk_hbox_new (FALSE, 3);
|
||||
gtk_container_add (GTK_CONTAINER (item), hbox);
|
||||
gtk_widget_show (hbox);
|
||||
|
||||
arrow = gtk_arrow_new (GTK_ARROW_RIGHT, GTK_SHADOW_OUT);
|
||||
gtk_widget_show (arrow);
|
||||
gtk_box_pack_start (GTK_BOX (hbox), pixmap, FALSE, FALSE, 0);
|
||||
|
||||
label = gtk_label_new ("First Item");
|
||||
gtk_widget_show (label);
|
||||
gtk_box_pack_start (GTK_BOX (hbox), label, FALSE, FALSE, 0);
|
||||
|
||||
/* You must set the string to display in the entry field when the item is
|
||||
selected. */
|
||||
gtk_combo_set_item_string (GTK_COMBO (combo), GTK_ITEM (item), "1st Item");
|
||||
|
||||
/* Now we simply add the item to the combo's list. */
|
||||
gtk_container_add (GTK_CONTAINER (GTK_COMBO (combo)->list), item);
|
||||
</programlisting>
|
||||
</example>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkCombo ##### -->
|
||||
<para>
|
||||
The #GtkFixedChild-struct struct contains the following fields.
|
||||
(These fields should be considered read-only. They should never be set by
|
||||
an application.)
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#GtkWidget *entry;</entry>
|
||||
<entry>the text entry field.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#GtkWidget *list;</entry>
|
||||
<entry>the list shown in the drop-down window.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_combo_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkCombo.
|
||||
</para>
|
||||
|
||||
@Returns: a new #GtkCombo.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_combo_set_popdown_strings ##### -->
|
||||
<para>
|
||||
Convenience function to set all of the items in the popup list.
|
||||
(See the <link linkend="gtkcombo-simple-example">example</link> above.)
|
||||
</para>
|
||||
|
||||
@combo: a #GtkCombo.
|
||||
@strings: a list of strings.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_combo_set_value_in_list ##### -->
|
||||
<para>
|
||||
Specifies whether the value entered in the text entry field must match one of
|
||||
the values in the list. If this is set then the user will not be able to
|
||||
perform any other action until a valid value has been entered.
|
||||
</para>
|
||||
<para>
|
||||
If an empty field is acceptable, the @ok_if_empty parameter should be TRUE.
|
||||
</para>
|
||||
|
||||
@combo: a #GtkCombo.
|
||||
@val: TRUE if the value entered must match one of the values in the list.
|
||||
@ok_if_empty: TRUE if an empty value is considered valid.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_combo_set_use_arrows ##### -->
|
||||
<para>
|
||||
Specifies if the arrow (cursor) keys can be used to step through the items in
|
||||
the list. This is on by default.
|
||||
</para>
|
||||
|
||||
@combo: a #GtkCombo.
|
||||
@val: TRUE if the arrow keys can be used to step through the items in the list.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_combo_set_use_arrows_always ##### -->
|
||||
<para>
|
||||
Specifies if the arrow keys will still work even if the current contents of the
|
||||
#GtkEntry field do not match any of the list items.
|
||||
</para>
|
||||
|
||||
@combo: a #GtkCombo.
|
||||
@val:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_combo_set_case_sensitive ##### -->
|
||||
<para>
|
||||
Specifies whether the text entered into the #GtkEntry field and the text in
|
||||
the list items is case sensitive.
|
||||
</para>
|
||||
<para>
|
||||
This may be useful, for example, when you have called
|
||||
gtk_combo_set_value_in_list() to limit the values entered, but you are not
|
||||
worried about differences in case.
|
||||
</para>
|
||||
|
||||
@combo: a #GtkCombo.
|
||||
@val:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_combo_set_item_string ##### -->
|
||||
<para>
|
||||
Sets the string to place in the #GtkEntry field when a particular list item is
|
||||
selected. This is needed if the list item is not a simple label.
|
||||
</para>
|
||||
|
||||
@combo: a #GtkCombo.
|
||||
@item: a #GtkItem which
|
||||
@item_value: the string to place in the #GtkEntry when @item is selected.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_combo_disable_activate ##### -->
|
||||
<para>
|
||||
Stops the #GtkCombo widget from showing the popup list when the #GtkEntry
|
||||
emits the "activate" signal, i.e. when the Return key is pressed.
|
||||
This may be useful if, for example. you want the Return key to close a dialog
|
||||
instead.
|
||||
</para>
|
||||
|
||||
@combo: a #GtkCombo.
|
||||
|
||||
|
||||
@@ -1,404 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkContainer
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkContainer ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GTK_IS_RESIZE_CONTAINER ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@widget:
|
||||
|
||||
|
||||
<!-- ##### MACRO gtk_container_border_width ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_add ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@widget:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_remove ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@widget:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_set_resize_mode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@resize_mode:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_check_resize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_foreach ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@callback:
|
||||
@callback_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_foreach_full ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@callback:
|
||||
@marshal:
|
||||
@callback_data:
|
||||
@notify:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_children ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_focus ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@direction:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_set_focus_child ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@child:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_set_focus_vadjustment ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@adjustment:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_set_focus_hadjustment ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@adjustment:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_register_toplevel ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_unregister_toplevel ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_resize_children ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_child_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_add_child_arg_type ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@arg_name:
|
||||
@arg_type:
|
||||
@arg_flags:
|
||||
@arg_id:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_query_child_args ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@class_type:
|
||||
@arg_flags:
|
||||
@nargs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_child_getv ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@child:
|
||||
@n_args:
|
||||
@args:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_child_setv ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@child:
|
||||
@n_args:
|
||||
@args:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_add_with_args ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@widget:
|
||||
@first_arg_name:
|
||||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_addv ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@widget:
|
||||
@n_args:
|
||||
@args:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_child_set ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@child:
|
||||
@first_arg_name:
|
||||
@Varargs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_queue_resize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_clear_resize_widgets ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_arg_set ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@child:
|
||||
@arg:
|
||||
@info:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_arg_get ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@child:
|
||||
@arg:
|
||||
@info:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_child_args_collect ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object_type:
|
||||
@arg_list_p:
|
||||
@info_list_p:
|
||||
@first_arg_name:
|
||||
@args:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_child_arg_get_info ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object_type:
|
||||
@arg_name:
|
||||
@info_p:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_forall ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@callback:
|
||||
@callback_data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_child_composite_name ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@child:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_get_toplevels ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_container_set_border_width ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container:
|
||||
@border_width:
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GtkContainer::add ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container: the object which received the signal.
|
||||
@widget:
|
||||
|
||||
<!-- ##### SIGNAL GtkContainer::remove ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container: the object which received the signal.
|
||||
@widget:
|
||||
|
||||
<!-- ##### SIGNAL GtkContainer::check-resize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkContainer::focus ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container: the object which received the signal.
|
||||
@direction:
|
||||
@Returns:
|
||||
|
||||
<!-- ##### SIGNAL GtkContainer::set-focus-child ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@container: the object which received the signal.
|
||||
@widget:
|
||||
|
||||
<!-- ##### ARG GtkContainer:border_width ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkContainer:resize_mode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkContainer:child ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,125 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkCurve
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
allows direct editing of a curve.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkCurve widget allows the user to edit a curve covering a range of
|
||||
values. It is typically used to fine-tune color balances in graphics
|
||||
applications like the Gimp.
|
||||
</para>
|
||||
<para>
|
||||
The #GtkCurve widget has 3 modes of operation - spline, linear and free.
|
||||
In spline mode the user places points on the curve which are automatically
|
||||
connected together into a smooth curve. In linear mode the user places points
|
||||
on the curve which are connected by straight lines. In free mode the user can
|
||||
draw the points of the curve freely, and they are not connected at all.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>#GtkGammaCurve</term>
|
||||
<listitem><para>a subclass for editing gamma curves.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkCurve ##### -->
|
||||
<para>
|
||||
The #GtkCurve-struct struct contains private data only, and
|
||||
should be accessed using the functions below.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_curve_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkCurve.
|
||||
</para>
|
||||
|
||||
@Returns: a new #GtkCurve.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_curve_reset ##### -->
|
||||
<para>
|
||||
Resets the curve to a straight line from the minimum x & y values to the
|
||||
maximum x & y values (i.e. from the bottom-left to the top-right corners).
|
||||
The curve type is not changed.
|
||||
</para>
|
||||
|
||||
@curve: a #GtkCurve.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_curve_set_gamma ##### -->
|
||||
<para>
|
||||
Recomputes the entire curve using the given gamma value.
|
||||
A gamma value of 1 results in a straight line. Values greater than 1 result
|
||||
in a curve above the straight line. Values less than 1 result in a curve
|
||||
below the straight line. The curve type is changed to %GTK_CURVE_TYPE_FREE.
|
||||
FIXME: Needs a more precise definition of gamma.
|
||||
</para>
|
||||
|
||||
@curve: a #GtkCurve.
|
||||
@gamma: the gamma value.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_curve_set_range ##### -->
|
||||
<para>
|
||||
Sets the minimum and maximum x & y values of the curve.
|
||||
The curve is also reset with a call to gtk_curve_reset().
|
||||
</para>
|
||||
|
||||
@curve: a #GtkCurve.
|
||||
@min_x: the minimum x value.
|
||||
@max_x: the maximum x value.
|
||||
@min_y: the minimum y value.
|
||||
@max_y: the maximum y value.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_curve_get_vector ##### -->
|
||||
<para>
|
||||
Returns a vector of points representing the curve.
|
||||
</para>
|
||||
|
||||
@curve: a #GtkCurve.
|
||||
@veclen: the number of points to calculate.
|
||||
@vector: returns the points.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_curve_set_vector ##### -->
|
||||
<para>
|
||||
Sets the vector of points on the curve.
|
||||
The curve type is set to %GTK_CURVE_TYPE_FREE.
|
||||
</para>
|
||||
|
||||
@curve: a #GtkCurve.
|
||||
@veclen: the number of points.
|
||||
@vector: the points on the curve.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_curve_set_curve_type ##### -->
|
||||
<para>
|
||||
Sets the type of the curve. The curve will remain unchanged except when
|
||||
changing from a free curve to a linear or spline curve, in which case the
|
||||
curve will be changed as little as possible.
|
||||
</para>
|
||||
|
||||
@curve: a #GtkCurve.
|
||||
@type: the type of the curve.
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GtkCurve::curve-type-changed ##### -->
|
||||
<para>
|
||||
Emitted when the curve type has been changed.
|
||||
The curve type can be changed explicitly with a call to
|
||||
gtk_curve_set_curve_type(). It is also changed as a side-effect of
|
||||
calling gtk_curve_reset() or gtk_curve_set_gamma().
|
||||
</para>
|
||||
|
||||
@curve: the object which received the signal.
|
||||
|
||||
@@ -1,38 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkData
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
abstract base class for objects containing data.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkData object is a very simple object intended to be used as a base
|
||||
class for objects which contain data (i.e. the 'Model' in the object-oriented
|
||||
Model/View/Controller framework).
|
||||
</para>
|
||||
<para>
|
||||
Currently it is not very useful since all it provides is a "disconnect" signal.
|
||||
This signal could be emitted by a #GtkData subclass to notify any 'Views'
|
||||
that they should disconnect from the #GtkData (the 'Model'), possibly just
|
||||
before the #GtkData is destroyed.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkData ##### -->
|
||||
<para>
|
||||
The #GtkData-struct struct contains no public fields.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GtkData::disconnect ##### -->
|
||||
<para>
|
||||
Emitted to notify any views on the #GtkData object to disconnect from it,
|
||||
possibly because the #GtkData object is about to be destroyed.
|
||||
</para>
|
||||
|
||||
@data: the object which received the signal.
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Debugging
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GtkDebugFlag ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_DEBUG_OBJECTS:
|
||||
@GTK_DEBUG_MISC:
|
||||
@GTK_DEBUG_SIGNALS:
|
||||
@GTK_DEBUG_DND:
|
||||
@GTK_DEBUG_PLUGSOCKET:
|
||||
|
||||
<!-- ##### VARIABLE gtk_debug_flags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### MACRO GTK_NOTE ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@action:
|
||||
|
||||
|
||||
@@ -1,119 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkDialog
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
create popup windows.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
Dialog boxes are a convenient way to prompt the user for a small amount of
|
||||
input, eg. to display
|
||||
a message, ask a question, or anything else that does not require extensive
|
||||
effort on the user's part.
|
||||
</para>
|
||||
<para>
|
||||
Gtk+ treats a dialog as a window split horizontally. The top section is a
|
||||
#GtkVBox, and is where widgets such as a #GtkLabel or a #GtkEntry should be
|
||||
packed. The second area is known as the <structfield>action_area</structfield>. This is generally used
|
||||
for packing buttons into the dialog which may perform functions such as cancel, ok, or apply. The two
|
||||
areas are separated by a #GtkHSeparator.
|
||||
</para>
|
||||
<para>
|
||||
#GtkDialog boxes are created with a call to gtk_dialog_new().
|
||||
</para>
|
||||
<para>
|
||||
If 'dialog' is a newly created dialog, the two primary areas of the window
|
||||
can be accessed as GTK_DIALOG(dialog)->vbox and GTK_DIALOG(dialog)->action_area,
|
||||
as can be seen from the example, below.
|
||||
</para>
|
||||
<para>
|
||||
A 'modal' dialog (that is, one which freezes the rest of the application
|
||||
from user input), can be created by calling gtk_window_set_modal() on the dialog. Use the
|
||||
GTK_WINDOW() macro to cast the widget returned from gtk_dialog_new() into a
|
||||
#GtkWindow.
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title>Using a #GtkDialog to keep the user informed.</title>
|
||||
<programlisting>
|
||||
|
||||
/* Function to open a dialog box displaying the message provided. */
|
||||
|
||||
void quick_message(#gchar *message) {
|
||||
|
||||
#GtkWidget *dialog, *label, *okay_button;
|
||||
|
||||
/* Create the widgets */
|
||||
|
||||
dialog = gtk_dialog_new();
|
||||
label = gtk_label_new (message);
|
||||
okay_button = gtk_button_new_with_label("Okay");
|
||||
|
||||
/* Ensure that the dialog box is destroyed when the user clicks ok. */
|
||||
|
||||
gtk_signal_connect_object (GTK_OBJECT (okay_button), "clicked",
|
||||
GTK_SIGNAL_FUNC (gtk_widget_destroy), dialog);
|
||||
gtk_container_add (GTK_CONTAINER (GTK_DIALOG(dialog)->action_area),
|
||||
okay_button);
|
||||
|
||||
/* Add the label, and show everything we've added to the dialog. */
|
||||
|
||||
gtk_container_add (GTK_CONTAINER (GTK_DIALOG(dialog)->vbox),
|
||||
label);
|
||||
gtk_widget_show_all (dialog);
|
||||
}
|
||||
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>#GtkVBox</term>
|
||||
<listitem><para>Pack widgets vertically.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>#GtkWindow</term>
|
||||
<listitem><para>Alter the properties of your dialog box.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>#GtkButton</term>
|
||||
<listitem><para>Add them to the <structfield>action_area</structfield> to get a
|
||||
response from the user.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkDialog ##### -->
|
||||
<para>
|
||||
<structfield>window</structfield> is a #GtkWindow, but should not be
|
||||
modified directly, (use the functions provided, such as
|
||||
gtk_window_set_title(). See the #GtkWindow section for more).
|
||||
</para>
|
||||
<para>
|
||||
<structfield>vbox</structfield> is a #GtkVBox - the main part of the dialog box.
|
||||
</para>
|
||||
<para>
|
||||
<structfield>action_area</structfield> is a #GtkHBox packed below the dividing #GtkHSeparator in the dialog. It is treated exactly the same as any other #GtkHBox.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GtkDialogButton ##### -->
|
||||
<para>
|
||||
Deprecated.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_dialog_new ##### -->
|
||||
<para>
|
||||
Creates a new dialog box. Widgets should not be packed into this #GtkWindow
|
||||
directly, but into the vbox and action_area, as described above.
|
||||
</para>
|
||||
|
||||
@Returns: a #GtkWidget - the newly created dialog box.
|
||||
|
||||
|
||||
@@ -1,345 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Drag and Drop
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Functions for controlling drag and drop handling.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
GTK+ has a rich set of functions for doing inter-process
|
||||
communication via the drag-and-drop metaphore. GTK+
|
||||
can do drag and drop (DND) via multiple protocols.
|
||||
The currently supported protocols are the Xdnd and
|
||||
Motif protocols.
|
||||
|
||||
As well as the functions listed here, applications
|
||||
may need to use some facilities provided for
|
||||
<link linkend="gtk-Selections">Selections</link>.
|
||||
Also, the Drag and Drop API makes use of signals
|
||||
in the #GtkWidget class.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GtkDestDefaults ##### -->
|
||||
<para>
|
||||
The #GtkDestfaults enumeration specifies the various
|
||||
types of action that will be taken on behalf
|
||||
of the user for a drag destination site.
|
||||
</para>
|
||||
<informaltable pgwide=1 frame="none" role="enum">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry><symbol>GTK_DEST_DEFAULT_MOTION</symbol></entry>
|
||||
<entry>
|
||||
If set for a widget, GTK+, during a drag over this
|
||||
widget will check if the drag matches this widget's
|
||||
list of possible targets and actions.
|
||||
GTK+ will then call gtk_drag_status() as appropriate.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><symbol>GTK_DEST_DEFAULT_HIGHLIGHT</symbol></entry>
|
||||
<entry>
|
||||
If set for a widget, GTK+ will draw a highlight on
|
||||
this widget as long as a drag is over this widget
|
||||
and the wiget drag format and action is accetable.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><symbol>GTK_DEST_DEFAULT_DROP</symbol></entry>
|
||||
<entry>
|
||||
If set for a widget, when a drop occurs, GTK+ will
|
||||
will check if the drag matches this widget's
|
||||
list of possible targets and actions. If so,
|
||||
GTK+ will call gtk_drag_data_get() on behalf
|
||||
of the widget. Whether or not the drop is succesful,
|
||||
GTK+ will call gtk_drag_finish(). If the action
|
||||
was a move, then if the drag was succesful, then
|
||||
%TRUE will be passed for the @delete parameter
|
||||
to gtk_drag_finish().
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry><symbol>GTK_DEST_DEFAULT_ALL</symbol></entry>
|
||||
<entry>
|
||||
If set, specifies that all default actions should
|
||||
be taken.
|
||||
</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
|
||||
@GTK_DEST_DEFAULT_MOTION:
|
||||
@GTK_DEST_DEFAULT_HIGHLIGHT:
|
||||
@GTK_DEST_DEFAULT_DROP:
|
||||
@GTK_DEST_DEFAULT_ALL:
|
||||
|
||||
<!-- ##### ENUM GtkTargetFlags ##### -->
|
||||
<para>
|
||||
The #GtkTargetFlags enumeration is used to specifies
|
||||
constraints on an entry in a GtkTargetTable.
|
||||
</para>
|
||||
<variablelist>
|
||||
<varlistentry><term> %GTK_TARGET_SAME_APP </term>
|
||||
<listitem>
|
||||
<para>
|
||||
If this is set, the target will only be selected
|
||||
for drags within a single application.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term> %GTK_TARGET_SAME_WIDGET </term>
|
||||
<listitem>
|
||||
<para>
|
||||
If this is set, the target will only be selected
|
||||
for drags within a single widget.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
@GTK_TARGET_SAME_APP:
|
||||
@GTK_TARGET_SAME_WIDGET:
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_dest_set ##### -->
|
||||
<para>
|
||||
Set a widget as a potential drop destination.
|
||||
</para>
|
||||
|
||||
@widget: a widget
|
||||
@flags: the flags that specify what actions GTK+ should take
|
||||
on behalf of a widget for drops onto that widget. The @targets
|
||||
and @actions fields only are used if %GTK_DEST_DEFAULT_MOTION
|
||||
or %GTK_DEST_DEFAULT_DROP are given.
|
||||
@targets: a pointer to an array of #GtkTargetEntry indicating
|
||||
the drop types that this widget will accept.
|
||||
@n_targets: the number of entries in @targets.
|
||||
@actions: a bitmask of possible actions for a drop onto this
|
||||
widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_dest_set_proxy ##### -->
|
||||
<para>
|
||||
Set this widget as a proxy for drops to another window.
|
||||
</para>
|
||||
|
||||
@widget: a #GtkWidget
|
||||
@proxy_window: the window to which to forward drag events
|
||||
@protocol: the drag protocol which the @proxy_window accepts
|
||||
(You can use gdk_drag_get_protocol() to determine this)
|
||||
@use_coordinates: If true, send the same coordinates to the
|
||||
destination, because it is a embedded
|
||||
subwindow.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_dest_unset ##### -->
|
||||
<para>
|
||||
Clear information about a drop destination set with
|
||||
gtk_drag_dest_set(). The widget will no longer receive
|
||||
notification of drags.
|
||||
</para>
|
||||
|
||||
@widget: a #GtkWidget
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_finish ##### -->
|
||||
<para>
|
||||
Inform the drag source that the drop is finished, and
|
||||
that the data of the drag will no longer be required.
|
||||
</para>
|
||||
|
||||
@context: the drag context.
|
||||
@success: a flag indicating whether the drop was succesful
|
||||
@del: a flag indicating whether the source should delete the
|
||||
original data. (This should be %TRUE for a move)
|
||||
@time: the timestamp from the "drag_data_drop" signal.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_get_data ##### -->
|
||||
<para>
|
||||
Get the data associated with a drag. When the data
|
||||
is received or the retrieval fails, GTK+ will emit a
|
||||
"drag_data_received" signal. Failure of the retrieval
|
||||
is indicated by the length field of the @selection_data
|
||||
signal parameter being negative. However, when gtk_drag_get_data()
|
||||
is called implicitely because the %GTK_DRAG_DEFAULT_DROP was set,
|
||||
then the widget will not receive notification of failed
|
||||
drops.
|
||||
</para>
|
||||
|
||||
@widget: the widget that will receive the "drag_data_received"
|
||||
signal.
|
||||
@context: the drag context
|
||||
@target: the target (form of the data) to retrieve.
|
||||
@time: a timestamp for retrieving the data. This will
|
||||
generally be the time received in a "drag_data_motion"
|
||||
or "drag_data_drop" signal.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_get_source_widget ##### -->
|
||||
<para>
|
||||
Determine the source widget for a drag.
|
||||
</para>
|
||||
|
||||
@context: a (destination side) drag context.
|
||||
@Returns: if the drag is occurring within a single application,
|
||||
a pointer to the source widget. Otherwise, NULL.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_highlight ##### -->
|
||||
<para>
|
||||
Draw a highlight around a widget. This will attach
|
||||
handlers to "expose_event" and "draw", so the highlight
|
||||
will continue to be displayed until gtk_drag_unhighlight
|
||||
is called.
|
||||
</para>
|
||||
|
||||
@widget: a widget to highlight
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_unhighlight ##### -->
|
||||
<para>
|
||||
Remove a highlight set by gtk_drag_highlight() from
|
||||
a widget.
|
||||
is called.
|
||||
</para>
|
||||
|
||||
@widget: a widget to remove the highlight from.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_begin ##### -->
|
||||
<para>
|
||||
Initiate a drag on the source side. The function
|
||||
only needs to be used when the application is
|
||||
starting drags itself, and is not needed when
|
||||
gtk_drag_source_set() is used.
|
||||
</para>
|
||||
|
||||
@widget: the source widget.
|
||||
@targets: The targets (data formats) in which the
|
||||
source can provide the data.
|
||||
@actions: A bitmask of the allowed drag actions for this
|
||||
drag.
|
||||
@button: The button the user clicked to start the drag.
|
||||
@event: The event that triggered the start of the
|
||||
drag. Usually
|
||||
@Returns: The context for this drag.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_set_icon_widget ##### -->
|
||||
<para>
|
||||
Change the icon for a widget to a given widget. GTK+
|
||||
will not destroy the icon, so if you don't want
|
||||
it to persist, you should connect to the "drag_end"
|
||||
signal and destroy it yourself.
|
||||
</para>
|
||||
|
||||
@context: the context for a drag. (This must be called
|
||||
with a context for the source side of a drag)
|
||||
@widget: A toplevel window to use as an icon.
|
||||
@hot_x: The X offset within @widget of the hotspot.
|
||||
@hot_y: The Y offset within @widget of the hotspot.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_set_icon_pixmap ##### -->
|
||||
<para>
|
||||
Sets a given pixmap as the icon for a given drag.
|
||||
GTK+ retains a reference count for the arguments, and
|
||||
will release them when they are no longer needed.
|
||||
</para>
|
||||
|
||||
@context: the context for a drag. (This must be called
|
||||
with a context for the source side of a drag)
|
||||
@colormap: the colormap of the icon
|
||||
@pixmap: the image data for the icon
|
||||
@mask: the transparency mask for an image.
|
||||
@hot_x: The X offset within @widget of the hotspot.
|
||||
@hot_y: The Y offset within @widget of the hotspot.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_set_icon_default ##### -->
|
||||
<para>
|
||||
Set the icon for a particular drag to the default
|
||||
icon.
|
||||
</para>
|
||||
|
||||
@context: the context for a drag. (This must be called
|
||||
with a context for the source side of a drag)
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_set_default_icon ##### -->
|
||||
<para>
|
||||
Change the default drag icon. GTK+ retains a reference count for the
|
||||
arguments, and will release them when they are no longer needed.
|
||||
</para>
|
||||
|
||||
@colormap: the colormap of the icon
|
||||
@pixmap: the image data for the icon
|
||||
@mask: the transparency mask for an image.
|
||||
@hot_x: The X offset within @widget of the hotspot.
|
||||
@hot_y: The Y offset within @widget of the hotspot.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_source_set ##### -->
|
||||
<para>
|
||||
Sets up a widget so that GTK+ will start a drag
|
||||
operation when the user clicks and drags on the
|
||||
widget. The widget must have a window.
|
||||
</para>
|
||||
|
||||
@widget: a #GtkWidget
|
||||
@start_button_mask: the bitmask of buttons that can start the drag
|
||||
@targets: the table of targets that the drag will support
|
||||
@n_targets: the number of items in @targets
|
||||
@actions: the bitmask of possible actions for a drag from this
|
||||
widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_source_set_icon ##### -->
|
||||
<para>
|
||||
Sets the icon that will be used for drags from a
|
||||
particular widget. GTK+ retains a reference count
|
||||
for the arguments, and will release them when
|
||||
they are no longer needed.
|
||||
</para>
|
||||
|
||||
@widget: a #GtkWidget
|
||||
@colormap: the colormap of the icon
|
||||
@pixmap: the image data for the icon
|
||||
@mask: the transparency mask for an image.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_source_unset ##### -->
|
||||
<para>
|
||||
Undo the effects of gtk_drag_source_set().
|
||||
</para>
|
||||
|
||||
@widget: a #GtkWidget
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_source_handle_event ##### -->
|
||||
<para>
|
||||
Internal function.
|
||||
</para>
|
||||
|
||||
@widget:
|
||||
@event:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drag_dest_handle_event ##### -->
|
||||
<para>
|
||||
Internal function.
|
||||
</para>
|
||||
|
||||
@toplevel:
|
||||
@event:
|
||||
|
||||
|
||||
@@ -1,110 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkDrawingArea
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
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:
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Mouse and button press signals to respond to input from
|
||||
the user.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
The "realize" signal to take any necessary actions
|
||||
when the widget
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
The "size_allocate" signal to take any necessary actions
|
||||
when the widget changes size.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
The "expose_event" signal to handle redrawing the
|
||||
contents of the widget.
|
||||
</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.
|
||||
</para>
|
||||
<programlisting>
|
||||
gboolean
|
||||
expose_event (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],
|
||||
&event->area);
|
||||
gdk_draw_arc (widget->window,
|
||||
widget->style->fg_gc[widget->state],
|
||||
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 = gdk_drawing_area_new ();
|
||||
gdk_drawing_area_size (GTK_DRAWING_AREA (drawing_area),
|
||||
100, 100);
|
||||
gtk_signal_connect (GTK_OBJECT (drawing_area),
|
||||
</programlisting>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkDrawingArea ##### -->
|
||||
<para>
|
||||
The #GtkDrawingArea-struct struct contains private data only, and
|
||||
should be accessed using the functions below.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drawing_area_new ##### -->
|
||||
<para>
|
||||
Create a new drawing area.
|
||||
</para>
|
||||
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_drawing_area_size ##### -->
|
||||
<para>
|
||||
Set the size that the drawing area will request
|
||||
in response to a "size_request" signal. The
|
||||
drawing area may actually be allocated a size
|
||||
larger than this depending on how it is packed
|
||||
within the enclosing containers.
|
||||
</para>
|
||||
|
||||
@darea: a #GtkDrawingArea.
|
||||
@width: the width to request.
|
||||
@height: the height to request.
|
||||
|
||||
|
||||
@@ -1,442 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkEditable
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Base class for text-editing widgets.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkEditable class is a base class for widgets
|
||||
for editing text, such as #GtkEntry and #GtkText. It
|
||||
cannot be instantiated by itself. The editable
|
||||
class contains functions for generically manipulating
|
||||
an editable widget, a large number of action signals
|
||||
used for key bindings, and several signals that
|
||||
an application can connect to to modify the behavior
|
||||
of a widget.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
As an example of the latter usage, by connecting
|
||||
the following handler to "insert_text", an application
|
||||
can convert all entry into a widget into uppercase.
|
||||
|
||||
<example>
|
||||
<title> Forcing entry to uppercase </title>
|
||||
<programlisting>
|
||||
#include <ctype.h>
|
||||
|
||||
void
|
||||
insert_text_handler (GtkEditable *editable,
|
||||
const gchar *text,
|
||||
gint length,
|
||||
gint *position,
|
||||
gpointer data)
|
||||
{
|
||||
int i;
|
||||
gchar *result = g_new (gchar, length);
|
||||
|
||||
for (i=0; i<length; i++)
|
||||
result[i] = islower(text[i]) ? toupper(text[i]) : text[i];
|
||||
|
||||
gtk_signal_handler_block_by_func (GTK_OBJECT (editable),
|
||||
GTK_SIGNAL_FUNC (insert_text_handler),
|
||||
data);
|
||||
gtk_editable_insert_text (editable, result, length, position);
|
||||
gtk_signal_handler_unblock_by_func (GTK_OBJECT (editable),
|
||||
GTK_SIGNAL_FUNC (insert_text_handler),
|
||||
data);
|
||||
|
||||
gtk_signal_emit_stop_by_name (GTK_OBJECT (editable), "insert_text");
|
||||
|
||||
g_free (result);
|
||||
}
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkEditable ##### -->
|
||||
<para>
|
||||
The #GtkEditable structure contains the following fields.
|
||||
(These fields should be considered read-only. They should
|
||||
never be set by an application.)
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#guint selection_start;</entry>
|
||||
<entry>the starting position of the selected characters
|
||||
in the widget.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#guint selection_end;</entry>
|
||||
<entry>the end position of the selected characters
|
||||
in the widget.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#guint editable;</entry>
|
||||
<entry>a flag indicating whether or not the widget is
|
||||
editable by the user.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@current_pos:
|
||||
@selection_start_pos:
|
||||
@selection_end_pos:
|
||||
@has_selection:
|
||||
|
||||
<!-- ##### USER_FUNCTION GtkTextFunction ##### -->
|
||||
<para>
|
||||
Callback function for old method of setting key bindings.
|
||||
No longer publically used.
|
||||
</para>
|
||||
|
||||
@editable:
|
||||
@time:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_select_region ##### -->
|
||||
<para>
|
||||
Selects a region of text. The characters that
|
||||
are selected are those characters at positions from
|
||||
@start_pos up to, but not including @end_pos. If
|
||||
@end_pos is negative, then the the characters selected
|
||||
will be those characters from @start_pos to the end
|
||||
of the text.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
@start: the starting position.
|
||||
@end: the end position.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_insert_text ##### -->
|
||||
<para>
|
||||
Insert text at a given position.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
@new_text: the text to insert.
|
||||
@new_text_length: the length of the text to insert, in bytes
|
||||
@position: an inout parameter. The caller initializes it to
|
||||
the position at which to insert the text. After the
|
||||
call it points at the position after the newly
|
||||
inserted text.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_delete_text ##### -->
|
||||
<para>
|
||||
Delete a sequence of characters. The characters that
|
||||
are deleted are those characters at positions from
|
||||
@start_pos up to, but not including @end_pos. If
|
||||
@end_pos is negative, then the the characters deleted
|
||||
will be those characters from @start_pos to the end
|
||||
of the text.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
@start_pos: the starting position.
|
||||
@end_pos: the end position.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_get_chars ##### -->
|
||||
<para>
|
||||
Retrieves a sequence of characters. The characters that
|
||||
are retrieved are those characters at positions from
|
||||
@start_pos up to, but not including @end_pos. If
|
||||
@end_pos is negative, then the the characters retrieved
|
||||
will be those characters from @start_pos to the end
|
||||
of the text.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
@start_pos: the starting position.
|
||||
@end_pos: the end position.
|
||||
@Returns: the characters in the indicated region.
|
||||
The result must be freed with g_free() when
|
||||
the application is finished with it.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_cut_clipboard ##### -->
|
||||
<para>
|
||||
Causes the characters in the current selection to
|
||||
be copied to the clipboard and then deleted from
|
||||
the widget.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_copy_clipboard ##### -->
|
||||
<para>
|
||||
Causes the characters in the current selection to
|
||||
be copied to the clipboard.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_paste_clipboard ##### -->
|
||||
<para>
|
||||
Causes the contents of the clipboard to be pasted into
|
||||
the given widget at the current cursor position.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_claim_selection ##### -->
|
||||
<para>
|
||||
Claim or disclaim ownership of the PRIMARY X selection.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
@claim: if %TRUE, claim the selection, otherwise, disclaim it.
|
||||
@time: the timestamp for claiming the selection.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_delete_selection ##### -->
|
||||
<para>
|
||||
Deletes the current contents of the widgets selection and
|
||||
disclaims the selection.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_changed ##### -->
|
||||
<para>
|
||||
Causes the "changed" signal to be emitted.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_set_position ##### -->
|
||||
<para>
|
||||
Sets the cursor position.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
@position: the position of the cursor. The cursor is displayed
|
||||
before the character with the given (base 0) index
|
||||
in the widget. The value must be less than or
|
||||
equal to the number of characters in the widget.
|
||||
A value of -1 indicates that the position should
|
||||
be set after the last character in the entry.
|
||||
Note that this position is in characters, not in
|
||||
bytes.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_get_position ##### -->
|
||||
<para>
|
||||
Retrieves the current cursor position.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
@Returns: the position of the cursor. The cursor is displayed
|
||||
before the character with the given (base 0) index
|
||||
in the widget. The value will be less than or
|
||||
equal to the number of characters in the widget.
|
||||
Note that this position is in characters, not in
|
||||
bytes.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_editable_set_editable ##### -->
|
||||
<para>
|
||||
Determines if the user can edit the text in the editable
|
||||
widget or not.
|
||||
</para>
|
||||
|
||||
@editable: a #GtkEditable widget.
|
||||
@is_editable: %TRUE if the user is allowed to edit the text
|
||||
in the widget.
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::changed ##### -->
|
||||
<para>
|
||||
Indicates that the user has changed the contents
|
||||
of the widget.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::insert-text ##### -->
|
||||
<para>
|
||||
This signal is emitted when text is inserted into
|
||||
the widget by the user. The default handler for
|
||||
this signal will normally be responsible for inserting
|
||||
the text, so by connecting to this signal and then
|
||||
stopping the signal with gtk_signal_emit_stop(), it
|
||||
is possible to modify the inserted text, or prevent
|
||||
it from being inserted entirely.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
@new_text: the new text to insert.
|
||||
@new_text_length: the length of the new text.
|
||||
@position: the position at which to insert the new text.
|
||||
this is an in-out paramter. After the signal
|
||||
emission is finished, it should point after
|
||||
the newly inserted text.
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::delete-text ##### -->
|
||||
<para>
|
||||
This signal is emitted when text is deleted from
|
||||
the widget by the user. The default handler for
|
||||
this signal will normally be responsible for inserting
|
||||
the text, so by connecting to this signal and then
|
||||
stopping the signal with gtk_signal_emit_stop(), it
|
||||
is possible to modify the inserted text, or prevent
|
||||
it from being inserted entirely. The @start_pos
|
||||
and @end_pos parameters are interpreted as for
|
||||
gtk_editable_delete_text()
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
@start_pos: the starting position.
|
||||
@end_pos: the end position.
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::activate ##### -->
|
||||
<para>
|
||||
Indicates that the user has activated the widget
|
||||
in some fashion. Generally, this will be done
|
||||
with a keystroke. (The default binding for this
|
||||
action is Return for #GtkEntry and
|
||||
Control-Return for #GtkText.)
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::set-editable ##### -->
|
||||
<para>
|
||||
Determines if the user can edit the text in the editable
|
||||
widget or not. This is meant to be overriden by
|
||||
child classes and should not generally useful to
|
||||
applications.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
@is_editable: %TRUE if the user is allowed to edit the text
|
||||
in the widget.
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
|
||||
<para>
|
||||
An action signal. Move the cursor position.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
@x: horizontal distance to move the cursor.
|
||||
@y: vertical distance to move the cursor.
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::move-word ##### -->
|
||||
<para>
|
||||
An action signal. Move the cursor by words.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
@num_words: The number of words to move the
|
||||
cursor. (Can be negative).
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::move-page ##### -->
|
||||
<para>
|
||||
An action signal. Move the cursor by pages.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
@x: Number of pages to move the cursor horizontally.
|
||||
@y: Number of pages to move the cursor vertically.
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
|
||||
<para>
|
||||
An action signal. Move the cursor to the given row.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
@row: the row to move to. (A negative value indicates
|
||||
the last row)
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
|
||||
<para>
|
||||
An action signal. Move the cursor to the given column.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
@column: the column to move to. (A negative value indicates
|
||||
the last column)
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
|
||||
<para>
|
||||
An action signal. Delete a single character.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
@direction: the direction in which to delete. Positive
|
||||
indicates forward deletion, negative, backwards deletion.
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::kill-word ##### -->
|
||||
<para>
|
||||
An action signal. Delete a single word.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
@direction: the direction in which to delete. Positive
|
||||
indicates forward deletion, negative, backwards deletion.
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::kill-line ##### -->
|
||||
<para>
|
||||
An action signal. Delete a single line.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
@direction: the direction in which to delete. Positive
|
||||
indicates forward deletion, negative, backwards deletion.
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
|
||||
<para>
|
||||
An action signal. Causes the characters in the current
|
||||
selection to be copied to the clipboard and then deleted from
|
||||
the widget.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
|
||||
<para>
|
||||
An action signal. Causes the characters in the current selection to
|
||||
be copied to the clipboard.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
|
||||
<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
|
||||
<para>
|
||||
An action signal. Causes the contents of the clipboard to
|
||||
be pasted into the editable widget at the current cursor
|
||||
position.
|
||||
</para>
|
||||
|
||||
@editable: the object which received the signal.
|
||||
|
||||
<!-- ##### ARG GtkEditable:text_position ##### -->
|
||||
<para>
|
||||
The position of the cursor.
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkEditable:editable ##### -->
|
||||
<para>
|
||||
A boolean indicating whether the widget is editable by
|
||||
the user.
|
||||
</para>
|
||||
|
||||
@@ -1,185 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkEntry
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a single line text entry field.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkEntry widget is a single line text entry
|
||||
widget. A fairly large set of key bindings are supported
|
||||
by default. If the entered text is longer than the allocation
|
||||
of the widget, the widget will scroll so that the cursor
|
||||
position is visible.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkText</term>
|
||||
<listitem><para>a widget for handling multi-line text entry.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkEntry ##### -->
|
||||
<para>
|
||||
The #GtkEntry-struct struct contains only private data.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_entry_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkEntry widget.
|
||||
</para>
|
||||
|
||||
@Returns: a new #GtkEntry.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_entry_new_with_max_length ##### -->
|
||||
<para>
|
||||
Creates a new #GtkEntry widget with the given maximum
|
||||
length.
|
||||
</para>
|
||||
<para>
|
||||
Note: the existance of this function is inconsistent
|
||||
with the rest of the GTK+ API. The normal setup would
|
||||
be to just require the user to make an extra call
|
||||
to gtk_entry_set_max_length() instead. It is not
|
||||
expected that this function will be removed, but
|
||||
it would be better practice not to use it.
|
||||
</para>
|
||||
|
||||
@max: the new maximum length.
|
||||
@Returns: a new #GtkEntry.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_entry_set_text ##### -->
|
||||
<para>
|
||||
Sets the text in the widget to the given
|
||||
value, replacing the current contents.
|
||||
</para>
|
||||
|
||||
@entry: a #GtkEntry.
|
||||
@text: the new text.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_entry_append_text ##### -->
|
||||
<para>
|
||||
Appends the given text to the contents of the widget.
|
||||
</para>
|
||||
|
||||
@entry: a #GtkEntry.
|
||||
@text: the text to append.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_entry_prepend_text ##### -->
|
||||
<para>
|
||||
Prepends the given text to the contents of th ewidget.
|
||||
</para>
|
||||
|
||||
@entry: a #GtkEntry.
|
||||
@text: the text to prepend.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_entry_set_position ##### -->
|
||||
<para>
|
||||
Sets the cursor position in an entry to the given
|
||||
value. This function is obsolete. You should use
|
||||
gtk_editable_set_position() instead.
|
||||
</para>
|
||||
|
||||
@entry: a #GtkEntry.
|
||||
@position: the position of the cursor. The cursor is displayed
|
||||
before the character with the given (base 0) index
|
||||
in the widget. The value must be less than or
|
||||
equal to the number of characters in the widget.
|
||||
A value of -1 indicates that the position should
|
||||
be set after the last character in the entry.
|
||||
Note that this position is in characters, not in
|
||||
bytes.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_entry_get_text ##### -->
|
||||
<para>
|
||||
Retrieve the contents of the entry widget. The returned
|
||||
pointer points to internally allocated storage in the
|
||||
widget and must not be freed, modified or stored. For
|
||||
this reason, this function is deprecated. Use
|
||||
gtk_editable_get_chars() instead.
|
||||
</para>
|
||||
|
||||
@entry: a #GtkEntry.
|
||||
@Returns: the pointer the the contents of the text widget as a
|
||||
string.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_entry_select_region ##### -->
|
||||
<para>
|
||||
Selects a region of text. The characters that
|
||||
are selected are those characters at positions from
|
||||
@start_pos up to, but not including @end_pos. If
|
||||
@end_pos is negative, then the the characters selected
|
||||
will be those characters from @start_pos to the end
|
||||
of the text. This function is obsolete. You should
|
||||
use gtk_editable_select_region() instead.
|
||||
</para>
|
||||
|
||||
@entry: a #GtkEntry.
|
||||
@start: the starting position.
|
||||
@end: the end position.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_entry_set_visibility ##### -->
|
||||
<para>
|
||||
Sets whether the contents of the entry are visible or
|
||||
not. When visibility is set to %FALSE, characters
|
||||
are displayed as asterisks (*'s), and will also appear
|
||||
that way when the text in the entry widget is copied
|
||||
elsewhere.
|
||||
</para>
|
||||
|
||||
@entry: a #GtkEntry.
|
||||
@visible: %TRUE if the contents of the entry are displayd
|
||||
as plaintext.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_entry_set_editable ##### -->
|
||||
<para>
|
||||
Determines if the user can edit the text in the editable
|
||||
widget or not. This function is obsolete. You should
|
||||
use gtk_editable_set_editable() instead.
|
||||
</para>
|
||||
|
||||
@entry: a #GtkEntry.
|
||||
@editable: %TRUE if the user is allowed to edit the text
|
||||
in the widget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_entry_set_max_length ##### -->
|
||||
<para>
|
||||
Sets the maximum allowed length of the contents
|
||||
of the widget. If the current contents are longer
|
||||
than the given length, then they will be truncated
|
||||
to fit.
|
||||
</para>
|
||||
|
||||
@entry: a #GtkEntry.
|
||||
@max: the new maximum length.
|
||||
|
||||
|
||||
<!-- ##### ARG GtkEntry:max_length ##### -->
|
||||
<para>
|
||||
Determines the maximum allowed length of the contents
|
||||
of the widget. See gtk_entry_set_max_length().
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkEntry:visibility ##### -->
|
||||
<para>
|
||||
Determines whether the contents of the entry widget
|
||||
are visible or not. See gtk_entry_set_visibility().
|
||||
</para>
|
||||
|
||||
@@ -1,346 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Standard Enumerations
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Public enumerated types used throughout GTK+.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ENUM GtkAccelFlags ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_ACCEL_VISIBLE:
|
||||
@GTK_ACCEL_SIGNAL_VISIBLE:
|
||||
@GTK_ACCEL_LOCKED:
|
||||
@GTK_ACCEL_MASK:
|
||||
|
||||
<!-- ##### ENUM GtkArrowType ##### -->
|
||||
<para>
|
||||
Used to indicate the direction in which a #GtkArrow should point.
|
||||
</para>
|
||||
|
||||
@GTK_ARROW_UP: Represents an upward pointing arrow.
|
||||
@GTK_ARROW_DOWN: Represents a downward pointing arrow.
|
||||
@GTK_ARROW_LEFT: Represents a left pointing arrow.
|
||||
@GTK_ARROW_RIGHT: Represents a right pointing arrow.
|
||||
|
||||
<!-- ##### ENUM GtkAttachOptions ##### -->
|
||||
<para>
|
||||
Denotes the expansion properties that a widget will have when it (or it's
|
||||
parent) is resized.
|
||||
</para>
|
||||
|
||||
@GTK_EXPAND: the widget should expand to take up any extra space in its
|
||||
container that has been allocated.
|
||||
@GTK_SHRINK: the widget should shrink as and when possible.
|
||||
@GTK_FILL: the widget should fill the space allocated to it.
|
||||
|
||||
<!-- ##### ENUM GtkButtonBoxStyle ##### -->
|
||||
<para>
|
||||
Used to dictate the style that a #GtkButtonBox uses to layout the buttons it
|
||||
contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
|
||||
</para>
|
||||
|
||||
@GTK_BUTTONBOX_DEFAULT_STYLE: Default packing.
|
||||
@GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the ButtonBox.
|
||||
@GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the ButtonBox.
|
||||
@GTK_BUTTONBOX_START: Buttons are grouped towards the start of box, (on the
|
||||
left for a HBox, or the top for a VBox).
|
||||
@GTK_BUTTONBOX_END: Buttons are grouped towards the end of a box, (on the
|
||||
right for a HBox, or the bottom for a VBox).
|
||||
|
||||
<!-- ##### ENUM GtkCornerType ##### -->
|
||||
<para>
|
||||
Specifies which corner a child widget should be placed in when packed into
|
||||
a #GtkScrolledWindow. This is effectively the opposite of where the scroll
|
||||
bars are placed.
|
||||
</para>
|
||||
|
||||
@GTK_CORNER_TOP_LEFT: Place the scrollbars on the right and bottom of the
|
||||
widget (default behaviour).
|
||||
@GTK_CORNER_BOTTOM_LEFT: Place the scrollbars on the top and right of the
|
||||
widget.
|
||||
@GTK_CORNER_TOP_RIGHT: Place the scrollbars on the left and bottom of the
|
||||
widget.
|
||||
@GTK_CORNER_BOTTOM_RIGHT: Place the scrollbars on the top and left of the
|
||||
widget.
|
||||
|
||||
<!-- ##### ENUM GtkCurveType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_CURVE_TYPE_LINEAR:
|
||||
@GTK_CURVE_TYPE_SPLINE:
|
||||
@GTK_CURVE_TYPE_FREE:
|
||||
|
||||
<!-- ##### ENUM GtkDirectionType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_DIR_TAB_FORWARD:
|
||||
@GTK_DIR_TAB_BACKWARD:
|
||||
@GTK_DIR_UP:
|
||||
@GTK_DIR_DOWN:
|
||||
@GTK_DIR_LEFT:
|
||||
@GTK_DIR_RIGHT:
|
||||
|
||||
<!-- ##### ENUM GtkJustification ##### -->
|
||||
<para>
|
||||
Used for justifying the text inside a #GtkLabel widget. (See also
|
||||
#GtkAlignment).
|
||||
</para>
|
||||
|
||||
@GTK_JUSTIFY_LEFT: The text is placed at the left edge of the label.
|
||||
@GTK_JUSTIFY_RIGHT: The text is placed at the right edge of the label.
|
||||
@GTK_JUSTIFY_CENTER: The text is placed in the center of the label.
|
||||
@GTK_JUSTIFY_FILL: The text is placed is distributed across the label.
|
||||
|
||||
<!-- ##### ENUM GtkMatchType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_MATCH_ALL:
|
||||
@GTK_MATCH_ALL_TAIL:
|
||||
@GTK_MATCH_HEAD:
|
||||
@GTK_MATCH_TAIL:
|
||||
@GTK_MATCH_EXACT:
|
||||
@GTK_MATCH_LAST:
|
||||
|
||||
<!-- ##### ENUM GtkMetricType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_PIXELS:
|
||||
@GTK_INCHES:
|
||||
@GTK_CENTIMETERS:
|
||||
|
||||
<!-- ##### ENUM GtkOrientation ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_ORIENTATION_HORIZONTAL:
|
||||
@GTK_ORIENTATION_VERTICAL:
|
||||
|
||||
<!-- ##### ENUM GtkPackType ##### -->
|
||||
<para>
|
||||
Used for packing widgets into #GtkBox widgets. (See also: #GtkVBox,
|
||||
#GtkHBox, and #GtkButtonBox).
|
||||
</para>
|
||||
|
||||
@GTK_PACK_START: The
|
||||
@GTK_PACK_END:
|
||||
|
||||
<!-- ##### ENUM GtkPathPriorityType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_PATH_PRIO_LOWEST:
|
||||
@GTK_PATH_PRIO_GTK:
|
||||
@GTK_PATH_PRIO_APPLICATION:
|
||||
@GTK_PATH_PRIO_RC:
|
||||
@GTK_PATH_PRIO_HIGHEST:
|
||||
@GTK_PATH_PRIO_MASK:
|
||||
|
||||
<!-- ##### ENUM GtkPathType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_PATH_WIDGET:
|
||||
@GTK_PATH_WIDGET_CLASS:
|
||||
@GTK_PATH_CLASS:
|
||||
|
||||
<!-- ##### ENUM GtkPolicyType ##### -->
|
||||
<para>
|
||||
Determines when a scroll bar will be visible.
|
||||
</para>
|
||||
|
||||
@GTK_POLICY_ALWAYS: The scrollbar is always visible.
|
||||
@GTK_POLICY_AUTOMATIC: The scrollbar will appear and disappear as necessary. For example,
|
||||
when all of a #GtkCList can not be seen.
|
||||
@GTK_POLICY_NEVER: The scrollbar will never appear.
|
||||
|
||||
<!-- ##### ENUM GtkPositionType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_POS_LEFT:
|
||||
@GTK_POS_RIGHT:
|
||||
@GTK_POS_TOP:
|
||||
@GTK_POS_BOTTOM:
|
||||
|
||||
<!-- ##### ENUM GtkPreviewType ##### -->
|
||||
<para>
|
||||
An enumeration which describes whether a preview
|
||||
contains grayscale or red-green-blue data.
|
||||
</para>
|
||||
|
||||
@GTK_PREVIEW_COLOR: the preview contains red-green-blue data.
|
||||
@GTK_PREVIEW_GRAYSCALE: The preview contains grayscale data.
|
||||
|
||||
<!-- ##### ENUM GtkReliefStyle ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_RELIEF_NORMAL:
|
||||
@GTK_RELIEF_HALF:
|
||||
@GTK_RELIEF_NONE:
|
||||
|
||||
<!-- ##### ENUM GtkResizeMode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_RESIZE_PARENT:
|
||||
@GTK_RESIZE_QUEUE:
|
||||
@GTK_RESIZE_IMMEDIATE:
|
||||
|
||||
<!-- ##### ENUM GtkScrollType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_SCROLL_NONE:
|
||||
@GTK_SCROLL_STEP_BACKWARD:
|
||||
@GTK_SCROLL_STEP_FORWARD:
|
||||
@GTK_SCROLL_PAGE_BACKWARD:
|
||||
@GTK_SCROLL_PAGE_FORWARD:
|
||||
@GTK_SCROLL_JUMP:
|
||||
|
||||
<!-- ##### ENUM GtkSelectionMode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_SELECTION_SINGLE:
|
||||
@GTK_SELECTION_BROWSE:
|
||||
@GTK_SELECTION_MULTIPLE:
|
||||
@GTK_SELECTION_EXTENDED:
|
||||
|
||||
<!-- ##### ENUM GtkShadowType ##### -->
|
||||
<para>
|
||||
Used to change the appearance of an outline typically provided by a #GtkFrame.
|
||||
</para>
|
||||
|
||||
@GTK_SHADOW_NONE: No outline.
|
||||
@GTK_SHADOW_IN: The outline is bevelled inwards.
|
||||
@GTK_SHADOW_OUT: The outline is bevelled outwards like a button.
|
||||
@GTK_SHADOW_ETCHED_IN: The outline itself is an inward bevel, but the frame
|
||||
does
|
||||
@GTK_SHADOW_ETCHED_OUT:
|
||||
|
||||
<!-- ##### ENUM GtkStateType ##### -->
|
||||
<para>
|
||||
This type indicates the current state of a widget.
|
||||
</para>
|
||||
|
||||
@GTK_STATE_NORMAL: The state during normal operation.
|
||||
@GTK_STATE_ACTIVE: The widget is currently active, such as a
|
||||
@GTK_STATE_PRELIGHT: The mouse pointer is over the widget.
|
||||
@GTK_STATE_SELECTED:
|
||||
@GTK_STATE_INSENSITIVE: The state of the widget can not be altered by the
|
||||
user. Its appearance will usually indicate this.
|
||||
|
||||
<!-- ##### ENUM GtkSubmenuDirection ##### -->
|
||||
<para>
|
||||
Indicates the direction a sub-menu will appear.
|
||||
</para>
|
||||
|
||||
@GTK_DIRECTION_LEFT: A sub-menu will appear
|
||||
@GTK_DIRECTION_RIGHT:
|
||||
|
||||
<!-- ##### ENUM GtkSubmenuPlacement ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_TOP_BOTTOM:
|
||||
@GTK_LEFT_RIGHT:
|
||||
|
||||
<!-- ##### ENUM GtkToolbarStyle ##### -->
|
||||
<para>
|
||||
Used to customize the appearance of a #GtkToolbar.
|
||||
</para>
|
||||
|
||||
@GTK_TOOLBAR_ICONS: Buttons should display only icons in the toolbar.
|
||||
@GTK_TOOLBAR_TEXT: Buttons should display only text labels in the toolbar.
|
||||
@GTK_TOOLBAR_BOTH: Buttons should display text and icons in the toolbar.
|
||||
|
||||
<!-- ##### ENUM GtkTroughType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_TROUGH_NONE:
|
||||
@GTK_TROUGH_START:
|
||||
@GTK_TROUGH_END:
|
||||
@GTK_TROUGH_JUMP:
|
||||
|
||||
<!-- ##### ENUM GtkUpdateType ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_UPDATE_CONTINUOUS:
|
||||
@GTK_UPDATE_DISCONTINUOUS:
|
||||
@GTK_UPDATE_DELAYED:
|
||||
|
||||
<!-- ##### ENUM GtkVisibility ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@GTK_VISIBILITY_NONE:
|
||||
@GTK_VISIBILITY_PARTIAL:
|
||||
@GTK_VISIBILITY_FULL:
|
||||
|
||||
<!-- ##### ENUM GtkWindowPosition ##### -->
|
||||
<para>
|
||||
Window placement can be influenced using this enumeration.
|
||||
</para>
|
||||
|
||||
@GTK_WIN_POS_NONE: No influence is made on placement.
|
||||
@GTK_WIN_POS_CENTER: Windows should be placed in the center of the screen.
|
||||
@GTK_WIN_POS_MOUSE: Windows should be placed at the current mouse position.
|
||||
|
||||
<!-- ##### ENUM GtkWindowType ##### -->
|
||||
<para>
|
||||
A #GtkWindow can be of these types. A toplevel window has standard window
|
||||
decorations by default. A dialog may have fewer decorations and obey a
|
||||
different placement policy. A popup window will have no decorations.
|
||||
</para>
|
||||
<para>
|
||||
It should be noted that such decorations can often be over-ridden by modern
|
||||
window managers.
|
||||
</para>
|
||||
|
||||
@GTK_WINDOW_TOPLEVEL: A window for a typical application.
|
||||
@GTK_WINDOW_DIALOG: A window for transient messages and dialogs.
|
||||
@GTK_WINDOW_POPUP: A window for popups.
|
||||
|
||||
<!-- ##### ENUM GtkSortType ##### -->
|
||||
<para>
|
||||
Determines the direction of a sort.
|
||||
</para>
|
||||
|
||||
@GTK_SORT_ASCENDING: Sorting is in ascending order.
|
||||
@GTK_SORT_DESCENDING: Sorting is in descending order.
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkEventBox
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a widget used to catch events for widgets which do not have their own window.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkEventBox widget is a subclass of #GtkBin which also has its own window.
|
||||
It is useful since it allows you to catch events for widgets which do not
|
||||
have their own window.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkEventBox ##### -->
|
||||
<para>
|
||||
The #GtkEventBox-struct struct contains private data only, and
|
||||
should be accessed using the functions below.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_event_box_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkEventBox.
|
||||
</para>
|
||||
|
||||
@Returns: a new #GtkEventBox.
|
||||
|
||||
|
||||
@@ -1,63 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Version Information
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
variables and functions to check the GTK+ version.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
This section describes the variables and functions available to test the
|
||||
version of the GTK+ library in use.
|
||||
FIXME: probably merge with other general stuff.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### VARIABLE gtk_major_version ##### -->
|
||||
<para>
|
||||
The major version number of the GTK+ library.
|
||||
(e.g. in GTK+ version 1.2.5 this is 1.)
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE gtk_minor_version ##### -->
|
||||
<para>
|
||||
The minor version number of the GTK+ library.
|
||||
(e.g. in GTK+ version 1.2.5 this is 2.)
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE gtk_micro_version ##### -->
|
||||
<para>
|
||||
The micro version number of the GTK+ library.
|
||||
(e.g. in GTK+ version 1.2.5 this is 5.)
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE gtk_binary_age ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### VARIABLE gtk_interface_age ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_check_version ##### -->
|
||||
<para>
|
||||
Checks that the GTK+ library in use is compatable with the given version.
|
||||
</para>
|
||||
|
||||
@required_major: the required major version.
|
||||
@required_minor: the required major version.
|
||||
@required_micro: the required major version.
|
||||
@Returns: NULL if the GTK+ library is compatable with the given version, or
|
||||
a string describing the version mismatch.
|
||||
|
||||
|
||||
@@ -1,167 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkFileSelection
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
prompt the user for a file or directory name.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
GtkFileSelection should be used to retrieve file or directory names from the user. It will create a new dialog window containing a directory list, and a file list corresponding to the current working directory. The filesystem can be navigated using the directory list or the drop-down history menu. Alternatively, the TAB key can be used to navigate using filename completion - common in text based editors such as emacs and jed.
|
||||
</para>
|
||||
<para>
|
||||
File selection dialogs are created with a call to gtk_file_selection_new().
|
||||
</para>
|
||||
<para>
|
||||
The default filename can be set using gtk_file_selection_set_filename() and the selected filename retrieved using gtk_file_selection_get_filename().
|
||||
</para>
|
||||
<para>
|
||||
Use gtk_file_selection_complete() to display files that match a given pattern. This can be used for example, to show only *.txt files, or only files beginning with gtk*.
|
||||
</para>
|
||||
<para>
|
||||
Simple file operations; create directory, delete file, and rename file, are available from buttons at the top of the dialog. These can be hidden using gtk_file_selection_hide_fileop_buttons() and shown again using gtk_file_selection_show_fileop_buttons().
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title>Getting a filename from the user</title>
|
||||
<programlisting>
|
||||
|
||||
/* The file selection widget and the string to store the chosen filename */
|
||||
|
||||
GtkWidget *file_selector;
|
||||
gchar *selected_filename;
|
||||
|
||||
void store_filename(GtkFileSelection *selector, gpointer user_data) {
|
||||
selected_filename = gtk_file_selection_get_filename (GTK_FILE_SELECTION(file_selector));
|
||||
}
|
||||
|
||||
void create_file_selection(void) {
|
||||
|
||||
/* Create the selector */
|
||||
|
||||
file_selector = gtk_file_selection_new("Please select a file for editing.");
|
||||
|
||||
gtk_signal_connect (GTK_OBJECT (GTK_FILE_SELECTION(file_selector)->ok_button),
|
||||
"clicked", GTK_SIGNAL_FUNC (store_filename), NULL);
|
||||
|
||||
/* Ensure that the dialog box is destroyed when the user clicks a button. */
|
||||
|
||||
gtk_signal_connect_object (GTK_OBJECT (GTK_FILE_SELECTION(file_selector)->ok_button),
|
||||
"clicked", GTK_SIGNAL_FUNC (gtk_widget_destroy),
|
||||
(gpointer) file_selector);
|
||||
|
||||
gtk_signal_connect_object (GTK_OBJECT (GTK_FILE_SELECTION(file_selector)->cancel_button),
|
||||
"clicked", GTK_SIGNAL_FUNC (gtk_widget_destroy),
|
||||
(gpointer) file_selector);
|
||||
|
||||
/* Display that dialog */
|
||||
|
||||
gtk_widget_show (file_selector);
|
||||
}
|
||||
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>#GtkDialog</term>
|
||||
<listitem><para>Add your own widgets into the #GtkFileSelection.</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkFileSelection ##### -->
|
||||
<para>
|
||||
The #GtkFileSelection struct contains the following #GtkWidget fields:
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>*fileop_dialog;</entry>
|
||||
<entry>the dialog box used to display the #GtkFileSelection. It can be customized by adding/removing widgets from it using the standard #GtkDialog functions.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>*dir_list, *file_list;</entry>
|
||||
<entry>the two #GtkCList widgets corresponding to directories and files.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>*ok_button, *cancel_button;</entry>
|
||||
<entry>the two main buttons that signals should be connected to in order to perform an action when the user hits either OK or Cancel.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>*history_pulldown;</entry>
|
||||
<entry>the #GtkOptionMenu used to create the drop-down directory history.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>*fileop_c_dir, *fileop_del_file, *fileop_ren_file;</entry>
|
||||
<entry>the buttons that appear at the top of the file selection dialog. These "operation buttons" can be hidden and redisplayed with gtk_file_selection_hide_fileop_buttons() and gtk_file_selection_show_fileop_buttons() respectively.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_file_selection_new ##### -->
|
||||
<para>
|
||||
Creates a new file selection dialog box. By default it will contain a #GtkCList of the application's current working directory, and a file listing. Operation buttons that allow the user to create a directory, delete files and rename files, are also present.
|
||||
</para>
|
||||
|
||||
@title: a message that will be placed in the file requestor's titlebar.
|
||||
@Returns: the new file selection.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_file_selection_set_filename ##### -->
|
||||
<para>
|
||||
Sets a default path for the file requestor. If @filename includes a directory path, then the requestor will open with that path as its current working directory.
|
||||
|
||||
</para>
|
||||
|
||||
@filesel: a #GtkFileSelection.
|
||||
@filename: a string to set as the default file name.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_file_selection_get_filename ##### -->
|
||||
<para>
|
||||
Retrieves the currently selected filename from the file selection dialog. If no file is selected then the selected directory path is returned.
|
||||
</para>
|
||||
|
||||
@filesel: a #GtkFileSelection
|
||||
@Returns: a string containing the selected file's full path.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_file_selection_complete ##### -->
|
||||
<para>
|
||||
Will attempt to match @pattern to a valid filename in the current directory. If a match can be made, the matched filename will appear in the text entry field of the file selection dialog.
|
||||
If a partial match can be made, the "Files" list will contain those file names which have been partially matched.
|
||||
</para>
|
||||
|
||||
@filesel: a #GtkFileSelection.
|
||||
@pattern: a string of characters which may or may not match any filenames in the current directory.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_file_selection_show_fileop_buttons ##### -->
|
||||
<para>
|
||||
Shows the file operation buttons, if they have previously been hidden. The rest of the widgets in the dialog will be resized accordingly.
|
||||
</para>
|
||||
|
||||
@filesel: a #GtkFileSelection.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_file_selection_hide_fileop_buttons ##### -->
|
||||
<para>
|
||||
Hides the file operation buttons that normally appear at the top of the dialog. Useful if you wish to create a custom file selector, based on #GtkFileSelection.
|
||||
</para>
|
||||
|
||||
@filesel: a #GtkFileSelection.
|
||||
|
||||
|
||||
@@ -1,102 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkFixed
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a container which supports fixed sizes and positions of its children.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkFixed widget is a container which can place child widgets at fixed
|
||||
positions and with fixed sizes, given in pixels.
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkFixed ##### -->
|
||||
<para>
|
||||
The #GtkFixed-struct struct contains the following fields.
|
||||
(These fields should be considered read-only. They should never be set by
|
||||
an application.)
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#GList *children;</entry>
|
||||
<entry>a list of #GtkFixedChild elements, containing the child widgets and
|
||||
their positions.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### STRUCT GtkFixedChild ##### -->
|
||||
<para>
|
||||
The #GtkFixedChild-struct struct contains the following fields.
|
||||
(These fields should be considered read-only. They should never be set by
|
||||
an application.)
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>#GtkWidget *widget;</entry>
|
||||
<entry>the child #GtkWidget.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gint16 x;</entry>
|
||||
<entry>the horizontal position of the widget within the #GtkFixed
|
||||
container.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gint16 y;</entry>
|
||||
<entry>the vertical position of the widget within the #GtkFixed
|
||||
container.</entry>
|
||||
</row>
|
||||
|
||||
</tbody></tgroup></informaltable>
|
||||
</para>
|
||||
|
||||
@widget:
|
||||
@x:
|
||||
@y:
|
||||
|
||||
<!-- ##### FUNCTION gtk_fixed_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkFixed.
|
||||
</para>
|
||||
|
||||
@Returns: a new #GtkFixed.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_fixed_put ##### -->
|
||||
<para>
|
||||
Adds a widget to a #GtkFixed container at the given position.
|
||||
</para>
|
||||
|
||||
@fixed: a #GtkFixed.
|
||||
@widget: the widget to add.
|
||||
@x: the horizontal position to place the widget at.
|
||||
@y: the vertical position to place the widget at.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_fixed_move ##### -->
|
||||
<para>
|
||||
Moves a child of a #GtkFixed container to the given position.
|
||||
</para>
|
||||
|
||||
@fixed: a #GtkFixed.
|
||||
@widget: the child widget.
|
||||
@x: the horizontal position to move the widget to.
|
||||
@y: the vertical position to move the widget to.
|
||||
|
||||
|
||||
@@ -1,134 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkFontSelection
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a widget for selecting fonts.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkFontSelection widget lists the available fonts, styles and sizes,
|
||||
allowing the user to select a font.
|
||||
It is used in the #GtkFontSelectionDialog widget to provide a dialog box for
|
||||
selecting fonts.
|
||||
</para>
|
||||
<para>
|
||||
To set the font which is initially selected, use
|
||||
gtk_font_selection_set_font_name().
|
||||
</para>
|
||||
<para>
|
||||
To get the selected font use gtk_font_selection_get_font()
|
||||
or gtk_font_selection_get_font_name().
|
||||
</para>
|
||||
<para>
|
||||
To change the text which is shown in the preview area, use
|
||||
gtk_font_selection_set_preview_text().
|
||||
</para>
|
||||
<para>
|
||||
Filters can be used to limit the fonts shown. There are 2 filters in the
|
||||
#GtkFontSelection - a base filter and a user filter. The base filter
|
||||
can not be changed by the user, so this can be used when the user must choose
|
||||
from the restricted set of fonts (e.g. for a terminal-type application you may
|
||||
want to force the user to select a fixed-width font). The user filter can be
|
||||
changed or reset by the user, by using the 'Reset Filter' button or changing
|
||||
the options on the 'Filter' page of the widget.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkFontSelectionDialog</term>
|
||||
<listitem><para>a dialog box which uses #GtkFontSelection.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkFontSelection ##### -->
|
||||
<para>
|
||||
The #GtkFontSelection struct contains private data only, and should
|
||||
only be accessed using the functions below.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkFontSelection.
|
||||
</para>
|
||||
|
||||
@Returns: a new #GtkFontSelection.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_get_font ##### -->
|
||||
<para>
|
||||
Gets the currently-selected font.
|
||||
</para>
|
||||
|
||||
@fontsel: a #GtkFontSelection.
|
||||
@Returns: the currently-selected font, or NULL if no font is selected.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_get_font_name ##### -->
|
||||
<para>
|
||||
Gets the currently-selected font name.
|
||||
</para>
|
||||
|
||||
@fontsel: a #GtkFontSelection.
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_set_font_name ##### -->
|
||||
<para>
|
||||
Sets the currently-selected font.
|
||||
</para>
|
||||
|
||||
@fontsel: a #GtkFontSelection.
|
||||
@fontname: a fontname.
|
||||
@Returns: TRUE if the font was found.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_get_preview_text ##### -->
|
||||
<para>
|
||||
Gets the text displayed in the preview area.
|
||||
</para>
|
||||
|
||||
@fontsel: a #GtkFontSelection.
|
||||
@Returns: the text displayed in the preview area.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_set_preview_text ##### -->
|
||||
<para>
|
||||
Sets the text displayed in the preview area.
|
||||
</para>
|
||||
|
||||
@fontsel: a #GtkFontSelection.
|
||||
@text: the text to display in the preview area.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_set_filter ##### -->
|
||||
<para>
|
||||
Sets one of the two font filters, to limit the fonts shown.
|
||||
</para>
|
||||
|
||||
@fontsel: a #GtkFontSelection.
|
||||
@filter_type: which of the two font filters to set, either
|
||||
#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
|
||||
can be changed by the user, but the base filter is permanent.
|
||||
@font_type: the types of font to be shown. This is a bitwise combination of
|
||||
#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
|
||||
or #GTK_FONT_ALL to show all three font types.
|
||||
@foundries: a NULL-terminated array of strings containing foundry names which
|
||||
will be shown, or NULL to show all foundries.
|
||||
@weights: a NULL-terminated array of strings containing weight names which
|
||||
will be shown, or NULL to show all weights.
|
||||
@slants: a NULL-terminated array of strings containing slant names which
|
||||
will be shown, or NULL to show all slants.
|
||||
@setwidths: a NULL-terminated array of strings containing setwidth names which
|
||||
will be shown, or NULL to show all setwidths.
|
||||
@spacings: a NULL-terminated array of strings containing spacings which
|
||||
will be shown, or NULL to show all spacings.
|
||||
@charsets: a NULL-terminated array of strings containing charset names which
|
||||
will be shown, or NULL to show all charsets.
|
||||
|
||||
|
||||
@@ -1,178 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkFontSelectionDialog
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a dialog box for selecting fonts.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkFontSelectionDialog widget is a dialog box for selecting a font.
|
||||
</para>
|
||||
<para>
|
||||
To set the font which is initially selected, use
|
||||
gtk_font_selection_dialog_set_font_name().
|
||||
</para>
|
||||
<para>
|
||||
To get the selected font use gtk_font_selection_dialog_get_font()
|
||||
or gtk_font_selection_dialog_get_font_name().
|
||||
</para>
|
||||
<para>
|
||||
To change the text which is shown in the preview area, use
|
||||
gtk_font_selection_dialog_set_preview_text().
|
||||
</para>
|
||||
<para>
|
||||
Filters can be used to limit the fonts shown. There are 2 filters in the
|
||||
#GtkFontSelectionDialog - a base filter and a user filter. The base filter
|
||||
can not be changed by the user, so this can be used when the user must choose
|
||||
from the restricted set of fonts (e.g. for a terminal-type application you may
|
||||
want to force the user to select a fixed-width font). The user filter can be
|
||||
changed or reset by the user, by using the 'Reset Filter' button or changing
|
||||
the options on the 'Filter' page of the dialog.
|
||||
</para>
|
||||
|
||||
<example>
|
||||
<title>Setting a filter to show only fixed-width fonts.</title>
|
||||
<programlisting>
|
||||
gchar *spacings[] = { "c", "m", NULL };
|
||||
gtk_font_selection_dialog_set_filter (GTK_FONT_SELECTION_DIALOG (fontsel),
|
||||
GTK_FONT_FILTER_BASE, GTK_FONT_ALL,
|
||||
NULL, NULL, NULL, NULL, spacings, NULL);
|
||||
</programlisting>
|
||||
</example>
|
||||
|
||||
<para>
|
||||
To allow only true scalable fonts to be selected use:
|
||||
</para>
|
||||
|
||||
<example>
|
||||
<title>Setting a filter to show only true scalable fonts.</title>
|
||||
<programlisting>
|
||||
gtk_font_selection_dialog_set_filter (GTK_FONT_SELECTION_DIALOG (fontsel),
|
||||
GTK_FONT_FILTER_BASE, GTK_FONT_SCALABLE,
|
||||
NULL, NULL, NULL, NULL, NULL, NULL);
|
||||
</programlisting>
|
||||
</example>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkFontSelection</term>
|
||||
<listitem><para>the underlying widget for selecting fonts.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkFontSelectionDialog ##### -->
|
||||
<para>
|
||||
The #GtkFontSelectionDialog struct contains private data only, and should
|
||||
only be accessed using the functions below.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_dialog_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkFontSelectionDialog.
|
||||
</para>
|
||||
|
||||
@title: the title of the dialog box.
|
||||
@Returns: a new #GtkFontSelectionDialog.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_dialog_get_font ##### -->
|
||||
<para>
|
||||
Gets the currently-selected font.
|
||||
</para>
|
||||
|
||||
@fsd: a #GtkFontSelectionDialog.
|
||||
@Returns: the currently-selected font, or NULL if no font is selected.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_dialog_get_font_name ##### -->
|
||||
<para>
|
||||
Gets the currently-selected font name.
|
||||
</para>
|
||||
|
||||
@fsd: a #GtkFontSelectionDialog.
|
||||
@Returns: the currently-selected font name, or NULL if no font is selected.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_dialog_set_font_name ##### -->
|
||||
<para>
|
||||
Sets the currently-selected font.
|
||||
</para>
|
||||
|
||||
@fsd: a #GtkFontSelectionDialog.
|
||||
@fontname: a fontname.
|
||||
@Returns: TRUE if the font was found.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_dialog_get_preview_text ##### -->
|
||||
<para>
|
||||
Gets the text displayed in the preview area.
|
||||
</para>
|
||||
|
||||
@fsd: a #GtkFontSelectionDialog.
|
||||
@Returns: the text displayed in the preview area.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_dialog_set_preview_text ##### -->
|
||||
<para>
|
||||
Sets the text displayed in the preview area.
|
||||
</para>
|
||||
|
||||
@fsd: a #GtkFontSelectionDialog.
|
||||
@text: the text to display in the preview area.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_font_selection_dialog_set_filter ##### -->
|
||||
<para>
|
||||
Sets one of the two font filters, to limit the fonts shown.
|
||||
</para>
|
||||
|
||||
@fsd: a #GtkFontSelectionDialog.
|
||||
@filter_type: which of the two font filters to set, either
|
||||
#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter
|
||||
can be changed by the user, but the base filter is permanent.
|
||||
@font_type: the types of font to be shown. This is a bitwise combination of
|
||||
#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP,
|
||||
or #GTK_FONT_ALL to show all three font types.
|
||||
@foundries: a NULL-terminated array of strings containing foundry names which
|
||||
will be shown, or NULL to show all foundries.
|
||||
@weights: a NULL-terminated array of strings containing weight names which
|
||||
will be shown, or NULL to show all weights.
|
||||
@slants: a NULL-terminated array of strings containing slant names which
|
||||
will be shown, or NULL to show all slants.
|
||||
@setwidths: a NULL-terminated array of strings containing setwidth names which
|
||||
will be shown, or NULL to show all setwidths.
|
||||
@spacings: a NULL-terminated array of strings containing spacings which
|
||||
will be shown, or NULL to show all spacings.
|
||||
@charsets: a NULL-terminated array of strings containing charset names which
|
||||
will be shown, or NULL to show all charsets.
|
||||
|
||||
|
||||
<!-- ##### ENUM GtkFontType ##### -->
|
||||
<para>
|
||||
A set of bit flags used to specify the type of fonts shown
|
||||
when calling gtk_font_selection_dialog_set_filter() or
|
||||
gtk_font_selection_set_filter().
|
||||
</para>
|
||||
|
||||
@GTK_FONT_BITMAP: bitmap fonts.
|
||||
@GTK_FONT_SCALABLE: scalable fonts.
|
||||
@GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts.
|
||||
@GTK_FONT_ALL: a bitwise combination of all of the above.
|
||||
|
||||
<!-- ##### ENUM GtkFontFilterType ##### -->
|
||||
<para>
|
||||
A set of bit flags used to specify the filter being set
|
||||
when calling gtk_font_selection_dialog_set_filter() or
|
||||
gtk_font_selection_set_filter().
|
||||
</para>
|
||||
|
||||
@GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user.
|
||||
@GTK_FONT_FILTER_USER: the user filter, which can be changed from within the
|
||||
'Filter' page of the #GtkFontSelection widget.
|
||||
|
||||
@@ -1,89 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkFrame
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
A bin with a decorative frame and optional label.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The frame widget is a Bin that surrounds its child
|
||||
with a decorative frame and an optional label.
|
||||
If present, the label is drawn in a gap in the
|
||||
top side of the frame. The position of the
|
||||
label can be controlled with gtk_frame_set_label_align().
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkFrame ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_frame_new ##### -->
|
||||
<para>
|
||||
Create a new Frame, with optional label @label.
|
||||
If @label is %NULL, the label is omitted.
|
||||
</para>
|
||||
|
||||
@label:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_frame_set_label ##### -->
|
||||
<para>
|
||||
|
||||
Set the text of the label. If @label is %NULL,
|
||||
the current label, if any, is removed.
|
||||
</para>
|
||||
|
||||
@frame:
|
||||
@label:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_frame_set_label_align ##### -->
|
||||
<para>
|
||||
Set the alignment of the Frame widget's label. The
|
||||
default value for a newly created Frame is 0.0.
|
||||
</para>
|
||||
|
||||
@frame: The Frame widget.
|
||||
@xalign: The position of the label along the top edge
|
||||
of the widget. A value of 0.0 represents left alignment;
|
||||
1.0 represents right alignment.
|
||||
@yalign: The y alignment of the label. Currently ignored.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_frame_set_shadow_type ##### -->
|
||||
<para>
|
||||
Set the shadow type for the Frame widget.
|
||||
</para>
|
||||
|
||||
@frame: The Frame widget.
|
||||
@type: New shadow type.
|
||||
|
||||
|
||||
<!-- ##### ARG GtkFrame:label ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkFrame:label_xalign ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkFrame:label_yalign ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### ARG GtkFrame:shadow ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@@ -1,40 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkGammaCurve
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a subclass of #GtkCurve for editing gamma curves.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkGammaCurve widget is a subclass of #GtkCurve specifically for
|
||||
editing gamma curves, which are used in graphics applications such as the
|
||||
Gimp.
|
||||
</para>
|
||||
<para>
|
||||
The #GammaCurve widget shows a curve which the user can edit with the mouse
|
||||
just like a #GtkCurve widget. On the right of the curve it also displays
|
||||
5 buttons, 3 of which change between the 3 curve modes (spline, linear and
|
||||
free), and the other 2 set the curve to a particular gamma value, or reset it
|
||||
to a straight line.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkGammaCurve ##### -->
|
||||
<para>
|
||||
The #GtkGammaCurve-struct struct contains private data only, and
|
||||
should be accessed using the functions below.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_gamma_curve_new ##### -->
|
||||
<para>
|
||||
Creates a new #GtkGammaCurve.
|
||||
</para>
|
||||
|
||||
@Returns: a new #GtkGammaCurve.
|
||||
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
Graphics Contexts
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
provides access to a shared pool of #GdkGC objects.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
These functions provide access to a shared pool of #GdkGC objects.
|
||||
When a new #GdkGC is needed, gtk_gc_get() is called with the required depth,
|
||||
colormap and #GdkGCValues. If a #GdkGC with the required properties already
|
||||
exists then that is returned. If not, a new #GdkGC is created.
|
||||
When the #GdkGC is no longer needed, gtk_gc_release() is called.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### FUNCTION gtk_gc_get ##### -->
|
||||
<para>
|
||||
Gets a #GdkGC with the given depth, colormap and #GdkGCValues.
|
||||
If a #GdkGC with the given properties already exists then it is returned,
|
||||
otherwise a new #GdkGC is created.
|
||||
The returned #GdkGC should be released with gtk_gc_release() when it is no
|
||||
longer needed.
|
||||
</para>
|
||||
|
||||
@depth: the depth of the #GdkGC to create.
|
||||
@colormap: the #GdkColormap (FIXME: I don't know why this is needed).
|
||||
@values: a #GdkGCValues struct containing settings for the #GdkGC.
|
||||
@values_mask: a set of flags indicating which of the fields in @values has
|
||||
been set.
|
||||
@Returns: a #GdkGC.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_gc_release ##### -->
|
||||
<para>
|
||||
Releases a #GdkGC allocated using gtk_gc_get().
|
||||
</para>
|
||||
|
||||
@gc: a #GdkGC.
|
||||
|
||||
|
||||
@@ -1,157 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkHandleBox
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a widget for detachable window portions.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
The #GtkHandleBox widget allows a portion of a window to be "torn
|
||||
off". It is a bin widget which displays its child and a handle that
|
||||
the user can drag to tear off a separate window (the <firstterm>float
|
||||
window</firstterm>) containing the child widget. A thin
|
||||
<firstterm>ghost</firstterm> is drawn in the original location of the
|
||||
handlebox. By dragging the separate window back to its original
|
||||
location, it can be reattached.
|
||||
</para>
|
||||
<para>
|
||||
When reattaching, the ghost and float window, must be aligned
|
||||
along one of the edges, the <firstterm>snap edge</firstterm>.
|
||||
This either can be specified by the application programmer
|
||||
explicitely, or GTK+ will pick a reasonable default based
|
||||
on the handle position.
|
||||
</para>
|
||||
<para>
|
||||
To make detaching and reattaching the handlebox as minimally confusing
|
||||
as possible to the user, it is important to set the snap edge so that
|
||||
the snap edge does not move when the handlebox is deattached. For
|
||||
instance, if the handlebox is packed at the bottom of a VBox, then
|
||||
when the handlebox is detached, the bottom edge of the handlebox's
|
||||
allocation will remain fixed as the height of the handlebox shrinks,
|
||||
so the snap edge should be set to %GTK_POS_BOTTOM.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkHandleBox ##### -->
|
||||
<para>
|
||||
The #GtkHandleBox-struct struct contains the following fields.
|
||||
(These fields should be considered read-only. They should never be set by
|
||||
an application.)
|
||||
|
||||
<informaltable pgwide=1 frame="none" role="struct">
|
||||
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
|
||||
<tbody>
|
||||
|
||||
<row>
|
||||
<entry>GtkShadowType shadow_type;</entry>
|
||||
<entry>The shadow type for the entry. (See gtk_handle_box_set_shadow_type()).</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>GtkPositionType handle_position;</entry>
|
||||
<entry>The position of the handlebox's handle with respect
|
||||
to the child. (See gtk_handle_box_set_handle_position())</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>gint snap_edge;</entry>
|
||||
<entry>A value of type #GtkPosition type indicating snap edge for the widget.
|
||||
(See gtk_handle_box_set_snap_edge). The value of -1 indicates
|
||||
that this value has not been set.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>#gboolean child_detached;</entry>
|
||||
<entry>A boolean value indicating whether the handlebox's
|
||||
child is attached or detached.</entry>
|
||||
</row>
|
||||
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_handle_box_new ##### -->
|
||||
<para>
|
||||
Create a new handle box.
|
||||
</para>
|
||||
|
||||
@Returns: a new #GtkHandleBox.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_handle_box_set_shadow_type ##### -->
|
||||
<para>
|
||||
Sets the type of shadow to be drawn around the border
|
||||
of the
|
||||
</para>
|
||||
|
||||
@handle_box: a #GtkHandleBox
|
||||
@type: the shadow type.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_handle_box_set_handle_position ##### -->
|
||||
<para>
|
||||
Sets the side of the handlebox where the handle is drawn.
|
||||
</para>
|
||||
|
||||
@handle_box: a #GtkHandleBox
|
||||
@position: the side of the handlebox where the handle should be drawn.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_handle_box_set_snap_edge ##### -->
|
||||
<para>
|
||||
Sets the snap edge of a handlebox. The snap edge is
|
||||
the edge of the detached child that must be aligned
|
||||
with the corresponding edge of the "ghost" left
|
||||
behind when the child was detached to reattach
|
||||
the torn-off window. Usually, the snap edge should
|
||||
be chosen so that it stays in the same place on
|
||||
the screen when the handlebox is torn off.
|
||||
</para>
|
||||
<para>
|
||||
If the snap edge is not set, then an appropriate value
|
||||
will be guessed from the handle position. If the
|
||||
handle position is %GTK_POS_RIGHT or %GTK_POS_LEFT,
|
||||
then the snap edge will be %GTK_POS_TOP, otherwise
|
||||
it will be %GTK_POS_LEFT.
|
||||
</para>
|
||||
|
||||
@handle_box: a #GtkHandleBox
|
||||
@edge: the snap edge, or -1 to unset the value; in which
|
||||
case GTK+ will try to guess an appropriate value
|
||||
in the future.
|
||||
|
||||
|
||||
<!-- ##### SIGNAL GtkHandleBox::child-attached ##### -->
|
||||
<para>
|
||||
This signal is emitted when the contents of the
|
||||
handlebox are reattached to the main window.
|
||||
</para>
|
||||
|
||||
@handlebox: the object which received the signal.
|
||||
@widget: the child widget of the handlebox.
|
||||
(this argument provides no extra information
|
||||
and is here only for backwards-compatibility)
|
||||
|
||||
<!-- ##### SIGNAL GtkHandleBox::child-detached ##### -->
|
||||
<para>
|
||||
This signal is emitted when the contents of the
|
||||
handlebox are detached from the main window.
|
||||
</para>
|
||||
|
||||
@handlebox: the object which received the signal.
|
||||
@widget: the child widget of the handlebox.
|
||||
(this argument provides no extra information
|
||||
and is here only for backwards-compatibility)
|
||||
|
||||
<!-- ##### ARG GtkHandleBox:shadow ##### -->
|
||||
<para>
|
||||
Determines the shadow type for the handlebox.
|
||||
</para>
|
||||
|
||||
@@ -1,98 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkHButtonBox
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
a container for arranging button horizontally.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
A button box should be used to provide a consistent layout of buttons
|
||||
throughout your application. There is one default layout and a default
|
||||
spacing value that are persistant across all #HButtonBox widgets.
|
||||
</para>
|
||||
<para>
|
||||
The layout/spacing can then be altered by the programmer, or if desired, by
|
||||
the user to alter the 'feel' of a program to a small degree.
|
||||
</para>
|
||||
<para>
|
||||
A #HButtonBox is created with gtk_hbutton_box_new(). Buttons are packed into
|
||||
a button box the same way as any other box, using gtk_box_pack_start() or
|
||||
gtk_box_pack_end().
|
||||
</para>
|
||||
<para>
|
||||
The default spacing between buttons can be set with
|
||||
gtk_hbutton_box_set_spacing_default() and queried with
|
||||
gtk_hbutton_box_get_spacing_default().
|
||||
</para>
|
||||
<para>
|
||||
The arrangement and layout of the buttons can be changed using
|
||||
gtk_hbutton_box_set_layout_default() and queried with
|
||||
gtk_hbutton_box_get_layout_default().
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>#GtkBox</term>
|
||||
<listitem><para>Used to pack widgets into button boxes.</para></listitem>
|
||||
</varlistentry><varlistentry>
|
||||
<term>#GtkButtonBox</term>
|
||||
<listitem><para>Provides functions for controlling button boxes.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>#GtkVButtonBox</term>
|
||||
<listitem><para>Pack buttons vertically</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkHButtonBox ##### -->
|
||||
<para>
|
||||
<structfield>button_box</structfield> is the #GtkHButtonBox widget itself and
|
||||
should not be modified directly.
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_hbutton_box_new ##### -->
|
||||
<para>
|
||||
Creates a new horizontal button box.
|
||||
</para>
|
||||
|
||||
@Returns: a new button box #GtkWidget.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_hbutton_box_get_spacing_default ##### -->
|
||||
<para>
|
||||
Retrieves the current default spacing for horizontal button boxes. This is the number of pixels
|
||||
to be placed between the buttons when they are arranged.
|
||||
</para>
|
||||
|
||||
@Returns: the default number of pixels between buttons.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_hbutton_box_get_layout_default ##### -->
|
||||
<para>
|
||||
Retrieves the current layout used to arrange buttons in button box widgets.
|
||||
</para>
|
||||
|
||||
@Returns: the current #GtkButtonBoxStyle.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_hbutton_box_set_spacing_default ##### -->
|
||||
<para>
|
||||
Changes the default spacing that is placed between widgets in an
|
||||
horizontal button box.
|
||||
</para>
|
||||
|
||||
@spacing: an integer value.
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_hbutton_box_set_layout_default ##### -->
|
||||
<para>
|
||||
Sets a new layout mode that will be used by all button boxes.
|
||||
</para>
|
||||
|
||||
@layout: a new #GtkButtonBoxStyle.
|
||||
|
||||
|
||||
@@ -1,46 +0,0 @@
|
||||
<!-- ##### SECTION Title ##### -->
|
||||
GtkHBox
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
horizontal container box
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
GtkHBox is a container that organizes child widgets into a single row.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Use the #GtkBox packing interface to determine the arrangement,
|
||||
spacing, width, and alignment of GtkHBox children.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
All children are allocated the same height.
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<term>#GtkVBox</term>
|
||||
<listitem><para>a sister class that organizes widgets into a column.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GtkHBox ##### -->
|
||||
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gtk_hbox_new ##### -->
|
||||
<para>
|
||||
Creates a new GtkHBox.
|
||||
</para>
|
||||
|
||||
@homogeneous: %TRUE if all children are to be given equal space allotments.
|
||||
@spacing: the number of pixels to place by default between children.
|
||||
@Returns: a new GtkHBox.
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user