gtk2/docs/reference/gtk/tmpl/gtkenums.sgml

379 lines
8.6 KiB
Plaintext
Raw Normal View History

1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Title ##### -->
Standard Enumerations
<!-- ##### SECTION Short_Description ##### -->
Public enumerated types used throughout GTK+.
1999-08-16 18:51:52 +00:00
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### ENUM GtkAccelFlags ##### -->
<para>
</para>
@GTK_ACCEL_VISIBLE:
@GTK_ACCEL_SIGNAL_VISIBLE:
@GTK_ACCEL_LOCKED:
@GTK_ACCEL_MASK:
<!-- ##### ENUM GtkArrowType ##### -->
<para>
Used to indicate the direction in which a #GtkArrow should point.
1999-08-16 18:51:52 +00:00
</para>
@GTK_ARROW_UP: Represents an upward pointing arrow.
@GTK_ARROW_DOWN: Represents a downward pointing arrow.
@GTK_ARROW_LEFT: Represents a left pointing arrow.
@GTK_ARROW_RIGHT: Represents a right pointing arrow.
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkAttachOptions ##### -->
<para>
Denotes the expansion properties that a widget will have when it (or it's
parent) is resized.
1999-08-16 18:51:52 +00:00
</para>
@GTK_EXPAND: the widget should expand to take up any extra space in its
container that has been allocated.
@GTK_SHRINK: the widget should shrink as and when possible.
@GTK_FILL: the widget should fill the space allocated to it.
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkButtonBoxStyle ##### -->
<para>
Used to dictate the style that a #GtkButtonBox uses to layout the buttons it
contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
1999-08-16 18:51:52 +00:00
</para>
@GTK_BUTTONBOX_DEFAULT_STYLE: Default packing.
@GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the ButtonBox.
@GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the ButtonBox.
@GTK_BUTTONBOX_START: Buttons are grouped towards the start of box, (on the
left for a HBox, or the top for a VBox).
@GTK_BUTTONBOX_END: Buttons are grouped towards the end of a box, (on the
right for a HBox, or the bottom for a VBox).
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkCornerType ##### -->
<para>
Specifies which corner a child widget should be placed in when packed into
a #GtkScrolledWindow. This is effectively the opposite of where the scroll
bars are placed.
1999-08-16 18:51:52 +00:00
</para>
@GTK_CORNER_TOP_LEFT: Place the scrollbars on the right and bottom of the
widget (default behaviour).
@GTK_CORNER_BOTTOM_LEFT: Place the scrollbars on the top and right of the
widget.
@GTK_CORNER_TOP_RIGHT: Place the scrollbars on the left and bottom of the
widget.
@GTK_CORNER_BOTTOM_RIGHT: Place the scrollbars on the top and left of the
widget.
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkCurveType ##### -->
<para>
</para>
@GTK_CURVE_TYPE_LINEAR:
@GTK_CURVE_TYPE_SPLINE:
@GTK_CURVE_TYPE_FREE:
<!-- ##### ENUM GtkDeleteType ##### -->
<para>
</para>
@GTK_DELETE_CHARS:
@GTK_DELETE_WORD_ENDS:
@GTK_DELETE_WORDS:
@GTK_DELETE_DISPLAY_LINES:
@GTK_DELETE_DISPLAY_LINE_ENDS:
@GTK_DELETE_PARAGRAPH_ENDS:
@GTK_DELETE_PARAGRAPHS:
@GTK_DELETE_WHITESPACE:
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkDirectionType ##### -->
<para>
</para>
@GTK_DIR_TAB_FORWARD:
@GTK_DIR_TAB_BACKWARD:
@GTK_DIR_UP:
@GTK_DIR_DOWN:
@GTK_DIR_LEFT:
@GTK_DIR_RIGHT:
<!-- ##### ENUM GtkJustification ##### -->
<para>
Used for justifying the text inside a #GtkLabel widget. (See also
#GtkAlignment).
1999-08-16 18:51:52 +00:00
</para>
@GTK_JUSTIFY_LEFT: The text is placed at the left edge of the label.
@GTK_JUSTIFY_RIGHT: The text is placed at the right edge of the label.
@GTK_JUSTIFY_CENTER: The text is placed in the center of the label.
@GTK_JUSTIFY_FILL: The text is placed is distributed across the label.
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkMatchType ##### -->
<para>
</para>
@GTK_MATCH_ALL:
@GTK_MATCH_ALL_TAIL:
@GTK_MATCH_HEAD:
@GTK_MATCH_TAIL:
@GTK_MATCH_EXACT:
@GTK_MATCH_LAST:
<!-- ##### ENUM GtkMetricType ##### -->
<para>
</para>
@GTK_PIXELS:
@GTK_INCHES:
@GTK_CENTIMETERS:
<!-- ##### ENUM GtkMovementStep ##### -->
<para>
</para>
@GTK_MOVEMENT_CHARS:
@GTK_MOVEMENT_POSITIONS:
@GTK_MOVEMENT_WORDS:
@GTK_MOVEMENT_DISPLAY_LINES:
@GTK_MOVEMENT_DISPLAY_LINE_ENDS:
@GTK_MOVEMENT_PARAGRAPHS:
@GTK_MOVEMENT_PARAGRAPH_ENDS:
@GTK_MOVEMENT_PAGES:
@GTK_MOVEMENT_BUFFER_ENDS:
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkOrientation ##### -->
<para>
</para>
@GTK_ORIENTATION_HORIZONTAL:
@GTK_ORIENTATION_VERTICAL:
<!-- ##### ENUM GtkPackType ##### -->
<para>
Used for packing widgets into #GtkBox widgets. (See also: #GtkVBox,
#GtkHBox, and #GtkButtonBox).
1999-08-16 18:51:52 +00:00
</para>
@GTK_PACK_START: The
1999-08-16 18:51:52 +00:00
@GTK_PACK_END:
<!-- ##### ENUM GtkPathPriorityType ##### -->
<para>
</para>
@GTK_PATH_PRIO_LOWEST:
@GTK_PATH_PRIO_GTK:
@GTK_PATH_PRIO_APPLICATION:
@GTK_PATH_PRIO_RC:
@GTK_PATH_PRIO_HIGHEST:
@GTK_PATH_PRIO_MASK:
<!-- ##### ENUM GtkPathType ##### -->
<para>
</para>
@GTK_PATH_WIDGET:
@GTK_PATH_WIDGET_CLASS:
@GTK_PATH_CLASS:
<!-- ##### ENUM GtkPolicyType ##### -->
<para>
Determines when a scroll bar will be visible.
1999-08-16 18:51:52 +00:00
</para>
@GTK_POLICY_ALWAYS: The scrollbar is always visible.
@GTK_POLICY_AUTOMATIC: The scrollbar will appear and disappear as necessary. For example,
when all of a #GtkCList can not be seen.
@GTK_POLICY_NEVER: The scrollbar will never appear.
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkPositionType ##### -->
<para>
</para>
@GTK_POS_LEFT:
@GTK_POS_RIGHT:
@GTK_POS_TOP:
@GTK_POS_BOTTOM:
<!-- ##### ENUM GtkPreviewType ##### -->
<para>
An enumeration which describes whether a preview
contains grayscale or red-green-blue data.
</para>
@GTK_PREVIEW_COLOR: the preview contains red-green-blue data.
@GTK_PREVIEW_GRAYSCALE: The preview contains grayscale data.
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkReliefStyle ##### -->
<para>
</para>
@GTK_RELIEF_NORMAL:
@GTK_RELIEF_HALF:
@GTK_RELIEF_NONE:
<!-- ##### ENUM GtkResizeMode ##### -->
<para>
</para>
@GTK_RESIZE_PARENT:
@GTK_RESIZE_QUEUE:
@GTK_RESIZE_IMMEDIATE:
<!-- ##### ENUM GtkScrollType ##### -->
<para>
</para>
@GTK_SCROLL_NONE:
@GTK_SCROLL_STEP_BACKWARD:
@GTK_SCROLL_STEP_FORWARD:
@GTK_SCROLL_PAGE_BACKWARD:
@GTK_SCROLL_PAGE_FORWARD:
@GTK_SCROLL_JUMP:
<!-- ##### ENUM GtkSelectionMode ##### -->
<para>
</para>
@GTK_SELECTION_SINGLE:
@GTK_SELECTION_BROWSE:
@GTK_SELECTION_MULTIPLE:
@GTK_SELECTION_EXTENDED:
<!-- ##### ENUM GtkShadowType ##### -->
<para>
Used to change the appearance of an outline typically provided by a #GtkFrame.
1999-08-16 18:51:52 +00:00
</para>
@GTK_SHADOW_NONE: No outline.
@GTK_SHADOW_IN: The outline is bevelled inwards.
@GTK_SHADOW_OUT: The outline is bevelled outwards like a button.
@GTK_SHADOW_ETCHED_IN: The outline itself is an inward bevel, but the frame
does
1999-08-16 18:51:52 +00:00
@GTK_SHADOW_ETCHED_OUT:
<!-- ##### ENUM GtkStateType ##### -->
<para>
This type indicates the current state of a widget.
1999-08-16 18:51:52 +00:00
</para>
@GTK_STATE_NORMAL: The state during normal operation.
@GTK_STATE_ACTIVE: The widget is currently active, such as a
@GTK_STATE_PRELIGHT: The mouse pointer is over the widget.
1999-08-16 18:51:52 +00:00
@GTK_STATE_SELECTED:
@GTK_STATE_INSENSITIVE: The state of the widget can not be altered by the
user. Its appearance will usually indicate this.
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkSubmenuDirection ##### -->
<para>
Indicates the direction a sub-menu will appear.
1999-08-16 18:51:52 +00:00
</para>
@GTK_DIRECTION_LEFT: A sub-menu will appear
1999-08-16 18:51:52 +00:00
@GTK_DIRECTION_RIGHT:
<!-- ##### ENUM GtkSubmenuPlacement ##### -->
<para>
</para>
@GTK_TOP_BOTTOM:
@GTK_LEFT_RIGHT:
<!-- ##### ENUM GtkToolbarStyle ##### -->
<para>
Used to customize the appearance of a #GtkToolbar.
1999-08-16 18:51:52 +00:00
</para>
@GTK_TOOLBAR_ICONS: Buttons should display only icons in the toolbar.
@GTK_TOOLBAR_TEXT: Buttons should display only text labels in the toolbar.
@GTK_TOOLBAR_BOTH: Buttons should display text and icons in the toolbar.
@GTK_TOOLBAR_BOTH_HORIZ:
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkTroughType ##### -->
<para>
</para>
@GTK_TROUGH_NONE:
@GTK_TROUGH_START:
@GTK_TROUGH_END:
@GTK_TROUGH_JUMP:
<!-- ##### ENUM GtkUpdateType ##### -->
<para>
</para>
@GTK_UPDATE_CONTINUOUS:
@GTK_UPDATE_DISCONTINUOUS:
@GTK_UPDATE_DELAYED:
<!-- ##### ENUM GtkVisibility ##### -->
<para>
</para>
@GTK_VISIBILITY_NONE:
@GTK_VISIBILITY_PARTIAL:
@GTK_VISIBILITY_FULL:
<!-- ##### ENUM GtkWindowPosition ##### -->
<para>
Window placement can be influenced using this enumeration.
1999-08-16 18:51:52 +00:00
</para>
@GTK_WIN_POS_NONE: No influence is made on placement.
@GTK_WIN_POS_CENTER: Windows should be placed in the center of the screen.
@GTK_WIN_POS_MOUSE: Windows should be placed at the current mouse position.
@GTK_WIN_POS_CENTER_ALWAYS:
create some stock buttons with the default accel group (create_image): 2000-10-04 Havoc Pennington <hp@redhat.com> * gtk/testgtk.c (create_buttons): create some stock buttons with the default accel group (create_image): test some new GtkImage features (make_message_dialog): test GtkMessageDialog (create_modal_window): fix someone's bizzarro indentation * gtk/gtkwindow.h, gtk/gtkwindow.c: Implement GTK_WIN_POS_CENTER_ON_PARENT. Add "destroy with parent" setting, which means the window goes away with its transient parent. (gtk_window_get_default_accel_group): get the default accel group for the window. (gtk_window_set_destroy_with_parent): set/unset destroy with parent flag (gtk_window_read_rcfiles): invalidate icon set caches after reloading rcfiles * gtk/gtkenums.h (GtkWindowPosition): add GTK_WIN_POS_CENTER_ON_PARENT, which centers a dialog on its parent window when the dialog is mapped for the first time. * gtk/gtkmessagedialog.h, gtk/gtkmessagedialog.c: Add a simple message dialog class * gtk/gtkdialog.c (gtk_dialog_init): Connect delete event handler to emit response signal, and maybe later it would honor a hide_on_delete flag - though that isn't there yet. Set border width on the vbox to 2, so we get some padding. Use a button box for the action area. (gtk_dialog_key_press): synthesize a delete event if Esc is pressed and the GtkWidget key press handler didn't handle the escape key. (gtk_dialog_new_with_buttons): new function creates a dialog with some default buttons in it. (gtk_dialog_add_action_widget): add an activatable widget as a button in the dialog - you can also add a non-activatable widget by accessing the action area directly. (gtk_dialog_add_button): add a simple button - stock ID or label - to the action area (gtk_dialog_response): emit response signal (gtk_dialog_run): block waiting for the dialog, return the response. Override normal delete_event behavior, so that delete_event does nothing inside gtk_dialog_run(). * gtk/gtkdialog.h, gtk/gtkdialog.c: Add "response" signal emitted when an action widget is clicked or the dialog gets delete_event * gtk/gtk.h: add gtkmessagedialog.h * gtk/Makefile.am: add gtkmessagedialog.[hc] 2000-10-20 Havoc Pennington <hp@redhat.com> * gtk/gtk-sections.txt: Add dialog docs
2000-10-20 23:14:41 +00:00
@GTK_WIN_POS_CENTER_ON_PARENT:
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkWindowType ##### -->
<para>
A #GtkWindow can be of these types. A toplevel window has standard window
decorations by default. A dialog may have fewer decorations and obey a
different placement policy. A popup window will have no decorations.
</para>
<para>
It should be noted that such decorations can often be over-ridden by modern
window managers.
1999-08-16 18:51:52 +00:00
</para>
@GTK_WINDOW_TOPLEVEL: A window for a typical application.
@GTK_WINDOW_DIALOG: A window for transient messages and dialogs.
@GTK_WINDOW_POPUP: A window for popups.
1999-08-16 18:51:52 +00:00
<!-- ##### ENUM GtkSortType ##### -->
<para>
Determines the direction of a sort.
1999-08-16 18:51:52 +00:00
</para>
@GTK_SORT_ASCENDING: Sorting is in ascending order.
@GTK_SORT_DESCENDING: Sorting is in descending order.
1999-08-16 18:51:52 +00:00