Standard Enumerations: CTK+ 3 Reference Manual

Standard Enumerations

Standard Enumerations — Public enumerated types used throughout CTK+

Types and Values

enum	CtkBaselinePosition
enum	CtkDeleteType
enum	CtkDirectionType
enum	CtkJustification
enum	CtkMovementStep
enum	CtkOrientation
enum	CtkPackType
enum	CtkPositionType
enum	CtkReliefStyle
enum	CtkScrollStep
enum	CtkScrollType
enum	CtkSelectionMode
enum	CtkShadowType
enum	CtkStateFlags
enum	CtkToolbarStyle
enum	CtkSortType

Includes

#include <ctk/ctk.h>

Description

Functions

Types and Values

enum CtkBaselinePosition

Whenever a container has some form of natural row it may align children in that row along a common typographical baseline. If the amount of verical space in the row is taller than the total requested height of the baseline-aligned children then it can use a CtkBaselinePosition to select where to put the baseline inside the extra availible space.

Members

CTK_BASELINE_POSITION_TOP	Align the baseline at the top
CTK_BASELINE_POSITION_CENTER	Center the baseline
CTK_BASELINE_POSITION_BOTTOM	Align the baseline at the bottom

Since: 3.10

enum CtkDeleteType

Members

CTK_DELETE_CHARS	Delete characters.
CTK_DELETE_WORD_ENDS	Delete only the portion of the word to the left/right of cursor if we’re in the middle of a word.
CTK_DELETE_WORDS	Delete words.
CTK_DELETE_DISPLAY_LINES	Delete display-lines. Display-lines refers to the visible lines, with respect to to the current line breaks. As opposed to paragraphs, which are defined by line breaks in the input.
CTK_DELETE_DISPLAY_LINE_ENDS	Delete only the portion of the display-line to the left/right of cursor.
CTK_DELETE_PARAGRAPH_ENDS	Delete to the end of the paragraph. Like C-k in Emacs (or its reverse).
CTK_DELETE_PARAGRAPHS	Delete entire line. Like C-k in pico.
CTK_DELETE_WHITESPACE	Delete only whitespace. Like M-\ in Emacs.

enum CtkDirectionType

Focus movement types.

Members

CTK_DIR_TAB_FORWARD	Move forward.
CTK_DIR_TAB_BACKWARD	Move backward.
CTK_DIR_UP	Move up.
CTK_DIR_DOWN	Move down.
CTK_DIR_LEFT	Move left.
CTK_DIR_RIGHT	Move right.

enum CtkJustification

Used for justifying the text inside a CtkLabel widget. (See also CtkAlignment).

Members

CTK_JUSTIFY_LEFT	The text is placed at the left edge of the label.
CTK_JUSTIFY_RIGHT	The text is placed at the right edge of the label.
CTK_JUSTIFY_CENTER	The text is placed in the center of the label.
CTK_JUSTIFY_FILL	The text is placed is distributed across the label.

enum CtkMovementStep

Members

CTK_MOVEMENT_LOGICAL_POSITIONS	Move forward or back by graphemes
CTK_MOVEMENT_VISUAL_POSITIONS	Move left or right by graphemes
CTK_MOVEMENT_WORDS	Move forward or back by words
CTK_MOVEMENT_DISPLAY_LINES	Move up or down lines (wrapped lines)
CTK_MOVEMENT_DISPLAY_LINE_ENDS	Move to either end of a line
CTK_MOVEMENT_PARAGRAPHS	Move up or down paragraphs (newline-ended lines)
CTK_MOVEMENT_PARAGRAPH_ENDS	Move to either end of a paragraph
CTK_MOVEMENT_PAGES	Move by pages
CTK_MOVEMENT_BUFFER_ENDS	Move to ends of the buffer
CTK_MOVEMENT_HORIZONTAL_PAGES	Move horizontally by pages

enum CtkOrientation

Represents the orientation of widgets and other objects which can be switched between horizontal and vertical orientation on the fly, like CtkToolbar or CtkGesturePan.

Members

CTK_ORIENTATION_HORIZONTAL	The element is in horizontal orientation.
CTK_ORIENTATION_VERTICAL	The element is in vertical orientation.

enum CtkPackType

Represents the packing location CtkBox children. (See: CtkVBox, CtkHBox, and CtkButtonBox).

Members

CTK_PACK_START	The child is packed into the start of the box
CTK_PACK_END	The child is packed into the end of the box

enum CtkPositionType

Describes which edge of a widget a certain feature is positioned at, e.g. the tabs of a CtkNotebook, the handle of a CtkHandleBox or the label of a CtkScale.

Members

CTK_POS_LEFT	The feature is at the left edge.
CTK_POS_RIGHT	The feature is at the right edge.
CTK_POS_TOP	The feature is at the top edge.
CTK_POS_BOTTOM	The feature is at the bottom edge.

enum CtkReliefStyle

Indicated the relief to be drawn around a CtkButton.

Members

CTK_RELIEF_NORMAL	Draw a normal relief.
CTK_RELIEF_HALF	A half relief. Deprecated in 3.14, does the same as `CTK_RELIEF_NORMAL`
CTK_RELIEF_NONE	No relief.

