AuroraMiddleware/gtk
1
0
Fork 1
mirror of https://gitlab.gnome.org/GNOME/gtk.git synced 2024-12-23 20:30:15 +00:00
Code Issues Projects Releases Wiki Activity

Initial revision

Browse Source
This commit is contained in:
Owen Taylor 1999-08-16 18:51:52 +00:00
parent 0455fa3029
commit 91a5956707
157 changed files with 51858 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/AUTHORS Normal file
View File

@ -0,0 +1,7 @@
Damon Chaplin <damon@karuna.freeserve.co.uk> and others.
See:
http://www.gtk.org/rdp/status.html
for a complete list.

30
docs/reference/COPYING Normal file
View File

@ -0,0 +1,30 @@
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.

0
docs/reference/ChangeLog Normal file
View File

62
docs/reference/README Normal file
View File

@ -0,0 +1,62 @@
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

39
docs/reference/README.cvs-commits Normal file
View File

@ -0,0 +1,39 @@
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)

50
docs/reference/gdk/Makefile.am Normal file
View File

@ -0,0 +1,50 @@
## 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

2919
docs/reference/gdk/gdk-decl.txt Normal file
View File

File diff suppressed because it is too large Load Diff

59
docs/reference/gdk/gdk-docs.sgml Normal file
View File

@ -0,0 +1,59 @@
<!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-Bitmaps-and-Pixmaps;
&gdk-Images;
&gdk-GdkRGB;
&gdk-Colormaps-and-Colors;
&gdk-Fonts;
&gdk-Drawing-Primitives;
&gdk-Graphics-Contexts;
&gdk-Visuals;
&gdk-Windows;
&gdk-Selections;
&gdk-Properties-and-Atoms;
&gdk-Input-Methods;
&gdk-Input-Contexts;
&gdk-Color-Contexts;
&gdk-Points-Rectangles-and-Regions;
&gdk-Threads;
&gdk-Key-Values;
&gdk-Input-Devices;
&gdk-Events;
&gdk-Event-Structures;
&gdk-Cursors;
&gdk-Input;
&gdk-Drag-and-Drop;
</chapter>
</book>

23
docs/reference/gdk/gdk-overrides.txt Normal file
View File

@ -0,0 +1,23 @@
# 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>

572
docs/reference/gdk/gdk-sections.txt Normal file
View File

@ -0,0 +1,572 @@
<INCLUDE>gdk/gdk.h</INCLUDE>
<SECTION>
<TITLE>General</TITLE>
<FILE>general</FILE>
gdk_init
gdk_init_check
gdk_exit
GdkStatus
GDK_NONE
GDK_CURRENT_TIME
GDK_PRIORITY_EVENTS
gdk_set_locale
gdk_get_show_events
gdk_set_show_events
gdk_add_client_message_filter
gdk_set_sm_client_id
gdk_get_use_xshm
gdk_set_use_xshm
gdk_get_display
gdk_screen_width
gdk_screen_height
gdk_screen_width_mm
gdk_screen_height_mm
gdk_pointer_grab
gdk_pointer_ungrab
gdk_keyboard_grab
gdk_keyboard_ungrab
gdk_pointer_is_grabbed
gdk_flush
gdk_beep
gdk_key_repeat_disable
gdk_key_repeat_restore
gdk_error_trap_push
gdk_error_trap_pop
<SUBSECTION Private>
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
GdkImageType
gdk_image_new_bitmap
gdk_image_new
gdk_image_get
gdk_image_put_pixel
gdk_image_get_pixel
gdk_image_destroy
</SECTION>
<SECTION>
<TITLE>GdkRGB</TITLE>
<FILE>rgb</FILE>
GdkRgbCmap
GdkRgbDither
gdk_rgb_init
gdk_rgb_cmap_new
gdk_rgb_cmap_free
gdk_rgb_gc_set_foreground
gdk_rgb_gc_set_background
gdk_draw_rgb_image
gdk_draw_indexed_image
gdk_draw_gray_image
gdk_draw_rgb_32_image
gdk_draw_rgb_image_dithalign
gdk_rgb_xpixel_from_rgb
gdk_rgb_set_verbose
gdk_rgb_ditherable
gdk_rgb_set_install
gdk_rgb_set_min_colors
gdk_rgb_get_visual
gdk_rgb_get_cmap
</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
</SECTION>
<SECTION>
<TITLE>Drawing Primitives</TITLE>
<FILE>drawing</FILE>
GdkFill
GdkFillRule
GdkLineStyle
GdkCapStyle
GdkJoinStyle
gdk_draw_point
gdk_draw_line
gdk_draw_rectangle
gdk_draw_arc
gdk_draw_polygon
gdk_draw_string
gdk_draw_text
gdk_draw_text_wc
gdk_draw_pixmap
gdk_draw_bitmap
gdk_draw_image
gdk_draw_points
gdk_draw_segments
GdkSegment
gdk_draw_lines
</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
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
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
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
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
GdkPropertyState
GdkPropMode
GdkTarget
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
gdk_property_delete
</SECTION>
<SECTION>
<TITLE>Input Methods</TITLE>
<FILE>input_methods</FILE>
GdkIMStyle
GdkWChar
gdk_im_ready
gdk_im_begin
gdk_im_end
gdk_im_decide_style
gdk_im_set_best_style
gdk_wcstombs
gdk_mbstowcs
</SECTION>
<SECTION>
<TITLE>Input Contexts</TITLE>
<FILE>input_contexts</FILE>
GdkIC
GdkICAttr
GdkICAttributesType
gdk_ic_new
gdk_ic_destroy
gdk_ic_get_style
gdk_ic_set_attr
gdk_ic_get_attr
gdk_ic_get_events
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
GdkRectangle
gdk_rectangle_intersect
gdk_rectangle_union
GdkRegion
gdk_region_new
gdk_region_destroy
gdk_region_get_clipbox
gdk_region_empty
gdk_region_equal
gdk_region_point_in
gdk_region_rect_in
GdkOverlapType
gdk_region_polygon
gdk_region_offset
gdk_region_shrink
gdk_region_union_with_rect
gdk_regions_intersect
gdk_regions_union
gdk_regions_subtract
gdk_regions_xor
</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
GdkExtensionMode
GdkDeviceKey
GdkDeviceInfo
gdk_input_init
gdk_input_exit
gdk_input_list_devices
gdk_input_set_extension_events
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
</SECTION>
<SECTION>
<TITLE>Events</TITLE>
<FILE>events</FILE>
GdkEventType
GdkEventMask
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
gdk_event_handler_set
gdk_event_send_client_message
GdkEventFunc
gdk_event_send_clientmessage_toall
</SECTION>
<SECTION>
<TITLE>Event Structures</TITLE>
<FILE>event_structs</FILE>
GdkEventAny
GdkEventExpose
GdkEventNoExpose
GdkEventVisibility
GdkVisibilityState
GdkEventMotion
GdkEventButton
GdkEventKey
GdkEventCrossing
GdkCrossingMode
GdkNotifyType
GdkEventFocus
GdkEventConfigure
GdkEventProperty
GdkEventSelection
GdkEventProximity
GdkEventClient
GdkEventDND
GdkEvent
GdkXEvent
</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>

202
docs/reference/gdk/tmpl/color_contexts.sgml Normal file
View File

@ -0,0 +1,202 @@
<!-- ##### SECTION Title ##### -->
Color Contexts
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</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:

390
docs/reference/gdk/tmpl/colors.sgml Normal file
View File

@ -0,0 +1,390 @@
<!-- ##### 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

98
docs/reference/gdk/tmpl/cursors.sgml Normal file
View File

@ -0,0 +1,98 @@
<!-- ##### SECTION Title ##### -->
Cursors
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### 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).
</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, &amp;fg, &amp;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.

187
docs/reference/gdk/tmpl/dnd.sgml Normal file
View File

@ -0,0 +1,187 @@
<!-- ##### SECTION Title ##### -->
Drag and Drop
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</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:

260
docs/reference/gdk/tmpl/drawing.sgml Normal file
View File

@ -0,0 +1,260 @@
<!-- ##### SECTION Title ##### -->
Drawing Primitives
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GdkFill ##### -->
<para>
</para>
@GDK_SOLID:
@GDK_TILED:
@GDK_STIPPLED:
@GDK_OPAQUE_STIPPLED:
<!-- ##### ENUM GdkFillRule ##### -->
<para>
</para>
@GDK_EVEN_ODD_RULE:
@GDK_WINDING_RULE:
<!-- ##### ENUM GdkLineStyle ##### -->
<para>
</para>
@GDK_LINE_SOLID:
@GDK_LINE_ON_OFF_DASH:
@GDK_LINE_DOUBLE_DASH:
<!-- ##### ENUM GdkCapStyle ##### -->
<para>
</para>
@GDK_CAP_NOT_LAST:
@GDK_CAP_BUTT:
@GDK_CAP_ROUND:
@GDK_CAP_PROJECTING:
<!-- ##### ENUM GdkJoinStyle ##### -->
<para>
</para>
@GDK_JOIN_MITER:
@GDK_JOIN_ROUND:
@GDK_JOIN_BEVEL:
<!-- ##### FUNCTION gdk_draw_point ##### -->
<para>
</para>
@drawable:
@gc:
@x:
@y:
<!-- ##### FUNCTION gdk_draw_line ##### -->
<para>
</para>
@drawable:
@gc:
@x1:
@y1:
@x2:
@y2:
<!-- ##### FUNCTION gdk_draw_rectangle ##### -->
<para>
</para>
@drawable:
@gc:
@filled:
@x:
@y:
@width:
@height:
<!-- ##### FUNCTION gdk_draw_arc ##### -->
<para>
</para>
@drawable:
@gc:
@filled:
@x:
@y:
@width:
@height:
@angle1:
@angle2:
<!-- ##### FUNCTION gdk_draw_polygon ##### -->
<para>
</para>
@drawable:
@gc:
@filled:
@points:
@npoints:
<!-- ##### FUNCTION gdk_draw_string ##### -->
<para>
</para>
@drawable:
@font:
@gc:
@x:
@y:
@string:
<!-- ##### FUNCTION gdk_draw_text ##### -->
<para>
</para>
@drawable:
@font:
@gc:
@x:
@y:
@text:
@text_length:
<!-- ##### FUNCTION gdk_draw_text_wc ##### -->
<para>
</para>
@drawable:
@font:
@gc:
@x:
@y:
@text:
@text_length:
<!-- ##### FUNCTION gdk_draw_pixmap ##### -->
<para>
</para>
@drawable:
@gc:
@src:
@xsrc:
@ysrc:
@xdest:
@ydest:
@width:
@height:
<!-- ##### FUNCTION gdk_draw_bitmap ##### -->
<para>
</para>
@drawable:
@gc:
@src:
@xsrc:
@ysrc:
@xdest:
@ydest:
@width:
@height:
<!-- ##### FUNCTION gdk_draw_image ##### -->
<para>
</para>
@drawable:
@gc:
@image:
@xsrc:
@ysrc:
@xdest:
@ydest:
@width:
@height:
<!-- ##### FUNCTION gdk_draw_points ##### -->
<para>
</para>
@drawable:
@gc:
@points:
@npoints:
<!-- ##### FUNCTION gdk_draw_segments ##### -->
<para>
</para>
@drawable:
@gc:
@segs:
@nsegs:
<!-- ##### STRUCT GdkSegment ##### -->
<para>
</para>
@x1:
@y1:
@x2:
@y2:
<!-- ##### FUNCTION gdk_draw_lines ##### -->
<para>
</para>
@drawable:
@gc:
@points:
@npoints:

