source: trunk/third/gtk/docs/gtk.info-2 @ 14810

Revision 14810, 49.0 KB checked in by ghudson, 25 years ago (diff)
This commit was generated by cvs2svn to compensate for changes in r14809, which included commits to RCS files with non-trunk default branches.
Line 
1This is gtk.info, produced by makeinfo version 4.0 from gtk.texi.
2
3   This file documents GTK, the GIMP Toolkit
4
5   Copyright (C) 1996 Peter Mattis Copyright (C) 1997 Peter Mattis
6
7   Permission is granted to make and distribute verbatim copies of this
8manual provided the copyright notice and this permission notice are
9preserved on all copies
10
11   Permission is granted to copy and distribute modified versions of
12this manual under the conditions for verbatim copying, provided that the
13entire resulting derived work is distributed under the terms of a
14permission notice identical to this one.
15
16   Permission is granted to copy and distribute translations of this
17manual into another language, under the above conditions for modified
18versions, except that this permission notice may be stated in a
19translation approved by Peter Mattis.
20
21INFO-DIR-SECTION User Interface Toolkit
22START-INFO-DIR-ENTRY
23* GTK: (gtk).           The GIMP Toolkit
24END-INFO-DIR-ENTRY
25
26
27File: gtk.info,  Node: GtkAlignment,  Next: GtkArrow,  Prev: Widgets,  Up: Widgets
28
29The alignment widget
30====================
31
32Description
33-----------
34
35   The alignment widget is a container (*note GtkContainer::) derived
36from the bin widget (*note GtkBin::). Its entire purpose is to give the
37programmer flexibility in how the child it manages is positioned when a
38window is resized.
39
40   Normally, a widget is allocated at least as much size as it
41requests. (*note GtkContainer:: for a discussion of geometry
42management). When a widget is allocated more size than it requests there
43is a question of how the widget should expand. By convention, most GTK
44widgets expand to fill their allocated space. Sometimes this behavior is
45not desired. The alignment widget allows the programmer to specify how a
46widget should expand and position itself to fill the area it is
47allocated.
48
49Options
50-------
51
52 - User Option: xscale
53 - User Option: yscale
54     The XSCALE and YSCALE options specify how to scale the child
55     widget. If the scale value is 0.0, the child widget is allocated
56     exactly the size it requested in that dimension. If the scale
57     value is 1.0, the child widget is allocated all of the space in a
58     dimension. A scale value of 1.0 for both x and y is equivalent to
59     not using an alignment widget.
60
61 - User Option: xalign
62 - User Option: yalign
63     The XALIGN and YALIGN options specify how to position the child
64     widget when it is not allocated all the space available to it
65     (because the XSCALE and/or YSCALE options are less than 1.0). If
66     an alignment value is 0.0 the widget is positioned to the left (or
67     top) of its allocated space. An alignment value of 1.0 positions
68     the widget to the right (or bottom) of its allocated space. A
69     common usage is to specify XALIGN and YALIGN to be 0.5 which
70     causes the widget to be centered within its allocated area.
71
72Signals
73-------
74
75Functions
76---------
77
78 - Function: guint gtk_alignment_get_type (void)
79     Returns the `GtkAlignment' type identifier.
80
81 - Function: GtkWidget* gtk_alignment_new (gfloat XALIGN, gfloat
82          YALIGN, gfloat XSCALE, gfloat YSCALE)
83     Create a new `GtkAlignment' object and initialize it with the
84     values XALIGN, YALIGN, XSCALE and YSCALE. The new widget is
85     returned as a pointer to a `GtkWidget' object. `NULL' is returned
86     on failure.
87
88 - Function: void gtk_alignment_set (GtkAlignment *ALIGNMENT, gfloat
89          XALIGN, gfloat YALIGN, gfloat XSCALE, gfloat YSCALE)
90     Set the XALIGN, YALIGN, XSCALE and YSCALE options of an alignment
91     widget. It is important to not set the fields of the
92     `GtkAlignment' structure directly (or, for that matter, any type
93     derived from `GtkObject').
94
95 - Function: GtkAlignment* GTK_ALIGNMENT (gpointer OBJ)
96     Cast a generic pointer to `GtkAlignment*'. *Note Standard
97     Macros::, for more info.
98
99 - Function: GtkAlignmentClass* GTK_ALIGNMENT_CLASS (gpointer CLASS)
100     Cast a generic pointer to `GtkAlignmentClass*'. *Note Standard
101     Macros::, for more info.
102
103 - Function: gint GTK_IS_ALIGNMENT (gpointer OBJ)
104     Determine if a generic pointer refers to a `GtkAlignment' object.
105     *Note Standard Macros::, for more info.
106
107
108File: gtk.info,  Node: GtkArrow,  Next: GtkAspectFrame,  Prev: GtkAlignment,  Up: Widgets
109
110The arrow widget
111================
112
113Description
114-----------
115
116   The arrow widget is derived from the misc widget (*note GtkMisc::)
117and is intended for use where a directional arrow (in one of the four
118cardinal directions) is desired. As such, it has very limited
119functionality and basically only draws itself in a particular direction
120and with a particular shadow type. The arrow widget will expand to fill
121all the space it is allocated.
122
123Options
124-------
125
126 - User Option: arrow_type
127     The ARROW_TYPE option specifies which direction the arrow will
128     point. It can be one of `GTK_ARROW_UP', `GTK_ARROW_DOWN',
129     `GTK_ARROW_LEFT' or `GTK_ARROW_RIGHT'. This will set the arrow
130     pointing in the direction specified.
131
132 - User Option: shadow_type
133     The SHADOW_TYPE option specifies how to draw the shadow for the
134     arrow. Currently, only the `GTK_SHADOW_IN' and `GTK_SHADOW_OUT'
135     shadow types are supported for drawing arrows. Other shadow types
136     will cause nothing to be drawn.
137
138Signals
139-------
140
141Functions
142---------
143
144 - Function: guint gtk_arrow_get_type (void)
145     Returns the `GtkArrow' type identifier.
146
147 - Function: GtkWidget* gtk_arrow_new (GtkArrowType ARROW_TYPE,
148          GtkShadowType SHADOW_TYPE)
149     Create a new `GtkArrow' object and initialize it with the values
150     ARROW_TYPE and SHADOW_TYPE. The new widget is returned as a
151     pointer to a `GtkWidget' object. `NULL' is returned on failure.
152
153 - Function: void gtk_arrow_set (GtkArrow *ARROW, GtkArrowType
154          ARROW_TYPE, GtkShadowType SHADOW_TYPE)
155     Set the ARROW_TYPE and SHADOW_TYPE options of an arrow widget. It
156     is important to not set the fields of the `GtkArrow' structure
157     directly (or, for that matter, any type derived from `GtkObject').
158
159 - Function: GtkArrow* GTK_ARROW (gpointer OBJ)
160     Cast a generic pointer to `GtkArrow*'. *Note Standard Macros::, for
161     more info.
162
163 - Function: GtkArrowClass* GTK_ARROW_CLASS (gpointer CLASS)
164     Cast a generic pointer to `GtkArrowClass*'. *Note Standard
165     Macros::, for more info.
166
167 - Function: gint GTK_IS_ARROW (gpointer OBJ)
168     Determine if a generic pointer refers to a `GtkArrow' object.
169     *Note Standard Macros::, for more info.
170
171
172File: gtk.info,  Node: GtkAspectFrame,  Next: GtkBin,  Prev: GtkArrow,  Up: Widgets
173
174The aspect frame widget
175=======================
176
177Description
178-----------
179
180   Ensure that the child window has a specified aspect ratio or, if
181obey_child, has the same aspect ratio as its requested size.  Derived
182from *note GtkFrame::).
183
184Options
185-------
186
187 - User Option: label
188
189 - User Option: xalign
190
191 - User Option: yalign
192
193 - User Option: ratio
194
195 - User Option: obey_child
196
197Signals
198-------
199
200Functions
201---------
202
203 - Function: guint gtk_aspect_frame_get_type (void)
204     Returns the `GtkAspectFrame' type identifier.
205
206 - Function: GtkWidget* gtk_aspect_frame_new (gchar *LABEL, gfloat
207          XALIGN, gfloat YALIGN, gfloat RATIO, gint OBEY_CHILD)
208     Create a new `GtkAspectFrame' object and initialize it with the
209     values LABEL, XALIGN, YALIGN, RATIO and OBEY_CHILD.  The new
210     widget is returned as a pointer to a `GtkWidget' object.  `NULL'
211     is returned on failure.
212
213 - Function: void gtk_aspect_frame_set (GtkAspectFrame *ASPECT_FRAME,
214          gfloat XALIGN, gfloat YALIGN, gfloat RATIO, gint OBEY_CHILD)
215
216 - Function: GtkAspectFrame* GTK_ASPECT_FRAME (gpointer OBJ)
217     Cast a generic pointer to `GtkAspectFrame*'. *Note Standard
218     Macros::, for more info.
219
220 - Function: GtkAspectFrameClass* GTK_ASPECT_FRAME_CLASS (gpointer
221          CLASS)
222     Cast a generic pointer to `GtkAspectFrameClass*'. *Note Standard
223     Macros::, for more info.
224
225 - Function: gint GTK_IS_ASPECT_FRAME (gpointer OBJ)
226     Determine if a generic pointer refers to a `GtkAspectFrame'
227     object. *Note Standard Macros::, for more info.
228
229
230File: gtk.info,  Node: GtkBin,  Next: GtkBox,  Prev: GtkAspectFrame,  Up: Widgets
231
232The bin widget
233==============
234
235Description
236-----------
237
238   The bin widget is a container (*note GtkContainer::) derived from the
239container widget. It is an abstract base class. That is, it is not
240possible to create an actual bin widget. It exists only to provide a
241base of functionality for other widgets. Specifically, the bin widget
242provides a base for several other widgets that contain only a single
243child. These widgets include alignments (*note GtkAlignment::), frames
244(*note GtkFrame::), items (*note GtkItem::), viewports (*note
245GtkViewport::) and windows (*note GtkWindow::)
246
247Options
248-------
249
250Signals
251-------
252
253Functions
254---------
255
256 - Function: guint gtk_bin_get_type (void)
257     Returns the `GtkBin' type identifier.
258
259 - Function: GtkBin* GTK_BIN (gpointer OBJ)
260     Cast a generic pointer to `GtkBin*'. *Note Standard Macros::, for
261     more info.
262
263 - Function: GtkBinClass* GTK_BIN_CLASS (gpointer CLASS)
264     Cast a generic pointer to `GtkBinClass*'. *Note Standard Macros::,
265     for more info.
266
267 - Function: gint GTK_IS_BIN (gpointer OBJ)
268     Determine if a generic pointer refers to a `GtkBin' object. *Note
269     Standard Macros::, for more info.
270
271
272File: gtk.info,  Node: GtkBox,  Next: GtkButtonBox,  Prev: GtkBin,  Up: Widgets
273
274The box widget
275==============
276
277Description
278-----------
279
280   The box widget is a container (*note GtkContainer::) derived from the
281container widget. It is an abstract base class used by the horizontal
282box (*note GtkHBox::), the vertical box (*note GtkVBox::) and the
283(*note GtkButtonBox::) widgets to provide a base of common
284functionality.
285
286   A box provides an abstraction for organizing the position and size of
287widgets. Widgets in a box are laid out horizontally or vertically. By
288using a box widget appropriately, a programmer can control how widgets
289are positioned and how they will be allocated space when a window gets
290resized.
291
292   The key attribute of boxes is that they position their children in a
293single row (horizontal boxes) or column (vertical boxes). In the case of
294horizontal boxes, all children are stretched vertically. The vertical
295size of the box is determined by the largest vertical requisition of all
296of its children. Similarly, a vertical box stretches all of its children
297horizontally. The horizontal size (of the vertical box) is determined by
298the largest horizontal requisition of all of its children. An alignment
299widget (*note GtkAlignment::) can be used to control child allocation
300more precisely on a per child basis.
301
302   The second attribute of boxes is how they expand children. In the
303case of a horizontal box, the main control is over how children are
304expanded horizontally to fill the allocated area. (The rest of this
305discussion will focus on horizontal boxes but it applies to vertical
306boxes as well).
307
308   There are two flags which can be set controlling how a widget is
309expanded horizontally in a horizontal box. These are the `expand' and
310`fill'. There operation is fairly simple. If `expand' is set, the
311child's potentially allocated area will expand to fill available space.
312If `fill' is set, the child's actual allocated area will be its
313potentially allocated area. There is a difference between the
314potentially area (which is the area the box widget sets aside for the
315child) and the actual allocated area (which is the area the box widget
316actual allocates for the widget via `gtk_widget_size_allocate').
317
318   The allocation of space to children occurs as follows (for horizontal
319boxes):
320  1. All children are allocated at least their requested size
321     horizontally and the maximum requested child size vertically.
322
323  2. Any child with the `expand' flag set is allocated `extra_width /
324     nexpand_children' extra pixels horizontally. If the `homogeneous'
325     flag was set, all children are considered to have the `expand' flag
326     set. That is, all children will be allocated the same area.The
327     horizontal box is a fair widget and, as such, divides up any extra
328     allocated space evenly among the "expand" children. (Those children
329     which have the `expand' flag set). The exception occurs when
330     `extra_width / nexpand_children' does not divide cleanly. The extra
331     space is given to the last widget.
332
333  3. `spacing' number of pixels separate each child. Note: The
334     separation is between the potentially allocated area for each
335     child and not the actual allocated area. The `padding' value
336     associated with each child causes that many pixels to be left
337     empty to each side of the child.
338
339  4. If a child has the `fill' flag set it is allocated its potentially
340     allocated area. If it does not, it is allocated its requested size
341     horizontally and centered within its potentially allocated area.
342     Its vertical allocation is still the maximum requested size of any
343     child.
344
345  5. Children placed at the start of the box are placed in order of
346     addition to the box from left to right in the boxes allocated
347     area.. Children placed at the end of the box are placed in order
348     of addition from right to left in the boxes allocated area.
349
350   *Note GtkHBox::, and *Note GtkVBox::, for code examples of using
351horizontal and vertical boxes.
352
353Options
354-------
355
356 - User Option: expand
357
358 - User Option: fill
359
360 - User Option: padding
361
362 - User Option: expand
363
364Signals
365-------
366
367Functions
368---------
369
370 - Function: guint gtk_box_get_type (void)
371     Returns the `GtkBox' type identifier.
372
373 - Function: void gtk_box_pack_start (GtkBox *BOX, GtkWidget *CHILD,
374          gint EXPAND, gint FILL, gint PADDING)
375     Add CHILD to the front of BOX. The flags EXPAND and FILL and the
376     padding value of PADDING are associated with CHILD.
377
378 - Function: void gtk_box_pack_end (GtkBox *BOX, GtkWidget *CHILD, gint
379          EXPAND, gint FILL, gint PADDING)
380     Add CHILD to the end of BOX. The flags EXPAND and FILL and the
381     padding value of PADDING are associated with CHILD.
382
383 - Function: void gtk_box_pack_start_defaults (GtkBox *BOX, GtkWidget
384          *WIDGET)
385     A convenience function which is equivalent to the following:
386
387            gtk_box_pack_start (BOX, WIDGET, TRUE, TRUE, 0);
388
389 - Function: void gtk_box_pack_end_defaults (GtkBox *BOX, GtkWidget
390          *WIDGET)
391     A convenience function which is equivalent to the following:
392
393            gtk_box_pack_start (BOX, WIDGET, TRUE, TRUE, 0);
394
395 - Function: void gtk_box_set_homogeneous (GtkBox *BOX, gint
396          HOMOGENEOUS)
397     Set the homogeneous setting of this box to HOMOGENEOUS.
398
399 - Function: void gtk_box_set_spacing (GtkBox *BOX, gint SPACING)
400
401 - Function: void gtk_box_reorder_child (GtkBox *BOX, GtkWidget *CHILD,
402          guint POS)
403
404 - Function: void gtk_box_query_child_packing (GtkBox *BOX, GtkWidget
405          *CHILD, gint *EXPAND, gint *FILL, gint *PADDING, GtkPackType
406          *PACK_TYPE)
407
408 - Function: void gtk_box_set_child_packing (GtkBox *BOX, GtkWidget
409          *CHILD, gint EXPAND, gint FILL, gint PADDING, GtkPackType
410          *PACK_TYPE)
411
412 - Function: GtkBox* GTK_BOX (gpointer OBJ)
413     Cast a generic pointer to `GtkBox*'. *Note Standard Macros::, for
414     more info.
415
416 - Function: GtkBoxClass* GTK_BOX_CLASS (gpointer CLASS)
417     Cast a generic pointer to `GtkBoxClass*'. *Note Standard Macros::,
418     for more info.
419
420 - Function: gint GTK_IS_BOX (gpointer OBJ)
421     Determine if a generic pointer refers to a `GtkBox' object. *Note
422     Standard Macros::, for more info.
423
424
425File: gtk.info,  Node: GtkButtonBox,  Next: GtkButton,  Prev: GtkBox,  Up: Widgets
426
427The button box widget
428=====================
429
430Description
431-----------
432
433   The button box widget is a container (*note GtkContainer::) derived
434from the (*note GtkBox::) widget. It is an abstract base class used by
435the horizontal button box (*note GtkHButtonBox::) and the vertical
436button box (*note GtkVButtonBox::) widgets to provide a base of common
437functionality.
438
439   The button box, like the box widget, (*note GtkBox::) provides an
440abstraction for organizing position and size of widgets. In the case of
441the button box it is targeted at the button widget,(*note GtkButton::).
442Button widgets are laid out in the box horizontally or vertically. By
443using a button box widget appropriately, a programmer can control how
444the button widgets are positioned and how they will be allocated space
445when a window gets resized.
446
447Options
448-------
449
450 - User Option: layout_style
451             * `GTK_BUTTONBOX_SPREAD'
452
453        * The layout style `GTK_BUTTONBOX_SPREAD' will spread the
454          buttons out evenly within the button box. When the parent
455          window is resized they will re-adjust to the new window
456          dimensions. The `gtk_button_box_set_spacing' function will
457          set the minimum space that the buttons will leave between
458          themselves.
459
460             * `GTK_BUTTONBOX_EDGE'
461
462        *             * `GTK_BUTTONBOX_START'
463
464        * The layout style `GTK_BUTTONBOX_START' will place the buttons
465          at the start of the button box, taking into account the
466          spacing as set by the `gtk_button_box_set_spacing' function.
467          The buttons will not move when the parent window is re-sized.
468
469             * `GTK_BUTTONBOX_END'
470
471        * The layout style `GTK_BUTTONBOX_END' will place the buttons
472          at the end of the button box, taking into account the spacing
473          as set by the `gtk_button_box_set_spacing' function. Again
474          like the `GTK_BUTTONBOX_START' layout style the buttons will
475          not move when the parent window is re-sized.
476
477 - User Option: width
478
479 - User Option: height
480
481 - User Option: ipad_x
482 - User Option: ipad_y
483
484Signals
485-------
486
487Functions
488---------
489
490 - Function: guint gtk_button_box_get_type (void)
491     Returns the `GtkButtonBox' type identifier.
492
493 - Function: void gtk_button_box_set_child_size_default (gint WIDTH,
494          gintHEIGHT)
495
496 - Function: void gtk_button_box_set_child_ipadding_default (gint
497          IPAD_X, gint IPAD_Y)
498
499 - Function: void gtk_button_box_get_child_size_default (gint *WIDTH,
500          gint *HEIGHT)
501
502 - Function: void gtk_button_box_get_child_ipadding_default (gint
503          *IPAD_X, gint *IPAD_Y)
504
505 - Function: void gtk_button_box_set_child_size (GtkButtonBox *WIDGET,
506          gint WIDTH, gint HEIGHT)
507
508 - Function: void gtk_button_box_set_child_ipadding (GtkButtonBox
509          *WIDGET, gint IPAD_X, gint IPAD_Y)
510
511 - Function: void gtk_button_box_set_layout (GtkButtonBox *WIDGET, gint
512          LAYOUT_STYLE)
513     This will set the layout style of the buttons within this box.
514     Currently it can be set to one of `GTK_BUTTONBOX_SPREAD',
515     `GTK_BUTTONBOX_EDGE', `GTK_BUTTONBOX_START' or `GTK_BUTTONBOX_END'.
516
517     The following example:
518              gtk_button_box_set_layout (GTK_BUTTON_BOX (box),
519                                         GTK_BUTTONBOX_SPREAD);
520     Will set the BOX argument to the "SPREAD" layout style described
521     above.
522
523 - Function: gint gtk_button_box_get_spacing (GtkButtonBox *WIDGET)
524     Get the per widget value for spacing within the button box. This
525     value is the amount of space that will be between the individual
526     buttons contained by this box.
527
528 - Function: void gtk_button_box_get_child_size (GtkButtonBox *WIDGET,
529          gint *WIDTH, gint *HEIGHT)
530
531 - Function: void gtk_button_box_get_child_ipadding (GtkButtonBox
532          *WIDGET, gint *IPAD_X, gint *IPAD_Y)
533     Get the per widget value for the padding inside the buttons. This
534     value controls how large the buttons will be within the box.
535
536 - Function: gint gtk_button_box_get_layout (GtkButtonBox *WIDGET)
537     Get the LAYOUT_STYLE for the `GtkButtonBox' object passed to this
538     function in the WIDGET variable.
539
540             layout = gtk_button_box_get_layout(GTK_BUTTON_BOX (box));
541
542
543 - Function: GtkButtonBox* GTK_BUTTON_BOX (gpointer OBJ)
544     Cast a generic pointer to `GtkButtonBox*'. *Note Standard
545     Macros::, for more info.
546
547 - Function: GtkButtonBoxClass* GTK_BUTTON_BOX_CLASS (gpointer CLASS)
548     Cast a generic pointer to `GtkButtonBoxClass*'. *Note Standard
549     Macros::, for more info.
550
551 - Function: gint GTK_IS_BUTTON_BOX (gpointer OBJ)
552     Determine if a generic pointer refers to a `GtkButtonBox' object.
553     *Note Standard Macros::, for more info.
554
555
556File: gtk.info,  Node: GtkButton,  Next: GtkCheckButton,  Prev: GtkButtonBox,  Up: Widgets
557
558The button widget
559=================
560
561Description
562-----------
563
564   A pressable button.  Contains a widget.  Changes its appearance
565(hilites) when it gets the focus.  Changes its appearance (pressed) when
566activated.  Derived from *note GtkContainer::.
567
568Signals
569-------
570
571 - Signal: void GtkButton::pressed (GtkButton *BUTTON)
572
573 - Signal: void GtkButton::released (GtkButton *BUTTON)
574
575 - Signal: void GtkButton::clicked (GtkButton *BUTTON)
576
577 - Signal: void GtkButton::enter (GtkButton *BUTTON)
578
579 - Signal: void GtkButton::leave (GtkButton *BUTTON)
580
581Functions
582---------
583
584 - Function: guint gtk_button_get_type (void)
585     Returns the `GtkButton' type identifier.
586
587 - Function: GtkWidget* gtk_button_new (void)
588     Create a new `GtkButton' object. The new widget is returned as a
589     pointer to a `GtkWidget' object. `NULL' is returned on failure.
590
591 - Function: GtkWidget* gtk_button_new_with_label (gchar *LABEL)
592     Create a new `GtkButton' object and set the text that is on the
593     button to LABEL. The new widget is returned as a pointer to a
594     `GtkWidget' object. `NULL' is returned on failure.
595
596 - Function: void gtk_button_pressed (GtkButton *BUTTON)
597
598 - Function: void gtk_button_released (GtkButton *BUTTON)
599
600 - Function: void gtk_button_clicked (GtkButton *BUTTON)
601
602 - Function: void gtk_button_enter (GtkButton *BUTTON)
603
604 - Function: void gtk_button_leave (GtkButton *BUTTON)
605
606 - Function: GtkButton* GTK_BUTTON (gpointer OBJ)
607     Cast a generic pointer to `GtkButton*'. *Note Standard Macros::,
608     for more info.
609
610 - Function: GtkButtonClass* GTK_BUTTON_CLASS (gpointer CLASS)
611     Cast a generic pointer to `GtkButtonClass*'. *Note Standard
612     Macros::, for more info.
613
614 - Function: gint GTK_IS_BUTTON (gpointer OBJ)
615     Determine if a generic pointer refers to a `GtkButton' object.
616     *Note Standard Macros::, for more info.
617
618
619File: gtk.info,  Node: GtkCheckButton,  Next: GtkCheckMenuItem,  Prev: GtkButton,  Up: Widgets
620
621The check button widget
622=======================
623
624Description
625-----------
626
627   Another form of toggle button (*note GtkToggleButton::) with an
628indicator.  Contains a widget to the right of the indicator.  Changes
629its appearance (hilites) when it gets the focus.
630
631Options
632-------
633
634Signals
635-------
636
637Functions
638---------
639
640 - Function: guint gtk_check_button_get_type (void)
641     Returns the `GtkCheckButton' type identifier.
642
643 - Function: GtkWidget* gtk_check_button_new (void)
644     Create a new `GtkCheckButton' object and initialize it with the
645     default values in the library. The new widget is returned as a
646     pointer to a `GtkWidget' object. A `NULL' is returned on failure.
647
648 - Function: GtkWidget* gtk_check_button_new_with_label (gchar *LABEL)
649     Create a new `GtkCheckButton' object and initialize it with the
650     values LABEL. The new widget is returned as a pointer to a
651     `GtkWidget' object. `NULL' is returned on any failure.
652
653 - Function: GtkCheckButton* GTK_CHECK_BUTTON (gpointer OBJ)
654
655 - Function: GtkCheckButtonClass* GTK_CHECK_BUTTON_CLASS (gpointer
656          CLASS)
657
658 - Function: gint GTK_IS_CHECK_BUTTON (gpointer OBJ)
659
660 - Function: GtkCheckButton* GTK_CHECK_BUTTON (gpointer OBJ)
661     Cast a generic pointer to `GtkCheckButton*'. *Note Standard
662     Macros::, for more info.
663
664 - Function: GtkCheckButtonClass* GTK_CHECK_BUTTON_CLASS (gpointer
665          CLASS)
666     Cast a generic pointer to `GtkCheckButtonClass*'. *Note Standard
667     Macros::, for more info.
668
669 - Function: gint GTK_IS_CHECK_BUTTON (gpointer OBJ)
670     Determine if a generic pointer refers to a `GtkCheckButton'
671     object. *Note Standard Macros::, for more info.
672
673
674File: gtk.info,  Node: GtkCheckMenuItem,  Next: GtkCList,  Prev: GtkCheckButton,  Up: Widgets
675
676The check menu item widget
677==========================
678
679Description
680-----------
681
682   Derived from *note GtkMenuItem::.  Very similar to a checkbutton
683(*note GtkCheckButton::), except that it's a menu item.  Has a toggled
684state which is displayed in a small rectangle to the left of the
685contained widget.
686
687Options
688-------
689
690 - User Option: label
691
692 - User Option: state
693
694Signals
695-------
696
697 - Signal: void GtkCheckMenuItem::toggled (GtkCheckMenuItem
698          *CHECK_MENU_ITEM)
699
700Functions
701---------
702
703 - Function: guint gtk_check_menu_item_get_type (void)
704     Returns the `GtkCheckMenuItem' type identifier.
705
706 - Function: GtkWidget* gtk_check_menu_item_new (void)
707     Create a new `GtkCheckMenuItem' object. The new widget is returned
708     as a pointer to a `GtkWidget' object. `NULL' is returned on
709     failure.
710
711 - Function: GtkWidget* gtk_check_menu_item_new_with_label (gchar
712          *LABEL)
713     Create a new `GtkCheckMenuItem' object and initialize it with the
714     values LABEL. The new widget is returned as a pointer to a
715     `GtkWidget' object. `NULL' is returned on failure.
716
717 - Function: void gtk_check_menu_item_set_state (GtkCheckMenuItem
718          *CHECK_MENU_ITEM, gint STATE)
719
720 - Function: void gtk_check_menu_item_toggled (GtkCheckMenuItem
721          *CHECK_MENU_ITEM)
722
723 - Function: GtkCheckMenuItem* GTK_CHECK_MENU_ITEM (gpointer OBJ)
724     Cast a generic pointer to `GtkCheckMenuItem*'. *Note Standard
725     Macros::, for more info.
726
727 - Function: GtkCheckMenuItemClass* GTK_CHECK_MENU_ITEM_CLASS (gpointer
728          CLASS)
729     Cast a generic pointer to `GtkCheckMenuItemClass*'. *Note Standard
730     Macros::, for more info.
731
732 - Function: gint GTK_IS_CHECK_MENU_ITEM (gpointer OBJ)
733     Determine if a generic pointer refers to a `GtkCheckMenuItem'
734     object. *Note Standard Macros::, for more info.
735
736
737File: gtk.info,  Node: GtkCList,  Next: GtkColorSelection,  Prev: GtkCheckMenuItem,  Up: Widgets
738
739The compound list widget
740========================
741
742Description
743-----------
744
745   A list of rows of columns, with a title row.  You can insert rows,
746and delete rows.  The user can scroll around and select a row.  Derived
747from *note GtkContainer::.  Cells can be empty, have a text and/or
748pixmap, or be a widget.
749
750Options
751-------
752
753Signals
754-------
755
756Functions
757---------
758
759 - Function: guint gtk_clist_get_type (void)
760     Returns the `GtkCList' type identifier.
761
762 - Function: GtkWidget* gtk_clist_new (int COLUMNS)
763     Create a new `GtkCList' initializing it with the value COLUMNS.
764     The new widget is returned as a pointer to a `GtkWidget' object.
765     `NULL' is returned on failure.
766
767 - Function: GtkWidget* gtk_clist_new_with_titles (int COLUMNS, gchar
768          *TITLES[])
769
770 - Function: void gtk_clist_set_border (GtkCList *CLIST, GtkShadowType
771          BORDER)
772     Set the border style of the CLIST to the shadow type BORDER.
773
774 - Function: void gtk_clist_set_selection_mode (GtkCList *CLIST
775          GtkSelectionMode MODE)
776     Set the selection mode on the CLIST to the MODE selection mode.
777
778 - Function: void gtk_clist_set_policy (GtkCList *CLIST, GtkPolicyType
779          VSCROLLBAR_POLICY, GtkPolicyType HSCROLLBAR_POLICY)
780     Set the policy on the scrollbars on the CLIST to VSCROLLBAR_POLICY
781     and HSCROLLBAR_POLICY.
782
783 - Function: void gtk_clist_freeze (GtkCList *CLIST)
784     Stop all visual updates of the CLIST. Useful for when making a
785     large number of changes to a `GtkCList'.
786
787 - Function: void gtk_clist_thaw (GtkCList *CLIST)
788     Allow all visual updates of the CLIST to resume.
789
790 - Function: void gtk_clist_column_titles_show (GtkCList *CLIST)
791     Show the column title buttons on the CLIST.
792
793 - Function: void gtk_clist_column_titles_hide (GtkCList *CLIST)
794     Hide the column title buttons on the CLIST.
795
796 - Function: void gtk_clist_set_column_title (GtkCList *CLIST, gint
797          COLUMN, gchar *TITLE)
798     Set the title in column COLUMN of the CLIST button to TITLE.
799
800 - Function: void gtk_clist_set_column_widget (GtkCList *CLIST, gint
801          COLUMN, GtkWidget *WIDGET)
802     Set the WIDGET instead of the title button for the column COLUMN
803     in the CLIST.
804
805 - Function: void gtk_clist_set_column_justification (GtkCList *CLIST,
806          gint COLUMN, GtkJustification JUSTIFICATION)
807     Set the COLUMN's justification, in the CLIST to JUSTIFICATION.
808
809 - Function: void gtk_clist_set_column_width (GtkCList *CLIST, gint
810          COLUMN, gint WIDTH)
811     Set the pixel width of column COLUMN in the `GtkCList' CLIST to
812     WIDTH. This function is a necessary step in creating a `GtkCList'
813     because otherwise the column width is chosen from the width of the
814     column title, which is almost never correct.
815
816 - Function: void gtk_clist_set_row_height (GtkCList *CLIST, gint
817          HEIGHT)
818     Change the height of the rows in the CLIST to HEIGHT. The default
819     is the height of the current font.
820
821 - Function: void gtk_clist_moveto (GtkCList *CLIST, gint ROW,
822          gintCOLUMN, gfloat ROW_ALIGN, gfloat COL_ALIGN)
823     Scroll the viewing area of the `GtkClist' in CLIST to COLUMN and
824     ROW. The ROW_ALIGN and COL_ALIGN are between zero and one,
825     representing the location the row should appear on screen. Setting
826     ROW_ALIGN or the COL_ALIGN to 0.0 will be the top or left of the
827     viewing area. Setting the ROW_ALIGN or COL_ALIGN to 1.0 will be
828     the bottom or right of the viewing area. If the ROW or COLUMN is
829     -1 then there is no change.
830
831 - Function: void gtk_clist_set_text (GtkCList *CLIST, gint ROW, gint
832          COLUMN, gchar *TEXT)
833     Set a given cell's text, located by the ROW and COLUMN, to TEXT
834     replacing its current contents.
835
836 - Function: void gtk_clist_set_pixmap (GtkCList *CLIST, gint ROW, gint
837          COLUMN, GdkPixmap *PIXMAP, GdkBitmap *MASK)
838     Set a given cell's text, located by the COLUMN and ROW arguments,
839     to the pixmap described by the PIXMAP argument using the MASK as
840     its mask. The current contents of the cell will be replaced.
841
842 - Function: void gtk_clist_setpixtext (GtkCList *CLIST, gint ROW, gint
843          COLUMN, gchar *TEXT, guint8 SPACING, GdkPixmap *PIXMAP,
844          GdkBitmap *MASK)
845     Set a given cell's text and pixmap, located by the ROW and COLUMN
846     arguments, to the text and pixmap described by the PIXMAP and TEXT
847     arguments. The MASK will be used for the pixmap mask and the
848     SPACING argument specifies the spacing between the two.
849
850 - Function: void gtk_clist_set_foreground (GtkCList *CLIST, gint ROW,
851          GdkColor *COLOR)
852     Set the foreground color of row ROW to COLOR in the `GtkCList'
853     CLIST. The COLOR must already be allocated.
854
855 - Function: void gtk_clist_set_background (GtkCList *CLIST, gint ROW,
856          GdkColor *COLOR)
857     Set the background color of row ROW to COLOR in the `GtkCList'
858     pointed to by CLIST. The color must be previously allocated.
859
860 - Function: void gtk_clist_set_shift (GtkCList *CLIST, gint ROW, gint
861          COLUMN, gint VERTICAL, gint HORIZONTAL)
862     Set the horizontal and vertical shift for drawing the contents of
863     the cell located at ROW and COLUMN. The VERTICAL and HORIZONTAL
864     arguments can be positive or negative.
865
866 - Function: gint gtk_clist_append (GtkCList *CLIST, gchar *TEXT[])
867     Append the given text, in the TEXT[] argument,  to the `GtkCList'
868     pointed to by the CLIST. The return value is the index of the row
869     that was just added.
870
871 - Function: void gtk_clist_insert (GtkCList *CLIST, gint ROW, gchar
872          *TEXT[])
873     Insert a row into the `GtkCList' pointed to by CLIST at row ROW
874     with the text in TEXT[].
875
876 - Function: void gtk_clist_remove (GtkCList *CLIST, gint ROW)
877     Remove row index ROW from the CLIST.
878
879 - Function: void gtk_clist_set_row_data (GtkCList *CLIST, gint ROW,
880          gpointer DATA)
881     Will set an arbitrary data pointer, DATA, for row ROW in the
882     `GtkCList' pointed to by CLIST.
883
884 - Function: gpointer gtk_clist_get_row_data (GtkCList *CLIST, gint ROW)
885     Return the data that was set for row ROW from the `GtkCList'
886     pointed to by CLIST. `NULL' is returned if no data was set.
887
888 - Function: void gtk_clist_select_row (GtkCList *CLIST, gint ROW, gint
889          COLUMN)
890     Force selection of a row, located by ROW and COLUMN, in the
891     `GtkCList' pointed to by CLIST.
892
893 - Function: void gtk_clist_unselect_row (GtkCList *CLIST, gint ROW,
894          gint COLUMN)
895     Force the unselection of a row, located by ROW and COLUMN, in the
896     `GtkCList' pointed to by CLIST.
897
898 - Function: void gtk_clist_clear (GtkCList *CLIST)
899     Clear the entire contents of the `GtkCList' pointed to by CLIST.
900     This is much faster then removing each item separately with
901     `gtk_clist_remove'.
902
903 - Function: GtkCList* GTK_CLIST (gpointer OBJ)
904     Cast a generic pointer to `GtkCList*'. *Note Standard Macros::, for
905     more info.
906
907 - Function: GtkCListClass* GTK_CLIST_CLASS (gpointer CLASS)
908     Cast a generic pointer to `GtkCListClass*'. *Note Standard
909     Macros::, for more info.
910
911 - Function: gint GTK_IS_CLIST (gpointer OBJ)
912     Determine if a generic pointer refers to a `GtkCList' object.
913     *Note Standard Macros::, for more info.
914
915
916File: gtk.info,  Node: GtkColorSelection,  Next: GtkCombo,  Prev: GtkCList,  Up: Widgets
917
918The color selector widget
919=========================
920
921Description
922-----------
923
924   A widget that allows a user to pick a color in one of many ways.
925They can click on a color wheel or saturation bar.  They can change hue,
926saturation, value, red, green, or blue with a slider, or by entering
927values.  Also allows the user to set an alpha (opacity) value.  Derived
928from *note GtkVBox::.
929
930Options
931-------
932
933 - User Option: policy
934        * GTK_UPDATE_CONTINUOUS
935
936        * GTK_UPDATE_DISCONTINUOUS
937
938        * GTK_UPDATE_DELAYED
939
940 - User Option: color
941
942 - User Option: use_opacity
943
944 - User Option: title
945
946Signals
947-------
948
949Functions
950---------
951
952 - Function: guint gtk_color_selection_get_type (void)
953     Returns the `GtkColorSelection' type identifier.
954
955 - Function: GtkWidget* gtk_color_selection_new (void)
956     Create a new `GtkColorSelection' object. The new object is
957     returned as a pointer to a `GtkWidget' object. `NULL' is returned
958     on failure.
959
960 - Function: void gtk_color_selection_set_update_policy
961          (GtkColorSelection *COLORSEL, GtkUpdateType POLICY)
962
963 - Function: void gtk_color_selection_set_color (GtkColorSelection
964          *COLORSEL, gdouble *COLOR)
965
966 - Function: void gtk_color_selection_get_color (GtkColorSelection
967          *COLORSEL, gdouble *COLOR)
968
969 - Function: void gtk_color_selection_set_opacity (GtkColorSelection
970          *COLORSEL, gint USE_OPACITY)
971
972 - Function: guint gtk_color_selection_dialog_get_type (void)
973     Returns the `GtkColorSelection' type identifier.
974
975 - Function: GtkWidget* gtk_color_selection_dialog_new (gchar *TITLE)
976     Create a new `GtkColorSelection' object initializing the title bar
977     of the resulting dialog to TITLE. The new widget is returned as a
978     pointer to a `GtkWidget' object. `NULL' is returned on failure.
979
980 - Function: GtkColorSelection* GTK_COLOR_SELECTION (gpointer OBJ)
981     Cast a generic pointer to `GtkColorSelection*'. *Note Standard
982     Macros::, for more info.
983
984 - Function: GtkColorSelectionClass* GTK_COLOR_SELECTION_CLASS
985          (gpointer CLASS)
986     Cast a generic pointer to `GtkColorSelectionClass*'. *Note
987     Standard Macros::, for more info.
988
989 - Function: gint GTK_IS_COLOR_SELECTION (gpointer OBJ)
990     Determine if a generic pointer refers to a `GtkColorSelection'
991     object. *Note Standard Macros::, for more info.
992
993
994File: gtk.info,  Node: GtkCombo,  Next: GtkContainer,  Prev: GtkColorSelection,  Up: Widgets
995
996The combo widget
997================
998
999Description
1000-----------
1001
1002   Text input box which also lets you choose from pre-defined values
1003from a drop-down menu.  Derived from *note GtkHBox::.
1004
1005Options
1006-------
1007
1008Signals
1009-------
1010
1011Functions
1012---------
1013
1014 - Function: guint gtk_combo_get_type (void)
1015     Returns the `GtkCombo' type identifier.
1016
1017 - Function: GtkWidget* gtk_combo_new (void)
1018     Create a new `GtkCombo' object returning the new widget as a
1019     pointer to a `GtkWidget' object. `NULL' is returned on failure.
1020
1021 - Function: void gtk_combo_set_value_in_list (GtkCombo *COMBO, gint
1022          VAL, gint OK_IF_EMPTY)
1023
1024 - Function: void gtk_combo_set_use_arrows (GtkCombo *COMBO, gint VAL)
1025
1026 - Function: void gtk_combo_set_use_arrows_always (GtkCombo *COMBO,
1027          gint VAL)
1028
1029 - Function: void gtk_combo_set_case_sensitive (GtkCombo *COMBO, gint
1030          VAL)
1031
1032 - Function: void gtk_combo_set_item_string (GtkCombo *COMBO, GtkItem
1033          *ITEM, gchar *ITEM_VALUE)
1034
1035 - Function: void gtk_combo_set_popdown_strings (GtkCombo *COMBO, GList
1036          *STRINGS)
1037
1038 - Function: GtkCombo* GTK_COMBO (gpointer OBJ)
1039     Cast a generic pointer to `GtkCombo*'. *Note Standard Macros::, for
1040     more info.
1041
1042 - Function: GtkComboClass* GTK_COMBO_CLASS (gpointer CLASS)
1043     Cast a generic pointer to `GtkComboClass*'. *Note Standard
1044     Macros::, for more info.
1045
1046 - Function: gint GTK_IS_COMBO (gpointer OBJ)
1047     Determine if a generic pointer refers to a `GtkCombo' object.
1048     *Note Standard Macros::, for more info.
1049
1050
1051File: gtk.info,  Node: GtkContainer,  Next: GtkCTree,  Prev: GtkCombo,  Up: Widgets
1052
1053The container widget
1054====================
1055
1056Description
1057-----------
1058
1059   A base class for objects that are built out of other widgets.  Many
1060widgets are containers.  For example, a button contains a widget.  That
1061widget might be a text label (usually is), or a pixmap, or even an hbox
1062which has a label and a pixmap.
1063
1064Options
1065-------
1066
1067 - User Option: border_width
1068
1069Signals
1070-------
1071
1072 - Signal: void GtkContainer::add (GtkContainer *CONTAINER, GtkWidget
1073          *WIDGET)
1074
1075 - Signal: void GtkContainer::remove (GtkContainer *CONTAINER,
1076          GtkWidget *WIDGET)
1077
1078 - Signal: void GtkContainer::need_resize (GtkContainer *CONTAINER,
1079          GtkWidget *WIDGET)
1080
1081 - Signal: void GtkContainer::foreach (GtkContainer *CONTAINER,
1082          GtkCallback CALLBACK, gpointer CALLBACK_DATA)
1083
1084 - Signal: gint GtkContainer::focus (GtkContainer *CONTAINER,
1085          GtkDirectionType DIRECTION)
1086
1087Functions
1088---------
1089
1090 - Function: guint gtk_container_get_type (void)
1091     Returns the `GtkContainer' type identifier.
1092
1093 - Function: void gtk_container_border_width (GtkContainer *CONTAINER,
1094          gint BORDER_WIDTH)
1095
1096 - Function: void gtk_container_add (GtkContainer *CONTAINER, GtkWidget
1097          *WIDGET)
1098     Add WIDGET to the CONTAINER.
1099
1100 - Function: void gtk_container_remove (GtkContainer *CONTAINER,
1101          GtkWidget *WIDGET)
1102     Remove WIDGET from CONTAINER.
1103
1104 - Function: void gtk_container_disable_resize (GtkContainer *CONTAINER)
1105
1106 - Function: void gtk_container_enable_resize (GtkContainer *CONTAINER)
1107
1108 - Function: void gtk_container_block_resize (GtkContainer *CONTAINER)
1109
1110 - Function: void gtk_container_unblock_resize (GtkContainer *CONTAINER)
1111
1112 - Function: gint gtk_container_need_resize (GtkContainer *CONTAINER,
1113          GtkWidget *WIDGET)
1114
1115 - Function: void gtk_container_check_resize (GtkContainer *CONTAINER,
1116          GtkWidget *WIDGET)
1117
1118 - Function: void gtk_container_foreach (GtkContainer *CONTAINER,
1119          GtkCallback CALLBACK, gpointer CALLBACK_DATA)
1120
1121 - Function: void gtk_container_focus (GtkContainer *CONTAINER,
1122          GtkDirectionType DIRECTION)
1123
1124 - Function: GList* gtk_container_children (GtkContainer CONTAINER)
1125
1126 - Function: GtkContainer* GTK_CONTAINER (gpointer OBJ)
1127     Cast a generic pointer to `GtkContainer*'. *Note Standard
1128     Macros::, for more info.
1129
1130 - Function: GtkContainerClass* GTK_CONTAINER_CLASS (gpointer CLASS)
1131     Cast a generic pointer to `GtkContainerClass*'. *Note Standard
1132     Macros::, for more info.
1133
1134 - Function: gint GTK_IS_CONTAINER (gpointer OBJ)
1135     Determine if a generic pointer refers to a `GtkContainer' object.
1136     *Note Standard Macros::, for more info.
1137
1138
1139File: gtk.info,  Node: GtkCTree,  Next: GtkCurve,  Prev: GtkContainer,  Up: Widgets
1140
1141The multi-column tree widget
1142============================
1143
1144Description
1145-----------
1146
1147   The GtkCTree widget is a multi-columned list with a designated
1148column, the `tree column', to display hierarchically-organized data.
1149Each node is either a folder (a branch of the tree) or a leaf. Nodes
1150can be (recursively) expanded, collapsed, (un)selected, removed, moved,
1151sorted etc.
1152
1153   GtkCTree is a descendant of *note GtkCList::. Therefore, a cell in a
1154column other than the tree column can only contain a string, a pixmap,
1155both or nothing. A node in the tree column can contain a string and up
1156to two pixmaps and masks, indicating the "folder openend" and "folder
1157closed" status.
1158
1159   Compared to GtkCList, there is no concept of row numbers. Therefore,
1160a number of GtkCList methods had to be re-implemented taking `GList
1161*node' arguments instead of `gint row'.
1162
1163Options
1164-------
1165
1166Signals
1167-------
1168
1169 - Signal: void GtkCTree::tree_expand (GtkCTree *CTREE, GList *NODE)
1170
1171 - Signal: void GtkCTree::tree_collapse (GtkCTree *CTREE, GList *NODE)
1172
1173 - Signal: void GtkCTree::tree_move (GtkCTree *CTREE, GList *NODE,
1174          GList *NEW_PARENT, GList *NEW_SIBLING)
1175
1176 - Signal: void GtkCTree::tree_select_row (GtkCTree *CTREE, GList *ROW,
1177          gint COLUMN)
1178
1179 - Signal: void GtkCTree::tree_unselect_row (GtkCTree *CTREE, GList
1180          *ROW, gint COLUMN)
1181
1182Functions
1183---------
1184
1185 - Function: GtkType gtk_ctree_get_type (void)
1186     Returns the `GtkCTree' type identifier.
1187
1188 - Function: GtkWidget* gtk_ctree_new (gint COLUMNS, gint TREE_COLUMN)
1189     Creates a new GtkCTree widget with the given number of columns and
1190     the given tree column.
1191
1192     On success, a pointer to the newly created widget is returned, and
1193     `NULL' otherwise.
1194
1195 - Function: GtkWidget* gtk_ctree_new_with_titles (gint COLUMNS, gint
1196          TREE_COLUMN, gchar *TITLES[])
1197     Creates a new GtkCTree widget with the given number of columns and
1198     the given tree column. The column titles are initialized to the
1199     strings of the array TITLES.
1200
1201     On success, a pointer to the newly created widget is returned, and
1202     `NULL' otherwise.
1203
1204 - Function: GList* gtk_ctree_insert (GtkCTree *CTREE, GList *PARENT,
1205          GList *SIBLING, gchar *TEXT[], guint8 SPACING, GdkPixmap
1206          *PIXMAP_CLOSED, GdkPixmap *MASK_CLOSED, GdkPixmap
1207          *PIXMAP_OPENED, GdkPixmap *MASK_OPENED, gboolean IS_LEAF,
1208          gboolean EXPANDED)
1209     Inserts a new node at the given position. If PARENT == NULL, the
1210     node is inserted at root level. If SIBLING == NULL, the node is
1211     appended to the existing list of siblings. Otherwise, the node is
1212     inserted before SIBLING.  If not NULL, the two pixmaps/masks are
1213     used to indicate the opened/closed status of the node. SPACING is
1214     the number of pixels between pixmap and text.  If IS_LEAF == TRUE,
1215     the node cannot have any children.  The initial expanded/collapsed
1216     status is given by EXPANDED.
1217
1218     On success, the pointer to the newly inserted node is returned,
1219     and NULL otherwise.
1220
1221 - Function: void gtk_ctree_remove (GtkCTree *CTREE, GList *NODE)
1222     Removes the given node and all its children.
1223
1224 - Function: void gtk_ctree_clear (GtkCTree *CTREE)
1225     Removes all nodes of CTREE.
1226
1227 - Function: void gtk_ctree_post_recursive (GtkCTree *CTREE, GList
1228          *NODE, GtkCTreeFunc FUNC, gpointer DATA)
1229     Apply FUNC to NODE and all its children, traversing CTREE in
1230     post-order.
1231
1232 - Function: void gtk_ctree_pre_recursive (GtkCTree *CTREE, GList
1233          *NODE, GtkCTreeFunc FUNC, gpointer DATA)
1234     Apply FUNC to NODE and all its children, traversing CTREE in
1235     pre-order.
1236
1237 - Function: gboolean gtk_ctree_is_visible (GtkCTree *CTREE, GList
1238          *NODE)
1239     Returns the visibility status of the given node. A node is said to
1240     be visible if in the chain of parent nodes every node is expanded.
1241     Or : the node is currently being displayed (but not necessarily
1242     inside the viewing area).
1243
1244 - Function: GtkCTree* GTK_CTREE (gpointer OBJ)
1245     Cast a generic pointer to `GtkCTree*'. *Note Standard Macros::, for
1246     more info.
1247
1248 - Function: GtkCTreeClass* GTK_CTREE_CLASS (gpointer CLASS)
1249     Cast a generic pointer to `GtkCTreeClass*'. *Note Standard
1250     Macros::, for more info.
1251
1252 - Function: gint GTK_IS_CTREE (gpointer OBJ)
1253     Determine if a generic pointer refers to a `GtkCTree' object.
1254     *Note Standard Macros::, for more info.
1255
1256
1257File: gtk.info,  Node: GtkCurve,  Next: GtkGammaCurve,  Prev: GtkCTree,  Up: Widgets
1258
1259The curve widget
1260================
1261
1262Description
1263-----------
1264
1265   Derived from *note GtkDrawingArea::.
1266
1267Options
1268-------
1269
1270 - User Option: type
1271        * GTK_CURVE_TYPE_LINEAR
1272
1273        * GTK_CURVE_TYPE_SPLINE
1274
1275        * GTK_CURVE_TYPE_FREE
1276
1277Signals
1278-------
1279
1280Functions
1281---------
1282
1283 - Function: guint gtk_curve_get_type (void)
1284     Returns the `GtkCurve' type identifier.
1285
1286 - Function: GtkWidget* gtk_curve_new (void)
1287     Create a new `GtkCurve' returning the new widget as a pointer to a
1288     `GtkWidget' object.
1289
1290 - Function: void gtk_curve_reset (GtkCurve *CURVE)
1291
1292 - Function: void gtk_curve_set_gamma (GtkCurve *CURVE, gfloat GAMMA)
1293
1294 - Function: void gtk_curve_set_range (GtkCurve *CURVE, gfloat MIN_X,
1295          gfloat MAX_X, gfloat MIN_Y, gfloat MAX_Y)
1296
1297 - Function: void gtk_curve_get_vector (GtkCurve *CURVE, int VECLEN,
1298          gfloat VECTOR[])
1299
1300 - Function: void gtk_curve_set_vector (GtkCurve *CURVE, int VECLEN,
1301          gfloat VECTOR[])
1302
1303 - Function: void gtk_curve_set_curve_type (GtkCurve *CURVE,
1304          GtkCurveType TYPE)
1305
1306 - Function: GtkCurve* GTK_CURVE (gpointer OBJ)
1307     Cast a generic pointer to `GtkCurve*'. *Note Standard Macros::, for
1308     more info.
1309
1310 - Function: GtkCurveClass* GTK_CURVE_CLASS (gpointer CLASS)
1311     Cast a generic pointer to `GtkCurveClass*'. *Note Standard
1312     Macros::, for more info.
1313
1314 - Function: gint GTK_IS_CURVE (gpointer OBJ)
1315     Determine if a generic pointer refers to a `GtkCurve' object.
1316     *Note Standard Macros::, for more info.
1317
1318
1319File: gtk.info,  Node: GtkGammaCurve,  Next: GtkDialog,  Prev: GtkCurve,  Up: Widgets
1320
1321The gamma curve widget
1322======================
1323
1324Description
1325-----------
1326
1327   Lets the user edit a gamma curve (a one-to-one mapping usually used
1328to adjust the intensity of an image to the physical characteristics of
1329the output device).  You can set the minimum and maximum values for
1330input and output.  You can set the initial vector as well.  You are
1331guaranteed that every input value will have a (not necessarily unique)
1332output value specified.  Derived from *note GtkVBox::.  Makes use of
1333*note GtkCurve:: to draw the curve.
1334
1335Options
1336-------
1337
1338Signals
1339-------
1340
1341Functions
1342---------
1343
1344 - Function: guint gtk_gamma_curve_get_type (void)
1345     Returns the `GtkGamma' type identifier.
1346
1347 - Function: GtkWidget* gtk_gamma_curve_new (void)
1348     Create a new `GtkGamma' returning the new widget as a pointer to a
1349     `GtkWidget' object.
1350
1351 - Function: GtkGammaCurve* GTK_GAMMACURVE (gpointer OBJ)
1352     Cast a generic pointer to `GtkGammaCurve*'. *Note Standard
1353     Macros::, for more info.
1354
1355 - Function: GtkGammaCurveClass* GTK_GAMMACURVE_CLASS (gpointer CLASS)
1356     Cast a generic pointer to `GtkGammaCurveClass*'. *Note Standard
1357     Macros::, for more info.
1358
1359 - Function: gint GTK_IS_GAMMACURVE (gpointer OBJ)
1360     Determine if a generic pointer refers to a `GtkGammaCurve' object.
1361     *Note Standard Macros::, for more info.
1362
1363
1364File: gtk.info,  Node: GtkDialog,  Next: GtkDrawingArea,  Prev: GtkGammaCurve,  Up: Widgets
1365
1366The dialog widget
1367=================
1368
1369Description
1370-----------
1371
1372   The dialog widget is a window (*note GtkWindow::) that has a
1373vertical box (*note GtkVBox::), a horizontal box (*note GtkHBox::),
1374separated with a horizontal separator (*note GtkHSeparator::).
1375
1376Options
1377-------
1378
1379Signals
1380-------
1381
1382Functions
1383---------
1384
1385 - Function: guint gtk_dialog_get_type (void)
1386     Returns the `GtkDialog' type identifier.
1387
1388 - Function: GtkWidget* gtk_dialog_new (void)
1389     Create a new `GtkDialog' object and return the new widget as a
1390     pointer to a `GtkWidget' object. `NULL' is returned on failure.
1391
1392 - Function: GtkDialog* GTK_DIALOG (gpointer OBJ)
1393     Cast a generic pointer to `GtkDialog*'. *Note Standard Macros::,
1394     for more info.
1395
1396 - Function: GtkDialogClass* GTK_DIALOG_CLASS (gpointer CLASS)
1397     Cast a generic pointer to `GtkDialogClass*'. *Note Standard
1398     Macros::, for more info.
1399
1400 - Function: gint GTK_IS_DIALOG (gpointer OBJ)
1401     Determine if a generic pointer refers to a `GtkDialog' object.
1402     *Note Standard Macros::, for more info.
1403
1404
1405File: gtk.info,  Node: GtkDrawingArea,  Next: GtkEntry,  Prev: GtkDialog,  Up: Widgets
1406
1407The drawing area widget
1408=======================
1409
1410Description
1411-----------
1412
1413   A base class for widgets that need a box to draw into.  So far, only
1414used by GtkCurve.
1415
1416Options
1417-------
1418
1419 - User Option: width
1420
1421 - User Option: height
1422
1423Signals
1424-------
1425
1426Functions
1427---------
1428
1429 - Function: guint gtk_drawing_area_get_type (void)
1430     Returns the `GtkDrawingArea' type identifier.
1431
1432 - Function: GtkWidget* gtk_drawing_area_new (void)
1433     Create a new `GtkDrawingArea' object returning the new widget as a
1434     pointer to a `GtkWidget' object. `NULL' is returned on failure.
1435
1436 - Function: void gtk_drawing_area_size (GtkDrawingArea *DAREA, gint
1437          WIDTH, gint HEIGHT)
1438     Set the size of the DAREA widget, created previously, to WIDTH and
1439     HEIGHT.
1440
1441 - Function: GtkDrawingArea* GTK_DRAWING_AREA (gpointer OBJ)
1442     Cast a generic pointer to `GtkDrawingArea*'. *Note Standard
1443     Macros::, for more info.
1444
1445 - Function: GtkDrawingAreaClass* GTK_DRAWING_AREA_CLASS (gpointer
1446          CLASS)
1447     Cast a generic pointer to `GtkDrawingAreaClass*'. *Note Standard
1448     Macros::, for more info.
1449
1450 - Function: gint GTK_IS_DRAWING_AREA (gpointer OBJ)
1451     Determine if a generic pointer refers to a `GtkDrawingArea'
1452     object. *Note Standard Macros::, for more info.
1453
Note: See TracBrowser for help on using the repository browser.