enum CtkScrollStep

Members

CTK_SCROLL_STEPS	Scroll in steps.
CTK_SCROLL_PAGES	Scroll by pages.
CTK_SCROLL_ENDS	Scroll to ends.
CTK_SCROLL_HORIZONTAL_STEPS	Scroll in horizontal steps.
CTK_SCROLL_HORIZONTAL_PAGES	Scroll by horizontal pages.
CTK_SCROLL_HORIZONTAL_ENDS	Scroll to the horizontal ends.

enum CtkScrollType

Scrolling types.

Members

CTK_SCROLL_NONE	No scrolling.
CTK_SCROLL_JUMP	Jump to new location.
CTK_SCROLL_STEP_BACKWARD	Step backward.
CTK_SCROLL_STEP_FORWARD	Step forward.
CTK_SCROLL_PAGE_BACKWARD	Page backward.
CTK_SCROLL_PAGE_FORWARD	Page forward.
CTK_SCROLL_STEP_UP	Step up.
CTK_SCROLL_STEP_DOWN	Step down.
CTK_SCROLL_PAGE_UP	Page up.
CTK_SCROLL_PAGE_DOWN	Page down.
CTK_SCROLL_STEP_LEFT	Step to the left.
CTK_SCROLL_STEP_RIGHT	Step to the right.
CTK_SCROLL_PAGE_LEFT	Page to the left.
CTK_SCROLL_PAGE_RIGHT	Page to the right.
CTK_SCROLL_START	Scroll to start.
CTK_SCROLL_END	Scroll to end.

enum CtkSelectionMode

Used to control what selections users are allowed to make.

Members

CTK_SELECTION_NONE	No selection is possible.
CTK_SELECTION_SINGLE	Zero or one element may be selected.
CTK_SELECTION_BROWSE	Exactly one element is selected. In some circumstances, such as initially or during a search operation, it’s possible for no element to be selected with `CTK_SELECTION_BROWSE`. What is really enforced is that the user can’t deselect a currently selected element except by selecting another element.
CTK_SELECTION_MULTIPLE	Any number of elements may be selected. The Ctrl key may be used to enlarge the selection, and Shift key to select between the focus and the child pointed to. Some widgets may also allow Click-drag to select a range of elements.

enum CtkShadowType

Used to change the appearance of an outline typically provided by a CtkFrame.

Note that many themes do not differentiate the appearance of the various shadow types: Either their is no visible shadow (CTK_SHADOW_NONE ), or there is (any other value).

Members

CTK_SHADOW_NONE	No outline.
CTK_SHADOW_IN	The outline is bevelled inwards.
CTK_SHADOW_OUT	The outline is bevelled outwards like a button.
CTK_SHADOW_ETCHED_IN	The outline has a sunken 3d appearance.
CTK_SHADOW_ETCHED_OUT	The outline has a raised 3d appearance.

enum CtkStateFlags

Describes a widget state. Widget states are used to match the widget against CSS pseudo-classes. Note that CTK extends the regular CSS classes and sometimes uses different names.

Members

CTK_STATE_FLAG_NORMAL	State during normal operation.
CTK_STATE_FLAG_ACTIVE	Widget is active.
CTK_STATE_FLAG_PRELIGHT	Widget has a mouse pointer over it.
CTK_STATE_FLAG_SELECTED	Widget is selected.
CTK_STATE_FLAG_INSENSITIVE	Widget is insensitive.
CTK_STATE_FLAG_INCONSISTENT	Widget is inconsistent.
CTK_STATE_FLAG_FOCUSED	Widget has the keyboard focus.
CTK_STATE_FLAG_BACKDROP	Widget is in a background toplevel window.
CTK_STATE_FLAG_DIR_LTR	Widget is in left-to-right text direction. Since 3.8
CTK_STATE_FLAG_DIR_RTL	Widget is in right-to-left text direction. Since 3.8
CTK_STATE_FLAG_LINK	Widget is a link. Since 3.12
CTK_STATE_FLAG_VISITED	The location the widget points to has already been visited. Since 3.12
CTK_STATE_FLAG_CHECKED	Widget is checked. Since 3.14
CTK_STATE_FLAG_DROP_ACTIVE	Widget is highlighted as a drop target for DND. Since 3.20

enum CtkToolbarStyle

Used to customize the appearance of a CtkToolbar. Note that setting the toolbar style overrides the user’s preferences for the default toolbar style. Note that if the button has only a label set and CTK_TOOLBAR_ICONS is used, the label will be visible, and vice versa.

Members

CTK_TOOLBAR_ICONS	Buttons display only icons in the toolbar.
CTK_TOOLBAR_TEXT	Buttons display only text labels in the toolbar.
CTK_TOOLBAR_BOTH	Buttons display text and icons in the toolbar.
CTK_TOOLBAR_BOTH_HORIZ	Buttons display icons and text alongside each other, rather than vertically stacked

enum CtkSortType

Determines the direction of a sort.

Members

CTK_SORT_ASCENDING	Sorting is in ascending order.
CTK_SORT_DESCENDING	Sorting is in descending order.