257
docs/reference/gdk/tmpl/event_structs.sgml Normal file
View File

@ -0,0 +1,257 @@
<!-- ##### SECTION Title ##### -->
Event Structures
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GdkEventAny ##### -->
<para>
</para>
@type:
@window:
@send_event:
<!-- ##### STRUCT GdkEventExpose ##### -->
<para>
</para>
@type:
@window:
@send_event:
@area:
@count:
<!-- ##### STRUCT GdkEventNoExpose ##### -->
<para>
</para>
@type:
@window:
@send_event:
<!-- ##### STRUCT GdkEventVisibility ##### -->
<para>
</para>
@type:
@window:
@send_event:
@state:
<!-- ##### ENUM GdkVisibilityState ##### -->
<para>
</para>
@GDK_VISIBILITY_UNOBSCURED:
@GDK_VISIBILITY_PARTIAL:
@GDK_VISIBILITY_FULLY_OBSCURED:
<!-- ##### STRUCT GdkEventMotion ##### -->
<para>
</para>
@type:
@window:
@send_event:
@time:
@x:
@y:
@pressure:
@xtilt:
@ytilt:
@state:
@is_hint:
@source:
@deviceid:
@x_root:
@y_root:
<!-- ##### STRUCT GdkEventButton ##### -->
<para>
</para>
@type:
@window:
@send_event:
@time:
@x:
@y:
@pressure:
@xtilt:
@ytilt:
@state:
@button:
@source:
@deviceid:
@x_root:
@y_root:
<!-- ##### STRUCT GdkEventKey ##### -->
<para>
</para>
@type:
@window:
@send_event:
@time:
@state:
@keyval:
@length:
@string:
<!-- ##### STRUCT GdkEventCrossing ##### -->
<para>
</para>
@type:
@window:
@send_event:
@subwindow:
@time:
@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>
</para>
@type:
@window:
@send_event:
@in:
<!-- ##### STRUCT GdkEventConfigure ##### -->
<para>
</para>
@type:
@window:
@send_event:
@x:
@y:
@width:
@height:
<!-- ##### STRUCT GdkEventProperty ##### -->
<para>
</para>
@type:
@window:
@send_event:
@atom:
@time:
@state:
<!-- ##### STRUCT GdkEventSelection ##### -->
<para>
</para>
@type:
@window:
@send_event:
@selection:
@target:
@property:
@requestor:
@time:
<!-- ##### STRUCT GdkEventProximity ##### -->
<para>
</para>
@type:
@window:
@send_event:
@time:
@source:
@deviceid:
<!-- ##### STRUCT GdkEventClient ##### -->
<para>
</para>
@type:
@window:
@send_event:
@message_type:
@data_format:
<!-- ##### STRUCT GdkEventDND ##### -->
<para>
</para>
@type:
@window:
@send_event:
@context:
@time:
@x_root:
@y_root:
<!-- ##### UNION GdkEvent ##### -->
<para>
</para>
<!-- ##### TYPEDEF GdkXEvent ##### -->
<para>
</para>

185
docs/reference/gdk/tmpl/events.sgml Normal file
View File

@ -0,0 +1,185 @@
<!-- ##### SECTION Title ##### -->
Events
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GdkEventType ##### -->
<para>
</para>
@GDK_NOTHING:
@GDK_DELETE:
@GDK_DESTROY:
@GDK_EXPOSE:
@GDK_MOTION_NOTIFY:
@GDK_BUTTON_PRESS:
@GDK_2BUTTON_PRESS:
@GDK_3BUTTON_PRESS:
@GDK_BUTTON_RELEASE:
@GDK_KEY_PRESS:
@GDK_KEY_RELEASE:
@GDK_ENTER_NOTIFY:
@GDK_LEAVE_NOTIFY:
@GDK_FOCUS_CHANGE:
@GDK_CONFIGURE:
@GDK_MAP:
@GDK_UNMAP:
@GDK_PROPERTY_NOTIFY:
@GDK_SELECTION_CLEAR:
@GDK_SELECTION_REQUEST:
@GDK_SELECTION_NOTIFY:
@GDK_PROXIMITY_IN:
@GDK_PROXIMITY_OUT:
@GDK_DRAG_ENTER:
@GDK_DRAG_LEAVE:
@GDK_DRAG_MOTION:
@GDK_DRAG_STATUS:
@GDK_DROP_START:
@GDK_DROP_FINISHED:
@GDK_CLIENT_EVENT:
@GDK_VISIBILITY_NOTIFY:
@GDK_NO_EXPOSE:
<!-- ##### ENUM GdkEventMask ##### -->
<para>
</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:
<!-- ##### FUNCTION gdk_events_pending ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_event_peek ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_event_get ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_event_get_graphics_expose ##### -->
<para>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gdk_event_put ##### -->
<para>
</para>
@event:
<!-- ##### FUNCTION gdk_event_copy ##### -->
<para>
</para>
@event:
@Returns:
<!-- ##### FUNCTION gdk_event_free ##### -->
<para>
</para>
@event:
<!-- ##### FUNCTION gdk_event_get_time ##### -->
<para>
</para>
@event:
@Returns:
<!-- ##### FUNCTION gdk_event_handler_set ##### -->
<para>
</para>
@func:
@data:
@notify:
<!-- ##### FUNCTION gdk_event_send_client_message ##### -->
<para>
</para>
@event:
@xid:
@Returns:
<!-- ##### USER_FUNCTION GdkEventFunc ##### -->
<para>
</para>
@event:
@data:
<!-- ##### FUNCTION gdk_event_send_clientmessage_toall ##### -->
<para>
</para>
@event:

581
docs/reference/gdk/tmpl/fonts.sgml Normal file
View File

@ -0,0 +1,581 @@
<!-- ##### 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.

314
docs/reference/gdk/tmpl/gcs.sgml Normal file
View File

@ -0,0 +1,314 @@
<!-- ##### SECTION Title ##### -->
Graphics Contexts
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GdkGC ##### -->
<para>
</para>
@dummy_var:
<!-- ##### STRUCT GdkGCValues ##### -->
<para>
</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>
</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>
</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>
</para>
@window:
@Returns:
<!-- ##### FUNCTION gdk_gc_new_with_values ##### -->
<para>
</para>
@window:
@values:
@values_mask:
@Returns:
<!-- ##### FUNCTION gdk_gc_ref ##### -->
<para>
</para>
@gc:
@Returns:
<!-- ##### FUNCTION gdk_gc_unref ##### -->
<para>
</para>
@gc:
<!-- ##### FUNCTION gdk_gc_destroy ##### -->
<para>
</para>
@gc:
<!-- ##### FUNCTION gdk_gc_get_values ##### -->
<para>
</para>
@gc:
@values:
<!-- ##### FUNCTION gdk_gc_set_foreground ##### -->
<para>
</para>
@gc:
@color:
<!-- ##### FUNCTION gdk_gc_set_background ##### -->
<para>
</para>
@gc:
@color:
<!-- ##### FUNCTION gdk_gc_set_font ##### -->
<para>
</para>
@gc:
@font:
<!-- ##### FUNCTION gdk_gc_set_function ##### -->
<para>
</para>
@gc:
@function:
<!-- ##### FUNCTION gdk_gc_set_fill ##### -->
<para>
</para>
@gc:
@fill:
<!-- ##### FUNCTION gdk_gc_set_tile ##### -->
<para>
</para>
@gc:
@tile:
<!-- ##### FUNCTION gdk_gc_set_stipple ##### -->
<para>
</para>
@gc:
@stipple:
<!-- ##### FUNCTION gdk_gc_set_ts_origin ##### -->
<para>
</para>
@gc:
@x:
@y:
<!-- ##### FUNCTION gdk_gc_set_clip_origin ##### -->
<para>
</para>
@gc:
@x:
@y:
<!-- ##### FUNCTION gdk_gc_set_clip_mask ##### -->
<para>
</para>
@gc:
@mask:
<!-- ##### FUNCTION gdk_gc_set_clip_rectangle ##### -->
<para>
</para>
@gc:
@rectangle:
<!-- ##### FUNCTION gdk_gc_set_clip_region ##### -->
<para>
</para>
@gc:
@region:
<!-- ##### FUNCTION gdk_gc_set_subwindow ##### -->
<para>
</para>
@gc:
@mode:
<!-- ##### ENUM GdkSubwindowMode ##### -->
<para>
</para>
@GDK_CLIP_BY_CHILDREN:
@GDK_INCLUDE_INFERIORS:
<!-- ##### FUNCTION gdk_gc_set_exposures ##### -->
<para>
</para>
@gc:
@exposures:
<!-- ##### FUNCTION gdk_gc_set_line_attributes ##### -->
<para>
</para>
@gc:
@line_width:
@line_style:
@cap_style:
@join_style:
<!-- ##### FUNCTION gdk_gc_set_dashes ##### -->
<para>
</para>
@gc:
@dash_offset:
@dash_list:
@n:
<!-- ##### FUNCTION gdk_gc_copy ##### -->
<para>
</para>
@dst_gc:
@src_gc:

0
docs/reference/gdk/tmpl/gdk-unused.sgml Normal file
View File

265
docs/reference/gdk/tmpl/general.sgml Normal file
View File

@ -0,0 +1,265 @@
<!-- ##### SECTION Title ##### -->
General
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_init ##### -->
<para>
</para>
@argc:
@argv:
<!-- ##### FUNCTION gdk_init_check ##### -->
<para>
</para>
@argc:
@argv:
@Returns:
<!-- ##### FUNCTION gdk_exit ##### -->
<para>
</para>
@error_code:
<!-- ##### ENUM GdkStatus ##### -->
<para>
</para>
@GDK_OK:
@GDK_ERROR:
@GDK_ERROR_PARAM:
@GDK_ERROR_FILE:
@GDK_ERROR_MEM:
<!-- ##### MACRO GDK_NONE ##### -->
<para>
</para>
<!-- ##### MACRO GDK_CURRENT_TIME ##### -->
<para>
</para>
<!-- ##### MACRO GDK_PRIORITY_EVENTS ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_set_locale ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_get_show_events ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_set_show_events ##### -->
<para>
</para>
@show_events:
<!-- ##### FUNCTION gdk_add_client_message_filter ##### -->
<para>
</para>
@message_type:
@func:
@data:
<!-- ##### FUNCTION gdk_set_sm_client_id ##### -->
<para>
</para>
@sm_client_id:
<!-- ##### FUNCTION gdk_get_use_xshm ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_set_use_xshm ##### -->
<para>
</para>
@use_xshm:
<!-- ##### FUNCTION gdk_get_display ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_screen_width ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_screen_height ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_screen_width_mm ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_screen_height_mm ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_pointer_grab ##### -->
<para>
</para>
@window:
@owner_events:
@event_mask:
@confine_to:
@cursor:
@time:
@Returns:
<!-- ##### FUNCTION gdk_pointer_ungrab ##### -->
<para>
</para>
@time:
<!-- ##### FUNCTION gdk_keyboard_grab ##### -->
<para>
</para>
@window:
@owner_events:
@time:
@Returns:
<!-- ##### FUNCTION gdk_keyboard_ungrab ##### -->
<para>
</para>
@time:
<!-- ##### FUNCTION gdk_pointer_is_grabbed ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_flush ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_beep ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_key_repeat_disable ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_key_repeat_restore ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_error_trap_push ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_error_trap_pop ##### -->
<para>
</para>
@Returns:

