← Back to branch summary

~ubuntu-branches/ubuntu/trusty/rgtk2/trusty

« back to all changes in this revision

Viewing changes to man/gtk-Standard-Enumerations.Rd

  • Committer: Bazaar Package Importer
  • Author(s): Dirk Eddelbuettel
  • Date: 2010-11-03 11:35:46 UTC
  • mfrom: (1.3.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20101103113546-a7fi7jdxdebp0tw1
Tags: 2.20.1-1
* New upstream release

* debian/control: Set (Build-)Depends: to current R version
* debian/control: Set Standards-Version: to current version 

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/gtk-Standard-Enumerations.Rd
99
99
 
100
100
}
101
101
\item{\verb{GtkArrowType}}{
102
 
Used to indicate the direction in which a \verb{\link{GtkArrow}} should point.
 
102
Used to indicate the direction in which a \code{\link{GtkArrow}} should point.
103
103
 
104
104
\describe{
105
105
\item{\verb{up}}{Represents an upward pointing arrow.}
122
122
 
123
123
}
124
124
\item{\verb{GtkButtonBoxStyle}}{
125
 
Used to dictate the style that a \verb{\link{GtkButtonBox}} uses to layout the buttons it
126
 
contains. (See also: \verb{\link{GtkVButtonBox}} and \verb{\link{GtkHButtonBox}}).
 
125
Used to dictate the style that a \code{\link{GtkButtonBox}} uses to layout the buttons it
 
126
contains. (See also: \code{\link{GtkVButtonBox}} and \code{\link{GtkHButtonBox}}).
127
127
 
128
128
\describe{
129
129
\item{\verb{default-style}}{Default packing.}
138
138
}
139
139
\item{\verb{GtkCornerType}}{
140
140
Specifies which corner a child widget should be placed in when packed into
141
 
a \verb{\link{GtkScrolledWindow}}. This is effectively the opposite of where the scroll
 
141
a \code{\link{GtkScrolledWindow}}. This is effectively the opposite of where the scroll
142
142
bars are placed.
143
143
 
144
144
\describe{
154
154
 
155
155
}
156
156
\item{\verb{GtkCurveType}}{
 
157
\strong{WARNING: \code{GtkCurveType} is deprecated and should not be used in newly-written code.}
157
158
\emph{undocumented
158
159
}
159
160
 
212
213
 
213
214
}
214
215
\item{\verb{GtkExpanderStyle}}{
215
 
Used to specify the style of the expanders drawn by a \verb{\link{GtkTreeView}}.
 
216
Used to specify the style of the expanders drawn by a \code{\link{GtkTreeView}}.
216
217
 
217
218
\describe{
218
219
\item{\verb{collapsed}}{The style used for a collapsed subtree.}
249
250
 
250
251
}
251
252
\item{\verb{GtkJustification}}{
252
 
Used for justifying the text inside a \verb{\link{GtkLabel}} widget. (See also
253
 
\verb{\link{GtkAlignment}}).
 
253
Used for justifying the text inside a \code{\link{GtkLabel}} widget. (See also
 
254
\code{\link{GtkAlignment}}).
254
255
 
255
256
\describe{
256
257
\item{\verb{left}}{The text is placed at the left edge of the label.}
282
283
 
283
284
}
284
285
\item{\verb{GtkMetricType}}{
285
 
Used to indicate which metric is used by a \verb{\link{GtkRuler}}.
 
286
Used to indicate which metric is used by a \code{\link{GtkRuler}}.
286
287
 
287
288
\describe{
288
289
\item{\verb{pixels}}{Pixels.}
321
322
}
322
323
\item{\verb{GtkOrientation}}{
323
324
Represents the orientation of widgets which can be switched between horizontal
324
 
and vertical orientation on the fly, like \verb{\link{GtkToolbar}}.
 
325
and vertical orientation on the fly, like \code{\link{GtkToolbar}}.
325
326
 
326
327
\describe{
327
328
\item{\verb{horizontal}}{The widget is in horizontal orientation.}
330
331
 
331
332
}
332
333
\item{\verb{GtkPackType}}{
333
 
Represents the packing location \verb{\link{GtkBox}} children. (See: \verb{\link{GtkVBox}},
334
 
\verb{\link{GtkHBox}}, and \verb{\link{GtkButtonBox}}).
 
334
Represents the packing location \code{\link{GtkBox}} children. (See: \code{\link{GtkVBox}},
 
335
\code{\link{GtkHBox}}, and \code{\link{GtkButtonBox}}).
335
336
 
336
337
\describe{
337
338
\item{\verb{start}}{The child is packed into the start of the box}
374
375
 
375
376
}
376
377
\item{\verb{GtkPolicyType}}{
377
 
Determines when a scroll bar will be visible. 
 
378
Determines when a scroll bar will be visible.
378
379
 
379
380
\describe{
380
381
\item{\verb{always}}{The scrollbar is always visible.}
381
382
\item{\verb{automatic}}{The scrollbar will appear and disappear as necessary. For example,
382
 
when all of a \verb{\link{GtkCList}} can not be seen.}
 
383
when all of a \code{\link{GtkCList}} can not be seen.}
383
384
\item{\verb{never}}{The scrollbar will never appear.}
384
385
}
385
386
 
386
387
}
387
388
\item{\verb{GtkPositionType}}{
388
389
Describes which edge of a widget a certain feature is positioned at, e.g. the
389
 
tabs of a \verb{\link{GtkNotebook}}, the handle of a \verb{\link{GtkHandleBox}} or the label of a 
390
 
\verb{\link{GtkScale}}.
 
390
tabs of a \code{\link{GtkNotebook}}, the handle of a \code{\link{GtkHandleBox}} or the label of a
 
391
\code{\link{GtkScale}}.
391
392
 
392
393
\describe{
393
394
\item{\verb{left}}{The feature is at the left edge.}
409
410
 
410
411
}
411
412
\item{\verb{GtkReliefStyle}}{
412
 
Indicated the relief to be drawn around a \verb{\link{GtkButton}}.
 
413
Indicated the relief to be drawn around a \code{\link{GtkButton}}.
413
414
 
414
415
\describe{
415
416
\item{\verb{normal}}{Draw a normal relief.}
498
499
\item{\verb{none}}{No selection is possible.}
499
500
\item{\verb{single}}{Zero or one element may be selected.}
500
501
\item{\verb{browse}}{Exactly one element is selected. In some circumstances,
501
 
  such as initially or during a search operation, it's possible for no element 
502
 
  to be selected with \code{GTK_SELECTION_BROWSE}. What is really enforced is that 
503
 
  the user can't deselect a currently selected element except by selecting 
 
502
  such as initially or during a search operation, it's possible for no element
 
503
  to be selected with \code{GTK_SELECTION_BROWSE}. What is really enforced is that
 
504
  the user can't deselect a currently selected element except by selecting
504
505
  another element.}
505
506
\item{\verb{multiple}}{Any number of elements may be selected. 
506
 
   Clicks toggle the state of an item. Any number of elements may be selected. 
507
 
   The Ctrl key may be used to enlarge the selection, and Shift key to select 
 
507
   Clicks toggle the state of an item. Any number of elements may be selected.
 
508
   The Ctrl key may be used to enlarge the selection, and Shift key to select
508
509
   between the focus and the child pointed to. Some widgets may also allow
509
510
   Click-drag to select a range of elements.}
510
511
\item{\verb{extended}}{Deprecated, behaves identical to \code{GTK_SELECTION_MULTIPLE}.}
512
513
 
513
514
}
514
515
\item{\verb{GtkShadowType}}{
515
 
Used to change the appearance of an outline typically provided by a \verb{\link{GtkFrame}}.
 
516
Used to change the appearance of an outline typically provided by a \code{\link{GtkFrame}}.
516
517
 
517
518
\describe{
518
519
\item{\verb{none}}{No outline.}
543
544
\item{\verb{GtkStateType}}{
544
545
This type indicates the current state of a widget; the state determines how
545
546
the widget is drawn. The \code{\link{GtkStateType}} enumeration is also used to
546
 
identify different colors in a \verb{\link{GtkStyle}} for drawing, so states can be
 
547
identify different colors in a \code{\link{GtkStyle}} for drawing, so states can be
547
548
used for subparts of a widget as well as entire widgets.
548
549
 
549
550
\describe{
562
563
Indicates the direction a sub-menu will appear.
563
564
 
564
565
\describe{
565
 
\item{\verb{left}}{A sub-menu will appear}
566
 
\item{\verb{right}}{\emph{undocumented
567
 
}}
 
566
\item{\verb{left}}{A sub-menu will appear to the left of the current menu.}
 
567
\item{\verb{right}}{A sub-menu will appear to the right of the current menu.}
568
568
}
569
569
 
570
570
}
582
582
 
583
583
}
584
584
\item{\verb{GtkToolbarStyle}}{
585
 
Used to customize the appearance of a \verb{\link{GtkToolbar}}. Note that 
 
585
Used to customize the appearance of a \code{\link{GtkToolbar}}. Note that
586
586
setting the toolbar style overrides the user's preferences
587
587
for the default toolbar style.  Note that if the button has only
588
588
a label set and GTK_TOOLBAR_ICONS is used, the label will be
598
598
 
599
599
}
600
600
\item{\verb{GtkUpdateType}}{
601
 
\emph{undocumented
602
 
}
 
601
Used by \code{\link{GtkRange}} to control the policy for notifying value changes.
603
602
 
604
603
\describe{
605
 
\item{\verb{continuous}}{\emph{undocumented
606
 
}}
607
 
\item{\verb{discontinuous}}{\emph{undocumented
608
 
}}
609
 
\item{\verb{delayed}}{\emph{undocumented
610
 
}}
 
604
\item{\verb{continuous}}{Notify updates whenever the value changed}
 
605
\item{\verb{discontinuous}}{Notify updates when the mouse button has been released}
 
606
\item{\verb{delayed}}{Space out updates with a small timeout}
611
607
}
612
608
 
613
609
}
614
610
\item{\verb{GtkVisibility}}{
615
 
Used by \verb{\link{GtkCList}} and \verb{\link{GtkCTree}} to indicate whether a row is visible.
 
611
Used by \code{\link{GtkCList}} and \code{\link{GtkCTree}} to indicate whether a row is visible.
616
612
 
617
613
\describe{
618
614
\item{\verb{none}}{The row is not visible.}
623
619
}
624
620
\item{\verb{GtkWindowPosition}}{
625
621
Window placement can be influenced using this enumeration. Note that
626
 
using \verb{GTK_WIN_POS_CENTER_ALWAYS} is almost always a bad idea. 
 
622
using \verb{GTK_WIN_POS_CENTER_ALWAYS} is almost always a bad idea.
627
623
It won't necessarily work well with all window managers or on all windowing systems.
628
624
 
629
625
\describe{
637
633
 
638
634
}
639
635
\item{\verb{GtkWindowType}}{
640
 
A \verb{\link{GtkWindow}} can be one of these types. Most things you'd consider a
 
636
A \code{\link{GtkWindow}} can be one of these types. Most things you'd consider a
641
637
"window" should have type \verb{GTK_WINDOW_TOPLEVEL}; windows with this type
642
638
are managed by the window manager and have a frame by default (call
643
639
\code{\link{gtkWindowSetDecorated}} to toggle the frame).  Windows with type
646
642
window with a frame, many GTK+ features that rely on the window
647
643
manager will not work (e.g. resize grips and
648
644
maximization/minimization). \verb{GTK_WINDOW_POPUP} is used to implement
649
 
widgets such as \verb{\link{GtkMenu}} or tooltips that you normally don't think of 
 
645
widgets such as \code{\link{GtkMenu}} or tooltips that you normally don't think of
650
646
as windows per se. Nearly all windows should be \verb{GTK_WINDOW_TOPLEVEL}.
651
647
In particular, do not use \verb{GTK_WINDOW_POPUP} just to turn off
652
648
the window borders; use \code{\link{gtkWindowSetDecorated}} for that.
667
663
 
668
664
}
669
665
}}
670
 
\references{\url{http://developer.gnome.org/doc/API/2.0/gtk/gtk-Standard-Enumerations.html}}
 
666
\references{\url{http://library.gnome.org/devel//gtk/gtk-Standard-Enumerations.html}}
671
667
\author{Derived by RGtkGen from GTK+ documentation}
672
668
\keyword{internal}