107
docs/reference/gdk/tmpl/images.sgml Normal file
View File

@ -0,0 +1,107 @@
<!-- ##### SECTION Title ##### -->
Images
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GdkImage ##### -->
<para>
</para>
@type:
@visual:
@byte_order:
@width:
@height:
@depth:
@bpp:
@bpl:
@mem:
<!-- ##### ENUM GdkImageType ##### -->
<para>
</para>
@GDK_IMAGE_NORMAL:
@GDK_IMAGE_SHARED:
@GDK_IMAGE_FASTEST:
<!-- ##### FUNCTION gdk_image_new_bitmap ##### -->
<para>
</para>
@visual:
@data:
@width:
@height:
@Returns:
<!-- ##### FUNCTION gdk_image_new ##### -->
<para>
</para>
@type:
@visual:
@width:
@height:
@Returns:
<!-- ##### FUNCTION gdk_image_get ##### -->
<para>
</para>
@window:
@x:
@y:
@width:
@height:
@Returns:
<!-- ##### FUNCTION gdk_image_put_pixel ##### -->
<para>
</para>
@image:
@x:
@y:
@pixel:
<!-- ##### FUNCTION gdk_image_get_pixel ##### -->
<para>
</para>
@image:
@x:
@y:
@Returns:
<!-- ##### FUNCTION gdk_image_destroy ##### -->
<para>
</para>
@image:

130
docs/reference/gdk/tmpl/input.sgml Normal file
View File

@ -0,0 +1,130 @@
<!-- ##### 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.

154
docs/reference/gdk/tmpl/input_contexts.sgml Normal file
View File

@ -0,0 +1,154 @@
<!-- ##### SECTION Title ##### -->
Input Contexts
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GdkIC ##### -->
<para>
</para>
<!-- ##### STRUCT GdkICAttr ##### -->
<para>
</para>
@style:
@client_window:
@focus_window:
@filter_events:
@spot_location:
@line_spacing:
@cursor:
@preedit_fontset:
@preedit_area:
@preedit_area_needed:
@preedit_foreground:
@preedit_background:
@preedit_pixmap:
@preedit_colormap:
@status_fontset:
@status_area:
@status_area_needed:
@status_foreground:
@status_background:
@status_pixmap:
@status_colormap:
<!-- ##### ENUM GdkICAttributesType ##### -->
<para>
</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_new ##### -->
<para>
</para>
@attr:
@mask:
@Returns:
<!-- ##### FUNCTION gdk_ic_destroy ##### -->
<para>
</para>
@ic:
<!-- ##### FUNCTION gdk_ic_get_style ##### -->
<para>
</para>
@ic:
@Returns:
<!-- ##### FUNCTION gdk_ic_set_attr ##### -->
<para>
</para>
@ic:
@attr:
@mask:
@Returns:
<!-- ##### FUNCTION gdk_ic_get_attr ##### -->
<para>
</para>
@ic:
@attr:
@mask:
@Returns:
<!-- ##### FUNCTION gdk_ic_get_events ##### -->
<para>
</para>
@ic:
@Returns:
<!-- ##### FUNCTION gdk_ic_attr_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_ic_attr_destroy ##### -->
<para>
</para>
@attr:

198
docs/reference/gdk/tmpl/input_devices.sgml Normal file
View File

@ -0,0 +1,198 @@
<!-- ##### SECTION Title ##### -->
Input Devices
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### MACRO GDK_CORE_POINTER ##### -->
<para>
</para>
<!-- ##### ENUM GdkExtensionMode ##### -->
<para>
</para>
@GDK_EXTENSION_EVENTS_NONE:
@GDK_EXTENSION_EVENTS_ALL:
@GDK_EXTENSION_EVENTS_CURSOR:
<!-- ##### STRUCT GdkDeviceKey ##### -->
<para>
</para>
@keyval:
@modifiers:
<!-- ##### STRUCT GdkDeviceInfo ##### -->
<para>
</para>
@deviceid:
@name:
@source:
@mode:
@has_cursor:
@num_axes:
@axes:
@num_keys:
@keys:
<!-- ##### FUNCTION gdk_input_init ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_input_exit ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_input_list_devices ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_input_set_extension_events ##### -->
<para>
</para>
@window:
@mask:
@mode:
<!-- ##### FUNCTION gdk_input_set_source ##### -->
<para>
</para>
@deviceid:
@source:
<!-- ##### ENUM GdkInputSource ##### -->
<para>
</para>
@GDK_SOURCE_MOUSE:
@GDK_SOURCE_PEN:
@GDK_SOURCE_ERASER:
@GDK_SOURCE_CURSOR:
<!-- ##### FUNCTION gdk_input_set_mode ##### -->
<para>
</para>
@deviceid:
@mode:
@Returns:
<!-- ##### ENUM GdkInputMode ##### -->
<para>
</para>
@GDK_MODE_DISABLED:
@GDK_MODE_SCREEN:
@GDK_MODE_WINDOW:
<!-- ##### FUNCTION gdk_input_set_axes ##### -->
<para>
</para>
@deviceid:
@axes:
<!-- ##### ENUM GdkAxisUse ##### -->
<para>
</para>
@GDK_AXIS_IGNORE:
@GDK_AXIS_X:
@GDK_AXIS_Y:
@GDK_AXIS_PRESSURE:
@GDK_AXIS_XTILT:
@GDK_AXIS_YTILT:
@GDK_AXIS_LAST:
<!-- ##### FUNCTION gdk_input_set_key ##### -->
<para>
</para>
@deviceid:
@index:
@keyval:
@modifiers:
<!-- ##### FUNCTION gdk_input_window_get_pointer ##### -->
<para>
</para>
@window:
@deviceid:
@x:
@y:
@pressure:
@xtilt:
@ytilt:
@mask:
<!-- ##### FUNCTION gdk_input_motion_events ##### -->
<para>
</para>
@window:
@deviceid:
@start:
@stop:
@nevents_return:
@Returns:
<!-- ##### STRUCT GdkTimeCoord ##### -->
<para>
</para>
@time:
@x:
@y:
@pressure:
@xtilt:
@ytilt:

101
docs/reference/gdk/tmpl/input_methods.sgml Normal file
View File

@ -0,0 +1,101 @@
<!-- ##### SECTION Title ##### -->
Input Methods
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GdkIMStyle ##### -->
<para>
</para>
@GDK_IM_PREEDIT_AREA:
@GDK_IM_PREEDIT_CALLBACKS:
@GDK_IM_PREEDIT_POSITION:
@GDK_IM_PREEDIT_NOTHING:
@GDK_IM_PREEDIT_NONE:
@GDK_IM_PREEDIT_MASK:
@GDK_IM_STATUS_AREA:
@GDK_IM_STATUS_CALLBACKS:
@GDK_IM_STATUS_NOTHING:
@GDK_IM_STATUS_NONE:
@GDK_IM_STATUS_MASK:
<!-- ##### TYPEDEF GdkWChar ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_im_ready ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_im_begin ##### -->
<para>
</para>
@ic:
@window:
<!-- ##### FUNCTION gdk_im_end ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_im_decide_style ##### -->
<para>
</para>
@supported_style:
@Returns:
<!-- ##### FUNCTION gdk_im_set_best_style ##### -->
<para>
</para>
@best_allowed_style:
@Returns:
<!-- ##### FUNCTION gdk_wcstombs ##### -->
<para>
</para>
@src:
@Returns:
<!-- ##### FUNCTION gdk_mbstowcs ##### -->
<para>
</para>
@dest:
@src:
@dest_max:
@Returns:

93
docs/reference/gdk/tmpl/keys.sgml Normal file
View File

@ -0,0 +1,93 @@
<!-- ##### 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 &lt;gdk/gdkkeysyms.h&gt;
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 &lt;gdk/gdkkeysyms.h&gt; 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.

196
docs/reference/gdk/tmpl/pixmaps.sgml Normal file
View File

@ -0,0 +1,196 @@
<!-- ##### 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:

152
docs/reference/gdk/tmpl/properties.sgml Normal file
View File

@ -0,0 +1,152 @@
<!-- ##### SECTION Title ##### -->
Properties and Atoms
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### TYPEDEF GdkAtom ##### -->
<para>
</para>
<!-- ##### ENUM GdkPropertyState ##### -->
<para>
</para>
@GDK_PROPERTY_NEW_VALUE:
@GDK_PROPERTY_DELETE:
<!-- ##### ENUM GdkPropMode ##### -->
<para>
</para>
@GDK_PROP_MODE_REPLACE:
@GDK_PROP_MODE_PREPEND:
@GDK_PROP_MODE_APPEND:
<!-- ##### ENUM GdkTarget ##### -->
<para>
</para>
@GDK_TARGET_BITMAP:
@GDK_TARGET_COLORMAP:
@GDK_TARGET_DRAWABLE:
@GDK_TARGET_PIXMAP:
@GDK_TARGET_STRING:
<!-- ##### FUNCTION gdk_text_property_to_text_list ##### -->
<para>
</para>
@encoding:
@format:
@text:
@length:
@list:
@Returns:
<!-- ##### FUNCTION gdk_free_text_list ##### -->
<para>
</para>
@list:
<!-- ##### FUNCTION gdk_string_to_compound_text ##### -->
<para>
</para>
@str:
@encoding:
@format:
@ctext:
@length:
@Returns:
<!-- ##### FUNCTION gdk_free_compound_text ##### -->
<para>
</para>
@ctext:
<!-- ##### FUNCTION gdk_atom_intern ##### -->
<para>
</para>
@atom_name:
@only_if_exists:
@Returns:
<!-- ##### FUNCTION gdk_atom_name ##### -->
<para>
</para>
@atom:
@Returns:
<!-- ##### FUNCTION gdk_property_get ##### -->
<para>
</para>
@window:
@property:
@type:
@offset:
@length:
@pdelete:
@actual_property_type:
@actual_format:
@actual_length:
@data:
@Returns:
<!-- ##### FUNCTION gdk_property_change ##### -->
<para>
</para>
@window:
@property:
@type:
@format:
@mode:
@data:
@nelements:
<!-- ##### FUNCTION gdk_property_delete ##### -->
<para>
</para>
@window:
@property:

217
docs/reference/gdk/tmpl/regions.sgml Normal file
View File

@ -0,0 +1,217 @@
<!-- ##### SECTION Title ##### -->
Points, Rectangles and Regions
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GdkPoint ##### -->
<para>
</para>
@x:
@y:
<!-- ##### STRUCT GdkRectangle ##### -->
<para>
</para>
@x:
@y:
@width:
@height:
<!-- ##### FUNCTION gdk_rectangle_intersect ##### -->
<para>
</para>
@src1:
@src2:
@dest:
@Returns:
<!-- ##### FUNCTION gdk_rectangle_union ##### -->
<para>
</para>
@src1:
@src2:
@dest:
<!-- ##### STRUCT GdkRegion ##### -->
<para>
</para>
@user_data:
<!-- ##### FUNCTION gdk_region_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_region_destroy ##### -->
<para>
</para>
@region:
<!-- ##### FUNCTION gdk_region_get_clipbox ##### -->
<para>
</para>
@region:
@rectangle:
<!-- ##### FUNCTION gdk_region_empty ##### -->
<para>
</para>
@region:
@Returns:
<!-- ##### FUNCTION gdk_region_equal ##### -->
<para>
</para>
@region1:
@region2:
@Returns:
<!-- ##### FUNCTION gdk_region_point_in ##### -->
<para>
</para>
@region:
@x:
@y:
@Returns:
<!-- ##### FUNCTION gdk_region_rect_in ##### -->
<para>
</para>
@region:
@rect:
@Returns:
<!-- ##### ENUM GdkOverlapType ##### -->
<para>
</para>
@GDK_OVERLAP_RECTANGLE_IN:
@GDK_OVERLAP_RECTANGLE_OUT:
@GDK_OVERLAP_RECTANGLE_PART:
<!-- ##### FUNCTION gdk_region_polygon ##### -->
<para>
</para>
@points:
@npoints:
@fill_rule:
@Returns:
<!-- ##### FUNCTION gdk_region_offset ##### -->
<para>
</para>
@region:
@dx:
@dy:
<!-- ##### FUNCTION gdk_region_shrink ##### -->
<para>
</para>
@region:
@dx:
@dy:
<!-- ##### FUNCTION gdk_region_union_with_rect ##### -->
<para>
</para>
@region:
@rect:
@Returns:
<!-- ##### FUNCTION gdk_regions_intersect ##### -->
<para>
</para>
@source1:
@source2:
@Returns:
<!-- ##### FUNCTION gdk_regions_union ##### -->
<para>
</para>
@source1:
@source2:
@Returns:
<!-- ##### FUNCTION gdk_regions_subtract ##### -->
<para>
</para>
@source1:
@source2:
@Returns:
<!-- ##### FUNCTION gdk_regions_xor ##### -->
<para>
</para>
@source1:
@source2:
@Returns:

216
docs/reference/gdk/tmpl/rgb.sgml Normal file
View File

@ -0,0 +1,216 @@
<!-- ##### SECTION Title ##### -->
GdkRGB
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GdkRgbCmap ##### -->
<para>
</para>
@colors:
@lut:
<!-- ##### ENUM GdkRgbDither ##### -->
<para>
</para>
@GDK_RGB_DITHER_NONE:
@GDK_RGB_DITHER_NORMAL:
@GDK_RGB_DITHER_MAX:
<!-- ##### FUNCTION gdk_rgb_init ##### -->
<para>
</para>
<!-- ##### FUNCTION gdk_rgb_cmap_new ##### -->
<para>
</para>
@colors:
@n_colors:
@Returns:
<!-- ##### FUNCTION gdk_rgb_cmap_free ##### -->
<para>
</para>
@cmap:
<!-- ##### FUNCTION gdk_rgb_gc_set_foreground ##### -->
<para>
</para>
@gc:
@rgb:
<!-- ##### FUNCTION gdk_rgb_gc_set_background ##### -->
<para>
</para>
@gc:
@rgb:
<!-- ##### FUNCTION gdk_draw_rgb_image ##### -->
<para>
</para>
@drawable:
@gc:
@x:
@y:
@width:
@height:
@dith:
@rgb_buf:
@rowstride:
<!-- ##### FUNCTION gdk_draw_indexed_image ##### -->
<para>
</para>
@drawable:
@gc:
@x:
@y:
@width:
@height:
@dith:
@buf:
@rowstride:
@cmap:
<!-- ##### FUNCTION gdk_draw_gray_image ##### -->
<para>
</para>
@drawable:
@gc:
@x:
@y:
@width:
@height:
@dith:
@buf:
@rowstride:
<!-- ##### FUNCTION gdk_draw_rgb_32_image ##### -->
<para>
</para>
@drawable:
@gc:
@x:
@y:
@width:
@height:
@dith:
@buf:
@rowstride:
<!-- ##### FUNCTION gdk_draw_rgb_image_dithalign ##### -->
<para>
</para>
@drawable:
@gc:
@x:
@y:
@width:
@height:
@dith:
@rgb_buf:
@rowstride:
@xdith:
@ydith:
<!-- ##### FUNCTION gdk_rgb_xpixel_from_rgb ##### -->
<para>
</para>
@rgb:
@Returns:
<!-- ##### FUNCTION gdk_rgb_set_verbose ##### -->
<para>
</para>
@verbose:
<!-- ##### FUNCTION gdk_rgb_ditherable ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_rgb_set_install ##### -->
<para>
</para>
@install:
<!-- ##### FUNCTION gdk_rgb_set_min_colors ##### -->
<para>
</para>
@min_colors:
<!-- ##### FUNCTION gdk_rgb_get_visual ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gdk_rgb_get_cmap ##### -->
<para>
</para>
@Returns:

94
docs/reference/gdk/tmpl/selections.sgml Normal file
View File

@ -0,0 +1,94 @@
<!-- ##### SECTION Title ##### -->
Selections
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GdkSelection ##### -->
<para>
</para>
@GDK_SELECTION_PRIMARY:
@GDK_SELECTION_SECONDARY:
<!-- ##### ENUM GdkSelectionType ##### -->
<para>
</para>
@GDK_SELECTION_TYPE_ATOM:
@GDK_SELECTION_TYPE_BITMAP:
@GDK_SELECTION_TYPE_COLORMAP:
@GDK_SELECTION_TYPE_DRAWABLE:
@GDK_SELECTION_TYPE_INTEGER:
@GDK_SELECTION_TYPE_PIXMAP:
@GDK_SELECTION_TYPE_WINDOW:
@GDK_SELECTION_TYPE_STRING:
<!-- ##### FUNCTION gdk_selection_owner_set ##### -->
<para>
</para>
@owner:
@selection:
@time:
@send_event:
@Returns:
<!-- ##### FUNCTION gdk_selection_owner_get ##### -->
<para>
</para>
@selection:
@Returns:
<!-- ##### FUNCTION gdk_selection_convert ##### -->
<para>
</para>
@requestor:
@selection:
@target:
@time:
<!-- ##### FUNCTION gdk_selection_property_get ##### -->
<para>
</para>
@requestor:
@data:
@prop_type:
@prop_format:
@Returns:
<!-- ##### FUNCTION gdk_selection_send_notify ##### -->
<para>
</para>
@requestor:
@selection:
@target:
@property:
@time:

50
docs/reference/gdk/tmpl/threads.sgml Normal file
View File

@ -0,0 +1,50 @@
<!-- ##### 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>

391
docs/reference/gdk/tmpl/visuals.sgml Normal file
View File

@ -0,0 +1,391 @@
<!-- ##### 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.

777
docs/reference/gdk/tmpl/windows.sgml Normal file
View File

@ -0,0 +1,777 @@
<!-- ##### 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:
<!-- ##### 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:

59
docs/reference/gtk/Makefile.am Normal file
View File

@ -0,0 +1,59 @@
## 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

13819
docs/reference/gtk/gtk-decl.txt Normal file
View File

File diff suppressed because it is too large Load Diff

297
docs/reference/gtk/gtk-docs.sgml Normal file
View File

@ -0,0 +1,297 @@
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!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-Menu-Factory SYSTEM "sgml/gtkmenufactory.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-Debugging SYSTEM "sgml/gtkdebug.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>
&gtk-General;
&gtk-Feature-Test-Macros;
&gtk-Graphics-Contexts;
&gtk-Styles;
&gtk-Themes;
&gtk-Resource-Files;
&gtk-Keyboard-Accelerators;
&gtk-Selections;
&gtk-Drag-and-Drop;
&gtk-Menu-Factory;
&gtk-Signals;
&gtk-Signal-Marshallers;
&gtk-Object-Properties;
&gtk-Types;
&gtk-Bindings;
&gtk-Standard-Enumerations;
&gtk-Debugging;
&gtk-Private-Information;
</chapter>
<chapter id="gtkobjects">
<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>

19
docs/reference/gtk/gtk-overrides.txt Normal file
View File

@ -0,0 +1,19 @@
# 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>

2955
docs/reference/gtk/gtk-sections.txt Normal file
View File

File diff suppressed because it is too large Load Diff

846
docs/reference/gtk/gtk.args Normal file
View File

@ -0,0 +1,846 @@
<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>

93
docs/reference/gtk/gtk.hierarchy Normal file
View File

@ -0,0 +1,93 @@
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

1097
docs/reference/gtk/gtk.signals Normal file
View File

File diff suppressed because it is too large Load Diff

96
docs/reference/gtk/gtk.types Normal file
View File

@ -0,0 +1,96 @@
#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

130
docs/reference/gtk/objects_grouped.sgml Normal file
View File

@ -0,0 +1,130 @@
<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 &amp; 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="GtkInvisible">GtkInvisible</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 &amp; 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 &amp; 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 &amp; 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>
</literallayout></entry>
</row>
</tbody></tgroup></informaltable>

24
docs/reference/gtk/tmpl/gtk-unused.sgml Normal file
View File

@ -0,0 +1,24 @@
<!-- ##### 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>
<!-- ##### 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>

314
docs/reference/gtk/tmpl/gtkaccelgroup.sgml Normal file
View File

@ -0,0 +1,314 @@
<!-- ##### 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:

69
docs/reference/gtk/tmpl/gtkaccellabel.sgml Normal file
View File

@ -0,0 +1,69 @@
<!-- ##### SECTION Title ##### -->
GtkAccelLabel
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkAccelLabel ##### -->
<para>
</para>
@label:
@queue_id:
@accel_padding:
@accel_widget:
@accel_string:
@accel_string_width:
<!-- ##### FUNCTION gtk_accel_label_new ##### -->
<para>
</para>
@string:
@Returns:
<!-- ##### FUNCTION gtk_accel_label_set_accel_widget ##### -->
<para>
</para>
@accel_label:
@accel_widget:
<!-- ##### FUNCTION gtk_accel_label_get_accel_width ##### -->
<para>
</para>
@accel_label:
@Returns:
<!-- ##### FUNCTION gtk_accel_label_refetch ##### -->
<para>
</para>
@accel_label:
@Returns:
<!-- ##### ARG GtkAccelLabel:accel_widget ##### -->
<para>
</para>

161
docs/reference/gtk/tmpl/gtkadjustment.sgml Normal file
View File

@ -0,0 +1,161 @@
<!-- ##### 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
&quot;value_changed&quot; or &quot;changed&quot; 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>
@data:
@lower:
@upper:
@value:
@step_increment:
@page_increment:
@page_size:
<!-- ##### 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 &quot;changed&quot; 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 &quot;changed&quot; 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 &quot;value_changed&quot; 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.

104
docs/reference/gtk/tmpl/gtkalignment.sgml Normal file
View File

@ -0,0 +1,104 @@
<!-- ##### 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>
@bin:
@xalign:
@yalign:
@xscale:
@yscale:
<!-- ##### 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>

147
docs/reference/gtk/tmpl/gtkarg.sgml Normal file
View File

@ -0,0 +1,147 @@
<!-- ##### SECTION Title ##### -->
Object Properties
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkArgInfo ##### -->
<para>
</para>
@class_type:
@name:
@type:
@arg_flags:
@full_name:
@arg_id:
@seq_id:
<!-- ##### FUNCTION gtk_arg_new ##### -->
<para>
</para>
@arg_type:
@Returns:
<!-- ##### FUNCTION gtk_arg_copy ##### -->
<para>
</para>
@src_arg:
@dest_arg:
@Returns:
<!-- ##### FUNCTION gtk_arg_free ##### -->
<para>
</para>
@arg:
@free_contents:
<!-- ##### FUNCTION gtk_args_collect ##### -->
<para>
</para>
@object_type:
@arg_info_hash_table:
@arg_list_p:
@info_list_p:
@first_arg_name:
@var_args:
@Returns:
<!-- ##### FUNCTION gtk_args_collect_cleanup ##### -->
<para>
</para>
@arg_list:
@info_list:
<!-- ##### FUNCTION gtk_arg_get_info ##### -->
<para>
</para>
@object_type:
@arg_info_hash_table:
@arg_name:
@info_p:
@Returns:
<!-- ##### FUNCTION gtk_arg_type_new_static ##### -->
<para>
</para>
@base_class_type:
@arg_name:
@class_n_args_offset:
@arg_info_hash_table:
@arg_type:
@arg_flags:
@arg_id:
@Returns:
<!-- ##### FUNCTION gtk_args_query ##### -->
<para>
</para>
@class_type:
@arg_info_hash_table:
@arg_flags:
@n_args_p:
@Returns:
<!-- ##### FUNCTION gtk_arg_name_strip_type ##### -->
<para>
</para>
@arg_name:
@Returns:
<!-- ##### FUNCTION gtk_arg_info_equal ##### -->
<para>
</para>
@arg_info_1:
@arg_info_2:
@Returns:
<!-- ##### FUNCTION gtk_arg_info_hash ##### -->
<para>
</para>
@arg_info:
@Returns:

92
docs/reference/gtk/tmpl/gtkarrow.sgml Normal file
View File

@ -0,0 +1,92 @@
<!-- ##### 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>
</informaltable>
</para>
@misc:
@arrow_type:
@shadow_type:
<!-- ##### 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>

71
docs/reference/gtk/tmpl/gtkaspectframe.sgml Normal file
View File

@ -0,0 +1,71 @@
<!-- ##### 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>
@frame:
@xalign:
@yalign:
@ratio:
@obey_child:
@center_allocation:
<!-- ##### FUNCTION gtk_aspect_frame_new ##### -->
<para>
Create a new #GtkAspectFrame.
</para>
@label: Label text.
@xalign: Horizontal lignment of the child within the allocation of
the #GtkAspectFrame. This ranges from 0.0 (left aligned)
to 1.0 (right aligned)
@yalign: Vertical lignment 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 lignment of the child within the allocation of
the #GtkAspectFrame. This ranges from 0.0 (left aligned)
to 1.0 (right aligned)
@yalign: Vertical lignment 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.

159
docs/reference/gtk/tmpl/gtkbbox.sgml Normal file
View File

@ -0,0 +1,159 @@
<!-- ##### SECTION Title ##### -->
GtkButtonBox
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkButtonBox ##### -->
<para>
</para>
@box:
@spacing:
@child_min_width:
@child_min_height:
@child_ipad_x:
@child_ipad_y:
@layout_style:
<!-- ##### MACRO GTK_BUTTONBOX_DEFAULT ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_button_box_get_child_size_default ##### -->
<para>
</para>
@min_width:
@min_height:
<!-- ##### FUNCTION gtk_button_box_get_child_ipadding_default ##### -->
<para>
</para>
@ipad_x:
@ipad_y:
<!-- ##### FUNCTION gtk_button_box_set_child_size_default ##### -->
<para>
</para>
@min_width:
@min_height:
<!-- ##### FUNCTION gtk_button_box_set_child_ipadding_default ##### -->
<para>
</para>
@ipad_x:
@ipad_y:
<!-- ##### FUNCTION gtk_button_box_get_spacing ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_button_box_get_layout ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_button_box_get_child_size ##### -->
<para>
</para>
@widget:
@min_width:
@min_height:
<!-- ##### FUNCTION gtk_button_box_get_child_ipadding ##### -->
<para>
</para>
@widget:
@ipad_x:
@ipad_y:
<!-- ##### FUNCTION gtk_button_box_set_spacing ##### -->
<para>
</para>
@widget:
@spacing:
<!-- ##### FUNCTION gtk_button_box_set_layout ##### -->
<para>
</para>
@widget:
@layout_style:
<!-- ##### FUNCTION gtk_button_box_set_child_size ##### -->
<para>
</para>
@widget:
@min_width:
@min_height:
<!-- ##### FUNCTION gtk_button_box_set_child_ipadding ##### -->
<para>
</para>
@widget:
@ipad_x:
@ipad_y:
<!-- ##### FUNCTION gtk_button_box_child_requisition ##### -->
<para>
</para>
@widget:
@nvis_children:
@width:
@height:

44
docs/reference/gtk/tmpl/gtkbin.sgml Normal file
View File

@ -0,0 +1,44 @@
<!-- ##### 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>
@container:
@child:

243
docs/reference/gtk/tmpl/gtkbindings.sgml Normal file
View File

@ -0,0 +1,243 @@
<!-- ##### 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:

370
docs/reference/gtk/tmpl/gtkbox.sgml Normal file
View File

@ -0,0 +1,370 @@
<!-- ##### 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>
</informaltable>
</para>
@container:
@children:
@spacing:
@homogeneous:
<!-- ##### 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>
</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>

163
docs/reference/gtk/tmpl/gtkbutton.sgml Normal file
View File

@ -0,0 +1,163 @@
<!-- ##### 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>
@bin:
@child:
@in_button:
@button_down:
@relief:
<!-- ##### 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>

260
docs/reference/gtk/tmpl/gtkcalendar.sgml Normal file
View File

@ -0,0 +1,260 @@
<!-- ##### 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>
@widget:
@header_style:
@label_style:
@month:
@year:
@selected_day:
@day_month:
@day:
@num_marked_dates:
@marked_date:
@display_flags:
@marked_date_color:
@gc:
@xor_gc:
@focus_row:
@focus_col:
@highlight_row:
@highlight_col:
@private_data:
@grow_space:
<!-- ##### 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.

60
docs/reference/gtk/tmpl/gtkcheckbutton.sgml Normal file
View File

@ -0,0 +1,60 @@
<!-- ##### 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>
@toggle_button:
<!-- ##### 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.

111
docs/reference/gtk/tmpl/gtkcheckmenuitem.sgml Normal file
View File

@ -0,0 +1,111 @@
<!-- ##### 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>
@menu_item:
@active:
@always_show_toggle:
<!-- ##### 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.

1268
docs/reference/gtk/tmpl/gtkclist.sgml Normal file
View File

File diff suppressed because it is too large Load Diff

93
docs/reference/gtk/tmpl/gtkcolorsel.sgml Normal file
View File

@ -0,0 +1,93 @@
<!-- ##### SECTION Title ##### -->
GtkColorSelection
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkColorSelection ##### -->
<para>
</para>
@vbox:
@wheel_area:
@value_area:
@sample_area:
@sample_area_eb:
@scales:
@entries:
@opacity_label:
@wheel_gc:
@value_gc:
@sample_gc:
@policy:
@use_opacity:
@timer_active:
@timer_tag:
@values:
@old_values:
@wheel_buf:
@value_buf:
@sample_buf:
<!-- ##### FUNCTION gtk_color_selection_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_color_selection_set_update_policy ##### -->
<para>
</para>
@colorsel:
@policy:
<!-- ##### FUNCTION gtk_color_selection_set_opacity ##### -->
<para>
</para>
@colorsel:
@use_opacity:
<!-- ##### FUNCTION gtk_color_selection_set_color ##### -->
<para>
</para>
@colorsel:
@color:
<!-- ##### FUNCTION gtk_color_selection_get_color ##### -->
<para>
</para>
@colorsel:
@color:
<!-- ##### SIGNAL GtkColorSelection::color-changed ##### -->
<para>
</para>
@colorselection: the object which received the signal.

38
docs/reference/gtk/tmpl/gtkcolorseldlg.sgml Normal file
View File

@ -0,0 +1,38 @@
<!-- ##### SECTION Title ##### -->
GtkColorSelectionDialog
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkColorSelectionDialog ##### -->
<para>
</para>
@window:
@colorsel:
@main_vbox:
@ok_button:
@reset_button:
@cancel_button:
@help_button:
<!-- ##### FUNCTION gtk_color_selection_dialog_new ##### -->
<para>
</para>
@title:
@Returns:

109
docs/reference/gtk/tmpl/gtkcombo.sgml Normal file
View File

@ -0,0 +1,109 @@
<!-- ##### SECTION Title ##### -->
GtkCombo
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkCombo ##### -->
<para>
</para>
@hbox:
@entry:
@button:
@popup:
@popwin:
@list:
@entry_change_id:
@list_change_id:
@value_in_list:
@ok_if_empty:
@case_sensitive:
@use_arrows:
@use_arrows_always:
@current_button:
@activate_id:
<!-- ##### FUNCTION gtk_combo_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_combo_set_value_in_list ##### -->
<para>
</para>
@combo:
@val:
@ok_if_empty:
<!-- ##### FUNCTION gtk_combo_set_use_arrows ##### -->
<para>
</para>
@combo:
@val:
<!-- ##### FUNCTION gtk_combo_set_use_arrows_always ##### -->
<para>
</para>
@combo:
@val:
<!-- ##### FUNCTION gtk_combo_set_case_sensitive ##### -->
<para>
</para>
@combo:
@val:
<!-- ##### FUNCTION gtk_combo_set_item_string ##### -->
<para>
</para>
@combo:
@item:
@item_value:
<!-- ##### FUNCTION gtk_combo_set_popdown_strings ##### -->
<para>
</para>
@combo:
@strings:
<!-- ##### FUNCTION gtk_combo_disable_activate ##### -->
<para>
</para>
@combo:

410
docs/reference/gtk/tmpl/gtkcontainer.sgml Normal file
View File

@ -0,0 +1,410 @@
<!-- ##### SECTION Title ##### -->
GtkContainer
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkContainer ##### -->
<para>
</para>
@widget:
@focus_child:
@border_width:
@need_resize:
@resize_mode:
@resize_widgets:
<!-- ##### 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>

1266
docs/reference/gtk/tmpl/gtkctree.sgml Normal file
View File

File diff suppressed because it is too large Load Diff

109
docs/reference/gtk/tmpl/gtkcurve.sgml Normal file
View File

@ -0,0 +1,109 @@
<!-- ##### SECTION Title ##### -->
GtkCurve
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkCurve ##### -->
<para>
</para>
@graph:
@cursor_type:
@min_x:
@max_x:
@min_y:
@max_y:
@pixmap:
@curve_type:
@height:
@grab_point:
@last:
@num_points:
@point:
@num_ctlpoints:
<!-- ##### FUNCTION gtk_curve_new ##### -->
<para>
</para>
@Returns:
<!-- ##### FUNCTION gtk_curve_reset ##### -->
<para>
</para>
@curve:
<!-- ##### FUNCTION gtk_curve_set_gamma ##### -->
<para>
</para>
@curve:
@gamma:
<!-- ##### FUNCTION gtk_curve_set_range ##### -->
<para>
</para>
@curve:
@min_x:
@max_x:
@min_y:
@max_y:
<!-- ##### FUNCTION gtk_curve_get_vector ##### -->
<para>
</para>
@curve:
@veclen:
@vector:
<!-- ##### FUNCTION gtk_curve_set_vector ##### -->
<para>
</para>
@curve:
@veclen:
@vector:
<!-- ##### FUNCTION gtk_curve_set_curve_type ##### -->
<para>
</para>
@curve:
@type:
<!-- ##### SIGNAL GtkCurve::curve-type-changed ##### -->
<para>
</para>
@curve: the object which received the signal.

30
docs/reference/gtk/tmpl/gtkdata.sgml Normal file
View File

@ -0,0 +1,30 @@
<!-- ##### SECTION Title ##### -->
GtkData
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkData ##### -->
<para>
</para>
@object:
<!-- ##### SIGNAL GtkData::disconnect ##### -->
<para>
</para>
@data: the object which received the signal.

42
docs/reference/gtk/tmpl/gtkdebug.sgml Normal file
View File

@ -0,0 +1,42 @@
<!-- ##### 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:

122
docs/reference/gtk/tmpl/gtkdialog.sgml Normal file
View File

@ -0,0 +1,122 @@
<!-- ##### 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>
@window:
@vbox:
@action_area:
<!-- ##### 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.

344
docs/reference/gtk/tmpl/gtkdnd.sgml Normal file
View File

@ -0,0 +1,344 @@
<!-- ##### 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.
<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:

111
docs/reference/gtk/tmpl/gtkdrawingarea.sgml Normal file
View File

@ -0,0 +1,111 @@
<!-- ##### 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],
&amp;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]);
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>
@widget:
@draw_data:
<!-- ##### 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.

448
docs/reference/gtk/tmpl/gtkeditable.sgml Normal file
View File

@ -0,0 +1,448 @@
<!-- ##### 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 &lt;ctype.h&gt;
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&lt;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>
@widget:
@current_pos:
@selection_start_pos:
@selection_end_pos:
@has_selection:
@editable:
@visible:
@ic:
@ic_attr:
@clipboard_text:
<!-- ##### 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>

201
docs/reference/gtk/tmpl/gtkentry.sgml Normal file
View File

@ -0,0 +1,201 @@
<!-- ##### 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>
@editable:
@text_area:
@backing_pixmap:
@cursor:
@text:
@text_size:
@text_length:
@text_max_length:
@scroll_offset:
@visible:
@timer:
@button:
@char_offset:
@text_mb:
@text_mb_dirty:
@use_wchar:
<!-- ##### 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>

361
docs/reference/gtk/tmpl/gtkenums.sgml Normal file
View File

@ -0,0 +1,361 @@
<!-- ##### SECTION Title ##### -->
Standard Enumerations
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### 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>
</para>
@GTK_ARROW_UP:
@GTK_ARROW_DOWN:
@GTK_ARROW_LEFT:
@GTK_ARROW_RIGHT:
<!-- ##### ENUM GtkAttachOptions ##### -->
<para>
</para>
@GTK_EXPAND:
@GTK_SHRINK:
@GTK_FILL:
<!-- ##### ENUM GtkButtonBoxStyle ##### -->
<para>
</para>
@GTK_BUTTONBOX_DEFAULT_STYLE:
@GTK_BUTTONBOX_SPREAD:
@GTK_BUTTONBOX_EDGE:
@GTK_BUTTONBOX_START:
@GTK_BUTTONBOX_END:
<!-- ##### ENUM GtkCornerType ##### -->
<para>
</para>
@GTK_CORNER_TOP_LEFT:
@GTK_CORNER_BOTTOM_LEFT:
@GTK_CORNER_TOP_RIGHT:
@GTK_CORNER_BOTTOM_RIGHT:
<!-- ##### 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>
</para>
@GTK_JUSTIFY_LEFT:
@GTK_JUSTIFY_RIGHT:
@GTK_JUSTIFY_CENTER:
@GTK_JUSTIFY_FILL:
<!-- ##### ENUM GtkMatchType ##### -->
<para>
</para>
@GTK_MATCH_ALL:
@GTK_MATCH_ALL_TAIL:
@GTK_MATCH_HEAD:
@GTK_MATCH_TAIL:
@GTK_MATCH_EXACT:
@GTK_MATCH_LAST:
<!-- ##### ENUM GtkMenuFactoryType ##### -->
<para>
</para>
@GTK_MENU_FACTORY_MENU:
@GTK_MENU_FACTORY_MENU_BAR:
@GTK_MENU_FACTORY_OPTION_MENU:
<!-- ##### ENUM GtkMetricType ##### -->
<para>
</para>
@GTK_PIXELS:
@GTK_INCHES:
@GTK_CENTIMETERS:
<!-- ##### ENUM GtkOrientation ##### -->
<para>
</para>
@GTK_ORIENTATION_HORIZONTAL:
@GTK_ORIENTATION_VERTICAL:
<!-- ##### ENUM GtkPackType ##### -->
<para>
</para>
@GTK_PACK_START:
@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>
</para>
@GTK_POLICY_ALWAYS:
@GTK_POLICY_AUTOMATIC:
@GTK_POLICY_NEVER:
<!-- ##### 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.
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GTK_PREVIEW_COLOR</entry>
<entry>the preview contains red-green-blue data.</entry>
</row>
<row>
<entry>GTK_PREVIEW_GRAYSCALE</entry>
<entry>The preview contains grayscale data.</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@GTK_PREVIEW_COLOR:
@GTK_PREVIEW_GRAYSCALE:
<!-- ##### 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 GtkSignalRunType ##### -->
<para>
</para>
@GTK_RUN_FIRST:
@GTK_RUN_LAST:
@GTK_RUN_BOTH:
@GTK_RUN_NO_RECURSE:
@GTK_RUN_ACTION:
@GTK_RUN_NO_HOOKS:
<!-- ##### 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>
</para>
@GTK_SHADOW_NONE:
@GTK_SHADOW_IN:
@GTK_SHADOW_OUT:
@GTK_SHADOW_ETCHED_IN:
@GTK_SHADOW_ETCHED_OUT:
<!-- ##### ENUM GtkStateType ##### -->
<para>
</para>
@GTK_STATE_NORMAL:
@GTK_STATE_ACTIVE:
@GTK_STATE_PRELIGHT:
@GTK_STATE_SELECTED:
@GTK_STATE_INSENSITIVE:
<!-- ##### ENUM GtkSubmenuDirection ##### -->
<para>
</para>
@GTK_DIRECTION_LEFT:
@GTK_DIRECTION_RIGHT:
<!-- ##### ENUM GtkSubmenuPlacement ##### -->
<para>
</para>
@GTK_TOP_BOTTOM:
@GTK_LEFT_RIGHT:
<!-- ##### ENUM GtkToolbarStyle ##### -->
<para>
</para>
@GTK_TOOLBAR_ICONS:
@GTK_TOOLBAR_TEXT:
@GTK_TOOLBAR_BOTH:
<!-- ##### 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>
</para>
@GTK_WIN_POS_NONE:
@GTK_WIN_POS_CENTER:
@GTK_WIN_POS_MOUSE:
<!-- ##### ENUM GtkWindowType ##### -->
<para>
</para>
@GTK_WINDOW_TOPLEVEL:
@GTK_WINDOW_DIALOG:
@GTK_WINDOW_POPUP:
<!-- ##### ENUM GtkSortType ##### -->
<para>
</para>
@GTK_SORT_ASCENDING:
@GTK_SORT_DESCENDING:

34
docs/reference/gtk/tmpl/gtkeventbox.sgml Normal file
View File

@ -0,0 +1,34 @@
<!-- ##### 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>
@bin:
<!-- ##### FUNCTION gtk_event_box_new ##### -->
<para>
Creates a new #GtkEventBox.
</para>
@Returns: a new #GtkEventBox.

57
docs/reference/gtk/tmpl/gtkfeatures.sgml Normal file
View File

@ -0,0 +1,57 @@
<!-- ##### SECTION Title ##### -->
Feature Test Macros
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### VARIABLE gtk_major_version ##### -->
<para>
</para>
<!-- ##### VARIABLE gtk_minor_version ##### -->
<para>
</para>
<!-- ##### VARIABLE gtk_micro_version ##### -->
<para>
</para>
<!-- ##### VARIABLE gtk_binary_age ##### -->
<para>
</para>
<!-- ##### VARIABLE gtk_interface_age ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_check_version ##### -->
<para>
</para>
@required_major:
@required_minor:
@required_micro:
@Returns:

188
docs/reference/gtk/tmpl/gtkfilesel.sgml Normal file
View File

@ -0,0 +1,188 @@
<!-- ##### 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>
@window:
@dir_list:
@file_list:
@selection_entry:
@selection_text:
@main_vbox:
@ok_button:
@cancel_button:
@help_button:
@history_pulldown:
@history_menu:
@history_list:
@fileop_dialog:
@fileop_entry:
@fileop_file:
@cmpl_state:
@fileop_c_dir:
@fileop_del_file:
@fileop_ren_file:
@button_area:
@action_area:
<!-- ##### 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.

104
docs/reference/gtk/tmpl/gtkfixed.sgml Normal file
View File

@ -0,0 +1,104 @@
<!-- ##### 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>
@container:
@children:
<!-- ##### 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.

165
docs/reference/gtk/tmpl/gtkfontsel.sgml Normal file
View File

@ -0,0 +1,165 @@
<!-- ##### 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>
@notebook:
@main_vbox:
@font_label:
@font_entry:
@font_clist:
@font_style_entry:
@font_style_clist:
@size_entry:
@size_clist:
@pixels_button:
@points_button:
@filter_button:
@preview_entry:
@message_label:
@info_vbox:
@info_clist:
@requested_font_name:
@actual_font_name:
@filter_vbox:
@type_bitmaps_button:
@type_scalable_button:
@type_scaled_bitmaps_button:
@filter_clists:
@font:
@font_index:
@style:
@metric:
@size:
@selected_size:
@property_values:
@filters:
<!-- ##### 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.

229
docs/reference/gtk/tmpl/gtkfontseldlg.sgml Normal file
View File

@ -0,0 +1,229 @@
<!-- ##### 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>
@window:
@fontsel:
@main_vbox:
@action_area:
@ok_button:
@apply_button:
@cancel_button:
@dialog_width:
@auto_resize:
<!-- ##### 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().
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GTK_FONT_BITMAP</entry>
<entry>bitmap fonts.</entry>
</row>
<row>
<entry>GTK_FONT_SCALABLE</entry>
<entry>scalable fonts.</entry>
</row>
<row>
<entry>GTK_FONT_SCALED_BITMAP</entry>
<entry>scaled bitmap fonts.</entry>
</row>
<row>
<entry>GTK_FONT_ALL</entry>
<entry>a bitwise combination of all of the above.</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@GTK_FONT_BITMAP:
@GTK_FONT_SCALABLE:
@GTK_FONT_SCALABLE_BITMAP:
@GTK_FONT_ALL:
<!-- ##### 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().
<informaltable pgwide=1 frame="none" role="enum">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GTK_FONT_FILTER_BASE</entry>
<entry>the base filter, which can't be changed by the user.</entry>
</row>
<row>
<entry>GTK_FONT_FILTER_USER</entry>
<entry>the user filter, which can be changed from within the 'Filter' page
of the #GtkFontSelection widget.</entry>
</row>
</tbody></tgroup></informaltable>
</para>
@GTK_FONT_FILTER_BASE:
@GTK_FONT_FILTER_USER:

96
docs/reference/gtk/tmpl/gtkframe.sgml Normal file
View File

@ -0,0 +1,96 @@
<!-- ##### 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>
@bin:
@label:
@shadow_type:
@label_width:
@label_height:
@label_xalign:
@label_yalign:
<!-- ##### 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>

37
docs/reference/gtk/tmpl/gtkgamma.sgml Normal file
View File

@ -0,0 +1,37 @@
<!-- ##### SECTION Title ##### -->
GtkGammaCurve
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkGammaCurve ##### -->
<para>
</para>
@vbox:
@table:
@curve:
@button:
@gamma:
@gamma_dialog:
@gamma_text:
<!-- ##### FUNCTION gtk_gamma_curve_new ##### -->
<para>
</para>
@Returns:

36
docs/reference/gtk/tmpl/gtkgc.sgml Normal file
View File

@ -0,0 +1,36 @@
<!-- ##### SECTION Title ##### -->
Graphics Contexts
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_gc_get ##### -->
<para>
</para>
@depth:
@colormap:
@values:
@values_mask:
@Returns:
<!-- ##### FUNCTION gtk_gc_release ##### -->
<para>
</para>
@gc:

170
docs/reference/gtk/tmpl/gtkhandlebox.sgml Normal file
View File

@ -0,0 +1,170 @@
<!-- ##### 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.
<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>
@bin:
@bin_window:
@float_window:
@shadow_type:
@handle_position:
@float_window_mapped:
@child_detached:
@in_drag:
@shrink_on_detach:
@snap_edge:
@deskoff_x:
@deskoff_y:
@attach_allocation:
@float_allocation:
<!-- ##### 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>

99
docs/reference/gtk/tmpl/gtkhbbox.sgml Normal file
View File

@ -0,0 +1,99 @@
<!-- ##### 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>
@button_box:
<!-- ##### 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.

47
docs/reference/gtk/tmpl/gtkhbox.sgml Normal file
View File

@ -0,0 +1,47 @@
<!-- ##### 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 ##### -->
@box:
<!-- ##### 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.

33
docs/reference/gtk/tmpl/gtkhpaned.sgml Normal file
View File

@ -0,0 +1,33 @@
<!-- ##### SECTION Title ##### -->
GtkHPaned
<!-- ##### SECTION Short_Description ##### -->
A container with two panes arranged horizontally.
<!-- ##### SECTION Long_Description ##### -->
<para>
The HPaned widget is a container widget with two
children arranged horizontally. The division between
the two panes is adjustable by the user by dragging
a handle. See #GtkPaned for details.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkHPaned ##### -->
<para>
</para>
@paned:
<!-- ##### FUNCTION gtk_hpaned_new ##### -->
<para>
Create a new #GtkHPaned
</para>
@Returns: the new #GtkHPaned

38
docs/reference/gtk/tmpl/gtkhruler.sgml Normal file
View File

@ -0,0 +1,38 @@
<!-- ##### SECTION Title ##### -->
GtkHRuler
<!-- ##### SECTION Short_Description ##### -->
A horizontal ruler.
<!-- ##### SECTION Long_Description ##### -->
<para>
The HRuler widget is a widget arranged horizontally creating a ruler that is
utilized around other widgets such as a text widget. The ruler is used to show
the location of the mouse on the window and to show the size of the window in
specified units. The available units of measurement are GTK_PIXELS, GTK_INCHES
and GTK_CENTIMETERS. GTK_PIXELS is the default.
rulers.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkHRuler ##### -->
<para>
The #GtkHRuler struct contains private data and should be accessed
with the functions below.
</para>
@ruler:
<!-- ##### FUNCTION gtk_hruler_new ##### -->
<para>
Creates a new horizontal ruler.
</para>
@Returns: the new GTKHRuler.

45
docs/reference/gtk/tmpl/gtkhscale.sgml Normal file
View File

@ -0,0 +1,45 @@
<!-- ##### SECTION Title ##### -->
GtkHScale
<!-- ##### SECTION Short_Description ##### -->
a horizontal slider widget for selecting a value from a range.
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkHScale widget is used to allow the user to select a value using
a horizontal slider.
A #GtkAdjustment is used to set the initial value, the lower
and upper bounds, and the step and page increments.
</para>
<para>
The position to show the current value, and the number of decimal places
shown can be set using the parent #GtkScale class's functions.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkHScale ##### -->
<para>
The #GtkHScale-struct struct contains private data only, and
should be accessed using the functions below.
</para>
@scale:
<!-- ##### FUNCTION gtk_hscale_new ##### -->
<para>
Creates a new #GtkHScale.
</para>
@adjustment: the #GtkAdjustment which sets the range of the scale.
@Returns: a new #GtkHScale.
<!-- ##### ARG GtkHScale:adjustment ##### -->
<para>
the #GtkAdjustment which sets the range of the scale.
</para>

42
docs/reference/gtk/tmpl/gtkhscrollbar.sgml Normal file
View File

@ -0,0 +1,42 @@
<!-- ##### SECTION Title ##### -->
GtkHScrollbar
<!-- ##### SECTION Short_Description ##### -->
A horizontal scrollbar
<!-- ##### SECTION Long_Description ##### -->
<para>
The HScrollbar widget is a widget arranged horizontally creating a scroll
bar. See #GtkScrollbar for details on scrollbars. #GtkAdjustment pointers may be
added to handle the adjustment of the scrollbars or it may be left NULL in which
case one will be created you. See #GtkAdjustment for details.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkHScrollbar ##### -->
<para>
The #GtkHScrollbar struct contains private data and should be accessed
unsing the functions below.
</para>
@scrollbar:
<!-- ##### FUNCTION gtk_hscrollbar_new ##### -->
<para>
Creates a new horizontal scrollbar.
</para>
@adjustment:
@Returns: the new GTKHScrollbar
<!-- ##### ARG GtkHScrollbar:adjustment ##### -->
<para>
</para>

31
docs/reference/gtk/tmpl/gtkhseparator.sgml Normal file
View File

@ -0,0 +1,31 @@
<!-- ##### SECTION Title ##### -->
GtkHSeparator
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkHSeparator ##### -->
<para>
</para>
@separator:
<!-- ##### FUNCTION gtk_hseparator_new ##### -->
<para>
</para>
@Returns:

55
docs/reference/gtk/tmpl/gtkimage.sgml Normal file
View File

@ -0,0 +1,55 @@
<!-- ##### SECTION Title ##### -->
GtkImage
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkImage ##### -->
<para>
</para>
@misc:
@image:
@mask:
<!-- ##### FUNCTION gtk_image_new ##### -->
<para>
</para>
@val:
@mask:
@Returns:
<!-- ##### FUNCTION gtk_image_set ##### -->
<para>
</para>
@image:
@val:
@mask:
<!-- ##### FUNCTION gtk_image_get ##### -->
<para>
</para>
@image:
@val:
@mask:

73
docs/reference/gtk/tmpl/gtkinputdialog.sgml Normal file
View File

@ -0,0 +1,73 @@
<!-- ##### SECTION Title ##### -->
GtkInputDialog
<!-- ##### SECTION Short_Description ##### -->
Configure devices for the XInput extension.
<!-- ##### SECTION Long_Description ##### -->
<para>
#GtkInputDialog displays a dialog which allows the user
to configure XInput extension devices. For each
device, they can control the mode of the device
(disabled, screen-relative, or window-relative),
the mapping of axes to coordinates, and the
mapping of the devices macro keys to key press
events.
</para>
<para>
#GtkInputDialog contains two buttons to which
the application can connect; one for closing
the dialog, and one for saving the changes.
No actions are bound to these by default.
The changes that the user makes take effect
immediately.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkInputDialog ##### -->
<para>
</para>
@dialog:
@axis_list:
@axis_listbox:
@mode_optionmenu:
@close_button:
@save_button:
@axis_items:
@current_device:
@keys_list:
@keys_listbox:
<!-- ##### FUNCTION gtk_input_dialog_new ##### -->
<para>
Creates a new #GtkInputDialog.
</para>
@Returns: the new #GtkInputDialog.
<!-- ##### SIGNAL GtkInputDialog::enable-device ##### -->
<para>
This signal is emitted when the user changes the
mode of a device from #GDK_MODE_DISABLED to a
#GDK_MODE_SCREEN or #GDK_MODE_WINDOW.
</para>
@inputdialog: the object which received the signal.
@deviceid: The ID of the newly enabled device.
<!-- ##### SIGNAL GtkInputDialog::disable-device ##### -->
<para>
This signal is emitted when the user changes the
mode of a device from a #GDK_MODE_SCREEN or #GDK_MODE_WINDOW
to #GDK_MODE_ENABLED.
</para>
@inputdialog: the object which received the signal.
@deviceid: The ID of the newly disabled device.

31
docs/reference/gtk/tmpl/gtkinvisible.sgml Normal file
View File

@ -0,0 +1,31 @@
<!-- ##### SECTION Title ##### -->
GtkInvisible
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkInvisible ##### -->
<para>
</para>
@bin:
<!-- ##### FUNCTION gtk_invisible_new ##### -->
<para>
</para>
@Returns:

68
docs/reference/gtk/tmpl/gtkitem.sgml Normal file
View File

@ -0,0 +1,68 @@
<!-- ##### SECTION Title ##### -->
GtkItem
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkItem ##### -->
<para>
</para>
@bin:
<!-- ##### FUNCTION gtk_item_select ##### -->
<para>
</para>
@item:
<!-- ##### FUNCTION gtk_item_deselect ##### -->
<para>
</para>
@item:
<!-- ##### FUNCTION gtk_item_toggle ##### -->
<para>
</para>
@item:
<!-- ##### SIGNAL GtkItem::select ##### -->
<para>
</para>
@item: the object which received the signal.
<!-- ##### SIGNAL GtkItem::deselect ##### -->
<para>
</para>
@item: the object which received the signal.
<!-- ##### SIGNAL GtkItem::toggle ##### -->
<para>
</para>
@item: the object which received the signal.

358
docs/reference/gtk/tmpl/gtkitemfactory.sgml Normal file
View File

@ -0,0 +1,358 @@
<!-- ##### SECTION Title ##### -->
GtkItemFactory
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkItemFactory ##### -->
<para>
</para>
@object:
@path:
@accel_group:
@widget:
@items:
@translate_func:
@translate_data:
@translate_notify:
<!-- ##### USER_FUNCTION GtkPrintFunc ##### -->
<para>
</para>
@func_data:
@str:
<!-- ##### USER_FUNCTION GtkTranslateFunc ##### -->
<para>
</para>
@path:
@func_data:
@Returns:
<!-- ##### USER_FUNCTION GtkItemFactoryCallback ##### -->
<para>
</para>
<!-- ##### USER_FUNCTION GtkItemFactoryCallback1 ##### -->
<para>
</para>
@callback_data:
@callback_action:
@widget:
<!-- ##### USER_FUNCTION GtkItemFactoryCallback2 ##### -->
<para>
</para>
@widget:
@callback_data:
@callback_action:
<!-- ##### STRUCT GtkItemFactoryEntry ##### -->
<para>
</para>
@path:
@accelerator:
@callback:
@callback_action:
@item_type:
<!-- ##### STRUCT GtkItemFactoryItem ##### -->
<para>
</para>
@path:
@accelerator_key:
@accelerator_mods:
@modified:
@in_propagation:
@dummy:
@widgets:
<!-- ##### FUNCTION gtk_item_factory_new ##### -->
<para>
</para>
@container_type:
@path:
@accel_group:
@Returns:
<!-- ##### FUNCTION gtk_item_factory_construct ##### -->
<para>
</para>
@ifactory:
@container_type:
@path:
@accel_group:
<!-- ##### FUNCTION gtk_item_factory_parse_rc ##### -->
<para>
</para>
@file_name:
<!-- ##### FUNCTION gtk_item_factory_parse_rc_string ##### -->
<para>
</para>
@rc_string:
<!-- ##### FUNCTION gtk_item_factory_parse_rc_scanner ##### -->
<para>
</para>
@scanner:
<!-- ##### FUNCTION gtk_item_factory_from_widget ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_item_factory_path_from_widget ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_item_factory_get_widget ##### -->
<para>
</para>
@ifactory:
@path:
@Returns:
<!-- ##### FUNCTION gtk_item_factory_get_widget_by_action ##### -->
<para>
</para>
@ifactory:
@action:
@Returns:
<!-- ##### FUNCTION gtk_item_factory_dump_items ##### -->
<para>
</para>
@path_pspec:
@modified_only:
@print_func:
@func_data:
<!-- ##### FUNCTION gtk_item_factory_dump_rc ##### -->
<para>
</para>
@file_name:
@path_pspec:
@modified_only:
<!-- ##### FUNCTION gtk_item_factory_print_func ##### -->
<para>
</para>
@FILE_pointer:
@string:
<!-- ##### FUNCTION gtk_item_factory_create_item ##### -->
<para>
</para>
@ifactory:
@entry:
@callback_data:
@callback_type:
<!-- ##### FUNCTION gtk_item_factory_create_items ##### -->
<para>
</para>
@ifactory:
@n_entries:
@entries:
@callback_data:
<!-- ##### FUNCTION gtk_item_factory_create_items_ac ##### -->
<para>
</para>
@ifactory:
@n_entries:
@entries:
@callback_data:
@callback_type:
<!-- ##### FUNCTION gtk_item_factory_delete_item ##### -->
<para>
</para>
@ifactory:
@path:
<!-- ##### FUNCTION gtk_item_factory_delete_entry ##### -->
<para>
</para>
@ifactory:
@entry:
<!-- ##### FUNCTION gtk_item_factory_delete_entries ##### -->
<para>
</para>
@ifactory:
@n_entries:
@entries:
<!-- ##### FUNCTION gtk_item_factory_popup ##### -->
<para>
</para>
@ifactory:
@x:
@y:
@mouse_button:
@time:
<!-- ##### FUNCTION gtk_item_factory_popup_with_data ##### -->
<para>
</para>
@ifactory:
@popup_data:
@destroy:
@x:
@y:
@mouse_button:
@time:
<!-- ##### FUNCTION gtk_item_factory_popup_data ##### -->
<para>
</para>
@ifactory:
@Returns:
<!-- ##### FUNCTION gtk_item_factory_popup_data_from_widget ##### -->
<para>
</para>
@widget:
@Returns:
<!-- ##### FUNCTION gtk_item_factory_from_path ##### -->
<para>
</para>
@path:
@Returns:
<!-- ##### FUNCTION gtk_item_factory_create_menu_entries ##### -->
<para>
</para>
@n_entries:
@entries:
<!-- ##### FUNCTION gtk_item_factories_path_delete ##### -->
<para>
</para>
@ifactory_path:
@path:
<!-- ##### FUNCTION gtk_item_factory_set_translate_func ##### -->
<para>
</para>
@ifactory:
@func:
@data:
@notify:

146
docs/reference/gtk/tmpl/gtklabel.sgml Normal file
View File

@ -0,0 +1,146 @@
<!-- ##### SECTION Title ##### -->
GtkLabel
<!-- ##### SECTION Short_Description ##### -->
A widget that displays a small to medium amount of text.
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkLabel widget is usually used directly by the programmer to display
word(s) describing an adjacent widget or its use. It is also used internally
by Gtk+ as #GtkButton labels, #GtkMenu items, and many other widgets which
use text.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkLabel ##### -->
<para>
This should not be accessed directly. Use the accessor functions as
described below.
</para>
@misc:
@label:
@label_wc:
@pattern:
@words:
@max_width:
@jtype:
@wrap:
<!-- ##### STRUCT GtkLabelWord ##### -->
<para>
Internal to #GtkLabel.
</para>
<!-- ##### FUNCTION gtk_label_new ##### -->
<para>
Creates a new label with the given string of text inside it. You can
pass NULL to get an empty label widget.
</para>
@str: The string you want to display in the #GtkLabel
@Returns: The newly allocated #GtkLabel widget
<!-- ##### MACRO gtk_label_set ##### -->
<para>
Aliases gtk_label_set_text. Probably used for backward compatibility with
Gtk+ 1.0.x.
</para>
<!-- ##### FUNCTION gtk_label_set_pattern ##### -->
<para>
The pattern of underlines you want under the existing text within the
#GtkLabel widget. For example if the current text of the label says
&quot;FooBarBaz&quot; passing a pattern of &quot;___ ___&quot; will underline
&quot;Foo&quot; and &quot;Baz&quot; but not &quot;Bar&quot;.
</para>
@label: The #GtkLabel you want to set the pattern to.
@pattern: The pattern as described above.
<!-- ##### FUNCTION gtk_label_set_justify ##### -->
<para>
Set where the text within the #GtkLabel will align to. This can be one of
four values: GTK_JUSTIFY_LEFT, GTK_JUSTIFY_RIGHT, GTK_JUSTIFY_CENTER,
and GTK_JUSTIFY_FILL. GTK_JUSTIFY_CENTER is the default value when the
widget is first created with gtk_label_new().
</para>
@label: The #GtkLabel widget you want to set justification for.
@jtype: The #GtkJustification type as described above.
<!-- ##### FUNCTION gtk_label_get ##### -->
<para>
Gets the current string of text within the #GtkLabel and writes it to
the given str argument. It does not make a copy of this string so you
must not write to it.
</para>
@label: The #GtkLabel widget you want to get the text from.
@str: The reference to the pointer you want to point to the text.
<!-- ##### FUNCTION gtk_label_parse_uline ##### -->
<para>
Parses the given string for underscores and converts the next
character to an underlined character. The last character that
was underlined will have its lower-cased accelerator keyval returned (i.e.
&quot;_File&quot; would return the keyval for &quot;f&quot;. This is
probably only used within the Gtk+ library itself for menu items and such.
</para>
@label: The #GtkLabel you want to affect.
@string: The string you want to parse for underlines.
@Returns: The lowercase keyval of the last character underlined.
<!-- ##### FUNCTION gtk_label_set_line_wrap ##### -->
<para>
Toggles line wrapping within the #GtkLabel widget. TRUE makes it break
lines if text exceeds the widget's size. FALSE lets the text get cut off
by the edge of the widget if it exceeds the widget size.
</para>
@label: The #GtkLabel you want to set line wrapping for.
@wrap: TRUE turns it on; FALSE turns it off.
<!-- ##### FUNCTION gtk_label_set_text ##### -->
<para>
Sets the text within the #GtkLabel widget. It overwrites any text that
was there before. Note that underlines that were there before do not
get overwritten. If you want to erase underlines just send NULL to
gtk_label_set_pattern().
</para>
@label: The #GtkLabel you want to set the text for.
@str: The text you want to add.
<!-- ##### ARG GtkLabel:label ##### -->
<para>
The actual label text. Do not write to this pointer, it is not copied.
</para>
<!-- ##### ARG GtkLabel:pattern ##### -->
<para>
The pattern of underlines under the existing text. Do not change the
pointer, it isn't copied.
</para>
<!-- ##### ARG GtkLabel:justify ##### -->
<para>
The #GtkJustification setting. See gtk_label_set_justify() for more info.
</para>

130
docs/reference/gtk/tmpl/gtklayout.sgml Normal file
View File

@ -0,0 +1,130 @@
<!-- ##### SECTION Title ##### -->
GtkLayout
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GtkLayout ##### -->
<para>
</para>
@container:
@children:
@width:
@height:
@xoffset:
@yoffset:
@hadjustment:
@vadjustment:
@bin_window:
@visibility:
@configure_serial:
@scroll_x:
@scroll_y:
@freeze_count:
<!-- ##### FUNCTION gtk_layout_new ##### -->
<para>
</para>
@hadjustment:
@vadjustment:
@Returns:
<!-- ##### FUNCTION gtk_layout_put ##### -->
<para>
</para>
@layout:
@widget:
@x:
@y:
<!-- ##### FUNCTION gtk_layout_move ##### -->
<para>
</para>
@layout:
@widget:
@x:
@y:
<!-- ##### FUNCTION gtk_layout_set_size ##### -->
<para>
</para>
@layout:
@width:
@height:
<!-- ##### FUNCTION gtk_layout_freeze ##### -->
<para>
</para>
@layout:
<!-- ##### FUNCTION gtk_layout_thaw ##### -->
<para>
</para>
@layout:
<!-- ##### FUNCTION gtk_layout_get_hadjustment ##### -->
<para>
</para>
@layout:
@Returns:
<!-- ##### FUNCTION gtk_layout_get_vadjustment ##### -->
<para>
</para>
@layout:
@Returns:
<!-- ##### FUNCTION gtk_layout_set_hadjustment ##### -->
<para>
</para>
@layout:
@adjustment:
<!-- ##### FUNCTION gtk_layout_set_vadjustment ##### -->
<para>
</para>
@layout:
@adjustment:

Some files were not shown because too many files have changed in this diff Show More