Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Xfc::Gtk Namespace Reference
[The Xfc Namespace]

The C++ framework for the GTK GUI library. More...

Classes

Typedefs

Enumerations

Functions

Accelerator Methods
Icon Size Methods
Drawing Methods

Detailed Description

The C++ framework for the GTK GUI library.

Provides a set of graphical objects called widgets which serve as the GUI component, such as Gtk::Button and Gtk::Textview.


Enumeration Type Documentation

enum Xfc::Gtk::AccelFlags

Accelerator flags.

Enumerator:
ACCEL_VISIBLE  Display the accelerator in an AccelLabel.
ACCEL_LOCKED  Is the accelerator removable?
ACCEL_MASK  Has a value of 0x07.

enum Xfc::Gtk::ArrowType

Used to indicate the direction in which an Arrow should point.

Enumerator:
ARROW_UP  Represents an upward pointing arrow.
ARROW_DOWN  Represents a downward pointing arrow.
ARROW_LEFT  Represents a left pointing arrow.
ARROW_RIGHT  Represents a right pointing arrow.

enum Xfc::Gtk::AttachOptions

Denotes the expansion properties that a widget will have when it (or it's parent) is resized.

Enumerator:
EXPAND  The widget should expand to take up any extra space in its container that has been allocated.
SHRINK  The widget should shrink as and when possible.
FILL  The widget should fill the space allocated to it.

enum Xfc::Gtk::ButtonBoxStyle

ButtonBoxStyle is used to dictate the style that a ButtonBox uses to layout the buttons it contains.

(See also: VButtonBox and HButtonBox).

Enumerator:
BUTTONBOX_DEFAULT_STYLE  Default packing.
BUTTONBOX_SPREAD  Buttons are evenly spread across the ButtonBox.
BUTTONBOX_EDGE  Buttons are placed at the edges of the ButtonBox.
BUTTONBOX_START  Buttons are grouped towards the start of ButtonBox.
BUTTONBOX_END  Buttons are grouped towards the end of ButtonBox.

enum Xfc::Gtk::ButtonType

Prebuilt sets of buttons for the dialog.

If none of these choices are appropriate, simply use BUTTONS_NONE then call Gtk::Dialog::add_buttons().

Enumerator:
BUTTONS_NONE  No buttons at all.
BUTTONS_OK  An OK button.
BUTTONS_CLOSE  A Close button.
BUTTONS_CANCEL  A Cancel button.
BUTTONS_YES_NO  Yes and No buttons.
BUTTONS_OK_CANCEL  OK and Cancel buttons.

enum Xfc::Gtk::CalendarDisplayOptions

The display options that specify how the calendar itself is displayed.

Enumerator:
CALENDAR_SHOW_HEADING  Specifies that the month and year should be displayed.
CALENDAR_SHOW_DAY_NAMES  Specifies that three letter day descriptions should be present.
CALENDAR_NO_MONTH_CHANGE  Prevents the user from switching months with the calendar.
CALENDAR_SHOW_WEEK_NUMBERS  Displays each week numbers of the current year, down the left side of the calendar.
CALENDAR_WEEK_START_MONDAY  Starts the calendar week on Monday, instead of the default Sunday.

enum Xfc::Gtk::CellRendererMode

Specifies the editable mode of the CellRenderer.

Enumerator:
INERT  The cell is neither activatable nor editable.
ACTIVATABLE  The cell can be activated.
EDITABLE  The cell can be edited.

enum Xfc::Gtk::CellRendererState

Specifies how the CellRenderer should render a cell.

Enumerator:
CELL_RENDERER_SELECTED  The cell can be selected.
CELL_RENDERER_PRELIT  The cell can be prelit.
CELL_RENDERER_INSENSITIVE  The cell is insensitive.
CELL_RENDERER_SORTED  The cell is in the sort column/row.
CELL_RENDERER_FOCUSED  The cell can be focused.

enum Xfc::Gtk::CornerType

Specifies which corner a child widget should be placed in when packed into a ScrolledWindow.

This is effectively the opposite of where the scroll bars are placed.

Enumerator:
CORNER_BOTTOM_LEFT  Place the scrollbars on the top and right of the widget.
CORNER_TOP_RIGHT  Place the scrollbars on the left and bottom of the widget.
CORNER_BOTTOM_RIGHT  Place the scrollbars on the top and left of the widget.

enum Xfc::Gtk::CurveType

The type of curve.

Once set the curve will remain unchanged except when changing from a free curve to a linear or spline curve.

Enumerator:
CURVE_TYPE_LINEAR  Linear interpolation.
CURVE_TYPE_SPLINE  Spline interpolation.
CURVE_TYPE_FREE  Free form curve.

enum Xfc::Gtk::DeleteType

Indicates the text deletion type; used by the Entry and Textview widgets.

Enumerator:
DELETE_CHARS  Delete characters.
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.
DELETE_WORDS  Delete words.
DELETE_DISPLAY_LINES  Deletes the entire line of text from an Entry.
DELETE_DISPLAY_LINE_ENDS  Deletes text in an Entry, from the current cursor position to the end of the line.
DELETE_PARAGRAPH_ENDS  Like C-k in Emacs (or its reverse).
DELETE_PARAGRPHS  Like C-k in pico, kill whole line.
DELETE_WHITESPACE  Like M-\ in Emacs.

enum Xfc::Gtk::DestDefaults

Specifies the various types of action that will be taken on behalf of the user for a drag destination site.

Enumerator:
DEST_DEFAULT_MOTION  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).
DEST_DEFAULT_HIGHLIGHT  If set for a widget, GTK+ will draw a highlight on this widget as long as a drag is over this widget and the widget drag format and action are acceptable.
DEST_DEFAULT_DROP  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 and if so, GTK+ will call gtk_drag_data_get() on behalf of the widget.
DEST_DEFAULT_ALL  If set, specifies that all default actions should be taken.

enum Xfc::Gtk::DialogFlags

Construction/destruction flags.

Enumerator:
DIALOG_MODAL  Calls Gtk::Window::set_modal(true).
DIALOG_DESTROY_WITH_PARENT  Calls Gtk::Window::set_destroy_with_parent().
DIALOG_NO_SEPARATOR  No separator bar above the action buttons.

enum Xfc::Gtk::DirectionType

Indicates direction; used by widgets such as Menu, Notebook, ScrollWindow and TextView.

Enumerator:
DIR_TAB_FORWARD  Tab in a forword direction.
DIR_TAB_BACKWARD  Tab in a backward direction.
DIR_UP  Up.
DIR_DOWN  Down.
DIR_LEFT  Left.
DIR_RIGHT  Right.

enum Xfc::Gtk::ExpanderStyle

ExpanderStyle is used by Style::draw_expander() to indicate the type of expander to draw.

Enumerator:
EXPANDER_COLLAPSED  Expander collapsed.
EXPANDER_SEMI_COLLAPSED  Expander semi-collapsed.
EXPANDER_SEMI_EXPANDED  Expander semi-expanded.
EXPANDER_EXPANDED  Expander expanded.

enum Xfc::Gtk::FileChooserAction

Describes whether a FileChooser is being used to open existing files or to save to a possibly new file.

Enumerator:
FILE_CHOOSER_ACTION_OPEN  Indicates open mode; The file chooser will only let the user pick an existing file.
FILE_CHOOSER_ACTION_SAVE  Indicates save mode; The file chooser will let the user pick an existing file, or type in a new filename.
FILE_CHOOSER_ACTION_SELECT_FOLDER  Indicates an Open mode for selecting folders; The file chooser will let the user pick an existing folder.
FILE_CHOOSER_ACTION_CREATE_FOLDER  Indicates a mode for creating a new folder; The file chooser will let the user name an existing or new folder.

enum Xfc::Gtk::FileChooserError

These identify the various errors that can occur while calling FileChooser functions.

Enumerator:
FILE_CHOOSER_ERROR_NONEXISTENT  Indicates that a file does not exist.
FILE_CHOOSER_ERROR_BAD_FILENAME  Indicates a malformed filename.

enum Xfc::Gtk::FileFilterFlags

Used by Gtk::FileFilter::add_custom() to let GTK+ know what file information needs to be retrieved.

This avoids retrieving expensive information when it isn't needed by your filter function.

Enumerator:
FILE_FILTER_FILENAME  Get filename.
FILE_FILTER_URI  Get URI.
FILE_FILTER_DISPLAY_NAME  Get display name.
FILE_FILTER_MIME_TYPE  Get mime type.

enum Xfc::Gtk::IconLookupFlags

The flags used to specify options for Gtk::IconTheme::lookup_icon().

Enumerator:
ICON_LOOKUP_NO_SVG  Never return SVG icons, even if gdk-pixbuf supports them; Cannot be used together with Gtk::ICON_LOOKUP_FORCE_SVG.
ICON_LOOKUP_FORCE_SVG  Return SVG icons; Cannot be used together with Gtk::ICON_LOOKUP_NO_SVG.
ICON_LOOKUP_USE_BUILTIN  When passed to Gtk::IconTtheme::lookup_icon() includes builtin icons as well as files.

For a builtin icon, Gtk::IconInfo::get_filename() returns null and you need to call Gtk::IconInfo::get_builtin_pixbuf().

enum Xfc::Gtk::IconSize

The Icon size to render.

Enumerator:
ICON_SIZE_INVALID  Invalid.
ICON_SIZE_MENU  An icon size suitable for menus.
ICON_SIZE_SMALL_TOOLBAR  An icon size suitable for small toolbars.
ICON_SIZE_LARGE_TOOLBAR  An icon size suitable for large toolbars.
ICON_SIZE_BUTTON  An icon size suitable for buttons.
ICON_SIZE_DND  An icon size suitable for drag-and-drop.
ICON_SIZE_DIALOG  An icon size suitable for dialogs.

enum Xfc::Gtk::IconThemeError

Error codes for Gtk::IconTheme operations.

Enumerator:
ICON_THEME_NOT_FOUND  The icon specified does not exist in the theme.
ICON_THEME_FAILED  An unspecified error occurred.

enum Xfc::Gtk::ImageType

Describes the image data representation used by a GtkImage.

If you want to get the image from the widget, you can only get the currently-stored representation. e.g. if the get_storage_type() returns IMAGE_PIXBUF, then you can call get_pixbuf() but not get_stock(). For empty images, you can request any storage type (call any of the "get" functions), but they will all return null values.

Enumerator:
IMAGE_EMPTY  There is no image displayed by the widget.
IMAGE_PIXMAP  The widget contains a Gdk::Pixmap.
IMAGE_IMAGE  The widget contains a Gdk::Image.
IMAGE_PIXBUF  The widget contains a Gdk::Pixbuf.
IMAGE_STOCK  The widget contains a stock icon name.
IMAGE_ICON_SET  The widget contains a Gtk::IconSet.
IMAGE_ANIMATION  The widget contains a Gdk::PixbufAnimation.
IMAGE_ICON_NAME  The widget contains an image from the current icon theme.

enum Xfc::Gtk::Justification

Used for justifying the text inside a Label widget (see also Alignment).

Enumerator:
JUSTIFY_LEFT  The text is placed at the left edge of the label.
JUSTIFY_RIGHT  The text is placed at the right edge of the label.
JUSTIFY_CENTER  The text is placed in the center of the label.
JUSTIFY_FILL  The text is placed is distributed across the label.

enum Xfc::Gtk::MenuDirectionType

MenuDirectionType represents the directional movements within a menu.

Enumerator:
MENU_DIR_PARENT  To the parent menu shell.
MENU_DIR_CHILD  To the submenu, if any, associated with the item.
MENU_DIR_NEXT  To the next menu item.
MENU_DIR_PREV  To the previous menu item.

enum Xfc::Gtk::MessageType

The type of message being displayed in the dialog.

Enumerator:
MESSAGE_INFO  Informational message.
MESSAGE_WARNING  Nonfatal warning message.
MESSAGE_QUESTION  Question requiring a choice.
MESSAGE_ERROR  Fatal error message.

enum Xfc::Gtk::MetricType

Used to define the unit type for Ruler.

Enumerator:
PIXELS  Ruler with pixel units.
INCHES  Ruler with inch units.

enum Xfc::Gtk::MovementStep

Describes the movement of the insertion point (cursor).

Enumerator:
MOVEMENT_LOGICAL_POSITIONS  Move by forward/back graphemes.
MOVEMENT_VISUAL_POSITIONS  Move by left/right graphemes.
MOVEMENT_WORDS  Move by forward/back words.
MOVEMENT_DISPLAY_LINES  Move up/down lines (wrapped lines).
MOVEMENT_DISPLAY_LINE_ENDS  Move up/down lines (wrapped lines).
MOVEMENT_PARAGRAPHS  Move up/down paragraphs (newline-ended lines).
MOVEMENT_PARAGRAPHS_ENDS  Move to either end of a paragraph.
MOVEMENT_PAGES  Move by pages.
MOVEMENT_BUFFER_ENDS  Move to ends of the buffer.
MOVEMENT_HORIZONTAL_PAGES  Move horizontally by pages.

enum Xfc::Gtk::NotebookTab

NotebookTab defines the notebook tab which received the focus when a home or end key is pressed on the keyboard.

Enumerator:
NOTEBOOK_TAB_FIRST  The first tab in the notebook page list (GDK_Home or GDK_KP_Home).
NOTEBOOK_TAB_LAST  The last tab in the notebook page list (GKD_End or GDK_KP_End).

enum Xfc::Gtk::Orientation

Used by Range and Toolbar to indicate the orientation of the widget.

Also used in Style to indicate the orientation of the widget to draw (e.g. draw_slider(), draw_handle()).

Enumerator:
ORIENTATION_HORIZONTAL  Horizontal orientation.
ORIENTATION_VERTICAL  Vertical orientation.

enum Xfc::Gtk::PackType

Represents the packing location of Box children (see VBox, HBox and ButtonBox).

Enumerator:
PACK_START  The child is packed into the start of the box.
PACK_END  The child is packed into the end of the box.

enum Xfc::Gtk::PolicyType

Determines when a scroll bar will be visible.

Enumerator:
POLICY_ALWAYS  The scrollbar is always visible.
POLICY_AUTOMATIC  The scrollbar will appear and disappear as necessary.
POLICY_NEVER  The scrollbar will never appear.

enum Xfc::Gtk::PositionType

Indicates edge position.

Used by HandleBox, Notebook and Scale widgets, and the Style "draw" methods.

Enumerator:
POS_LEFT  Position left.
POS_RIGHT  Position right.
POS_TOP  Position top.
POS_BOTTOM  Position bottom.

enum Xfc::Gtk::ProgressBarOrientation

Represents the possible orientations and growth directions for the visible progress bar.

Enumerator:
PROGRESS_LEFT_TO_RIGHT  A horizontal progress bar growing from left to right.
PROGRESS_RIGHT_TO_LEFT  A horizontal progress bar growing from right to left.
PROGRESS_BOTTOM_TO_TOP  A vertical progress bar growing from bottom to top.
PROGRESS_TOP_TO_BOTTOM  A vertical progress bar growing from top to bottom.

enum Xfc::Gtk::ReliefStyle

Specifies the relief style of the edges a Button.

Enumerator:
RELIEF_NORMAL  Normal edge thickness.
RELIEF_HALF  Half the normal edge thickness.
RELIEF_NONE  No edge.

enum Xfc::Gtk::ResizeMode

Determines whether a resize request will be passed to a container's parent, queued for later execution or executed immediately.

Enumerator:
RESIZE_PARENT  Pass resize request to the parent.
RESIZE_QUEUE  Queue resizes on this widget.
RESIZE_IMMEDIATE  Perform the resizes now.

enum Xfc::Gtk::ResponseType

Used to indicate the response_id of the action widget.

Enumerator:
RESPONSE_NONE  The action widget has no response_id.
RESPONSE_REJECT  Returned only if passed as the response for the action widget.
RESPONSE_ACCEPT  Returned only if passed as the response for the action widget.
RESPONSE_DELETE_EVENT  The dialog received a 'delete' event.
RESPONSE_OK  The OK response, when the action widget is clicked.
RESPONSE_CANCEL  The cancel response, when the action widget is clicked.
RESPONSE_CLOSE  The close response, when the action widget is clicked.
RESPONSE_YES  The yes response, when the action widget is clicked.
RESPONSE_NO  The no response, when the action widget is clicked.
RESPONSE_APPLY  The apply response, when the action widget is clicked.
RESPONSE_HELP  The help response, when the action widget is clicked.

enum Xfc::Gtk::ScrollType

Passed as a signal argument by Range, Scrollbar, SpinButton and ScrolledWindow widgets to indicate the way the user has moved the slider or thumb.

Enumerator:
SCROLL_NONE  No thumb movement.
SCROLL_JUMP  Used by CList, which is deprecated.
SCROLL_STEP_BACKWARD  The thumb moved backwards by a small amount in response to a mouse click on the arrow at the top of a scrollbar.
SCROLL_STEP_FORWARD  The thumb moved forwards by a small amount in response to a mouse click on the arrow at the bottom of a scrollbar.
SCROLL_PAGE_BACKWARD  The thumb moved backwards by a large amount in response to a mouse click in the trough between the thumb and the top arrow.
SCROLL_PAGE_FORWARD  The thumb moved forwards by a large amount in response to a mouse click in the trough between the thumb and the bottom arrow.
SCROLL_STEP_UP  Same as SCROLL_STEP_BACKWARD.
SCROLL_STEP_DOWN  Same as SCROLL_STEP_FORWARD.
SCROLL_PAGE_UP  Same as SCROLL_PAGE_BACKWARD.
SCROLL_PAGE_DOWN  Same as SCROLL_PAGE_FORWARD.
SCROLL_STEP_LEFT  Same as SCROLL_STEP_BACKWARD.
SCROLL_STEP_RIGHT  Same as SCROLL_STEP_FORWARD.
SCROLL_PAGE_LEFT  Same as SCROLL_PAGE_BACKWARD.
SCROLL_PAGE_RIGHT  Same as SCROLL_PAGE_FORWARD.
SCROLL_START  The user has started to scroll the thumb.
SCROLL_END  The user has finished scrolling the thumb.

enum Xfc::Gtk::SelectionMode

Specifies the selection mode for a TreeView widget.

This allows you to set whether only one or more than one item can be selected at a time. Note that setting the widget's selection mode to one of SELECTION_BROWSE or SELECTION_SINGLE will cause all the items in the TreeView to become deselected.

Enumerator:
SELECTION_NONE  No selection.
SELECTION_SINGLE  The user can select only one item at a time; When you click and drag the mouse, only the focus changes; The selection changes only when the mouse button is released on the same item it was pressed on.
SELECTION_BROWSE  The user can select only one item at a time; The selection changes when the mouse button is pressed, not when it's released; When you click and drag the mouse, both the focus and the selection change.
SELECTION_MULTIPLE  The user can select multiple items at the same time.
SELECTION_EXTENDED  Not used any longer.

enum Xfc::Gtk::ShadowType

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

Enumerator:
SHADOW_NONE  No outline.
SHADOW_IN  The outline is bevelled inwards.
SHADOW_OUT  The outline is bevelled outwards like a button.
SHADOW_ETCHED_IN  The outline itself is an inward bevel.
SHADOW_ETCHED_OUT  The outline itself is an outward bevel.

enum Xfc::Gtk::SizeGroupMode

The mode of the size group determines the directions in which the size group effects the requested sizes of its component widgets.

Enumerator:
SIZE_GROUP_NONE  Group has no effect.
SIZE_GROUP_HORIZONTAL  Group effects horizontal requisition.
SIZE_GROUP_VERTICAL  Group effects vertical requisition.
SIZE_GROUP_BOTH  Group effects both horizontal and vertical requisition.

enum Xfc::Gtk::SortType

Determines the direction of a sort.

Enumerator:
SORT_ASCENDING  Sorting is in ascending order.
SORT_DESCENDING  Sorting is in descending order.

enum Xfc::Gtk::SourceSearchFlags

Specifies how a source iterator should search through a source buffer for a text string.

Enumerator:
SOURCE_SEARCH_VISIBLE_ONLY  The matching text may have invisible text interspersed in it, that is, the text may possibly be a noncontiguous subsequence of the matched range.
SOURCE_SEARCH_TEXT_ONLY  The matching text may have pixbufs or child widgets mixed inside the matched range.
SOURCE_SEARCH_CASE_INSENSITIVE  The text will be matched regardless of what case it is in.

enum Xfc::Gtk::SpinButtonUpdatePolicy

SpinButtonUpdatePolicy determines how the spin button should be updated.

Enumerator:
UPDATE_ALWAYS  When refreshing your SpinButton, the value is always displayed.
UPDATE_IF_VALID  When refreshing your SpinButton, the value is only displayed if it is valid within the bounds of the spin button's Adjustment.

enum Xfc::Gtk::SpinType

SpinType defines the types of spin movement that can occur.

The ammount of spin is defined by the spin buttons adjustment.

Enumerator:
SPIN_STEP_FORWARD  Spin forward by one step value.
SPIN_STEP_BACKWARD  Spin backward by one step value.
SPIN_PAGE_FORWARD  Spin forward by one page value.
SPIN_PAGE_BACKWARD  Spin backward by one page value.
SPIN_HOME  Spin to the minimum value.
SPIN_END  Spin to maximum value.
SPIN_USER_DEFINED  Spin by an ammount specified by the user.

enum Xfc::Gtk::StateType

This type indicates the current state of a widget; the state determines how the widget is drawn.

The StateType enumeration is also used to identify different colors in a Style for drawing, so states can be used for subparts of a widget as well as entire widgets.

Enumerator:
STATE_NORMAL  State during normal operation.
STATE_ACTIVE  State of a currently active widget, such as a depressed button.
STATE_PRELIGHT  State indicating that the mouse pointer is over the widget and the widget responds to mouse clicks.
STATE_SELECTED  State of a selected item, such the selected row in a list.
STATE_INSENSITIVE  State indicating that the widget is unresponsive to user actions.

enum Xfc::Gtk::StockButtonType

Used to indicate a stock button and response_id to add to the dialog.

Enumerator:
STOCK_BUTTON_OK  A stock OK button that returns the id Gtk::RESPONSE_OK.
STOCK_BUTTON_CANCEL  A stock CANCEL button that returns the id Gtk::RESPONSE_CANCEL.
STOCK_BUTTON_CLOSE  A stock CLOSE button that returns the id Gtk::RESPONSE_CLOSE.
STOCK_BUTTON_YES  A stock YES button that returns the id Gtk::RESPONSE_YES.
STOCK_BUTTON_NO  A stock NO button that returns the id Gtk::RESPONSE_NO.
STOCK_BUTTON_APPLY  A stock APPLY button that returns the id Gtk::RESPONSE_APPLY.
STOCK_BUTTON_HELP  A stock HELP button that returns the id Gtk::RESPONSE_HELP.

enum Xfc::Gtk::TargetFlags

Specifies the constraints on an entry in a TargetTable.

Enumerator:
TARGET_SAME_APP  If this is set, the target will only be selected for drags within a single application.
TARGET_SAME_WIDGET  If this is set, the target will only be selected for drags within a single widget.

enum Xfc::Gtk::TextDirection

Text direction (right-to-left or left-to-right).

Enumerator:
TEXT_DIR_NONE  In TextLayout, means means draw cursors for both left-to-right and right-to-left insertion.
TEXT_DIR_LTR  Text direction left-to-right.
TEXT_DIR_RTL  Text direction right-to-left.

enum Xfc::Gtk::TextSearchFlags

TextSearchFlags is used to specify how a text iterator should search through a text buffer for a text string.

Enumerator:
TEXT_SEARCH_VISIBLE_ONLY  The matching text may have invisible text interspersed in it, that is, the text may possibly be a noncontiguous subsequence of the matched range.
TEXT_SEARCH_TEXT_ONLY  The matching text may have pixbufs or child widgets mixed inside the matched range.

enum Xfc::Gtk::TextWindowType

TextWindowType indentifies the possible windows that correspond to an area of the text view.

These are the overall widget window, the border windows on the left, right, top, bottom, and the window that displays the text buffer.

Enumerator:
TEXT_WINDOW_PRIVATE  Private.
TEXT_WINDOW_WIDGET  The overall widget window.
TEXT_WINDOW_TEXT  The window displaying the text buffer.
TEXT_WINDOW_LEFT  The border window on the left.
TEXT_WINDOW_RIGHT  The border window on the right.
TEXT_WINDOW_TOP  The border window on the top.
TEXT_WINDOW_BOTTOM  The border window on the bottom.

enum Xfc::Gtk::ToolbarStyle

ToolbarStyle is used to customize the appearance of a Toolbar.

Note that setting the toolbar style overrides the user's preferences for the default toolbar style.

Enumerator:
TOOLBAR_ICONS  Buttons display only icons in the toolbar.
TOOLBAR_TEXT  Buttons display only text labels in the toolbar.
TOOLBAR_BOTH  Buttons display text and icons in the toolbar.
TOOLBAR_BOTH_HORIZ  Buttons display icons and text alongside each other, rather than vertically stacked.

enum Xfc::Gtk::TreeModelFlags

These flags indicate various properties of a TreeModel.

They are returned by Gtk::TreeModel::get_flags(), and must be static for the lifetime of the object. A more complete description of TREE_MODEL_ITERS_PERSIST can be found in the TreeModel desription.

Enumerator:
TREE_MODEL_ITERS_PERSIST  Iterators survive all signals emitted by the tree.
TREE_MODEL_LIST_ONLY  The model is a list only, and never has children.

enum Xfc::Gtk::TreeViewColumnSizing

TreeViewColumnSizing defines the sizing method a column uses to determine it's width.

Please note that TREE_VIEW_COLUMN_AUTOSIZE is inefficient for large views, and can make columns appear choppy.

Enumerator:
TREE_VIEW_COLUMN_GROW_ONLY  Columns only get bigger in reaction to changes in the model.
TREE_VIEW_COLUMN_AUTOSIZE  Columns resize to be the optimal size everytime the model changes.
TREE_VIEW_COLUMN_FIXED  Columns are a fixed numbers of pixels wide.

enum Xfc::Gtk::TreeViewDropPosition

TreeViewDropPosition is used to determine where a dropped row goes.

Enumerator:
TREE_VIEW_DROP_BEFORE  Drop before this row.
TREE_VIEW_DROP_AFTER  Drop after this row.
TREE_VIEW_DROP_INTO_OR_BEFORE  Drop as a child of this row (with fallback to before if into is not possible).
TREE_VIEW_DROP_INTO_OR_AFTER  Drop as a child of this row (with fallback to after if into is not possible).

enum Xfc::Gtk::UIManagerItemType

Item type values used by Gtk::UIManager::add_ui() to determine what UI element to create.

Enumerator:
UI_MANAGER_AUTO  Pick the type of the UI element according to context.
UI_MANAGER_MENUBAR  Create a menubar.
UI_MANAGER_MENU  Create a menu.
UI_MANAGER_TOOLBAR  Create a toolbar.
UI_MANAGER_PLACEHOLDER  Insert a placeholder.
UI_MANAGER_POPUP  Create a popup menu.
UI_MANAGER_MENUITEM  Create a menuitem.
UI_MANAGER_TOOLITEM  Create a toolitem.
UI_MANAGER_SEPARATOR  Create a separator.
UI_MANAGER_ACCELERATOR  Install an accelerator.

enum Xfc::Gtk::UpdateType

Used by Range widgets to set the update policy for the range.

Enumerator:
UPDATE_CONTINUOUS  Anytime the range slider is moved, the range value will change and the "value_changed" signal will be emitted.
UPDATE_DISCONTINUOUS  The range value will only be updated when the user releases the button and ends the slider drag operation.
UPDATE_DELAYED  The range value will be updated after a brief timeout where no slider motion occurs, so updates are spaced by a short time rather than continuous.

enum Xfc::Gtk::WidgetFlags

WidgetFlags tells about certain properties of the widget.

Enumerator:
TOP_LEVEL  Widgets without a real parent, such as Windows and Menus have this flag set throughout their lifetime; Toplevel widgets always contain their own Gdk::Window.
NO_WINDOW  Indicative for a widget that does not provide its own Gdk::Window; For such widgets, visible actions (such as drawing) are performed on the parent's Gdk::Window.
REALIZED  Set by realize(), unset by unrealize(); A realized widget has an associated Gdk::Window.
MAPPED  Set by map(), unset by unmap(); Only realized widgets can be mapped; It means that show() has been called on the widgets window(s).
VISIBLE  Set by show(), unset by hide(); Implies that a widget will be mapped as soon as its parent is mapped.
SENSITIVE  Set and unset by set_sensitive(); The sensitivity of a widget determines whether it will receive certain events (such as button or key presses); One premise for the widget's sensitivity is to have this flag set.
PARENT_SENSITIVE  Set and unset by set_sensitive() operations on the parents of the widget; This is the second premise for the widget's sensitivity; Once it has SENSITIVE and PARENT_SENSITIVE set, its state is effectively sensitive and Gtk::Widget::is_sensitive() will return true.
CAN_FOCUS  Determines whether a widget is able to handle focus grabs.
HAS_FOCUS  Set by grab_focus() for widgets that also have CAN_FOCUS set; This flag will be unset once another widget grabs the focus.
CAN_DEFAULT  The widget is allowed to receive the default action via grab_default().
HAS_DEFAULT  The widget currently is receiving the default action.
HAS_GRAB  Set by gtk_grab_add(), unset by gtk_grab_remove(); It means that the widget is in the grab_widgets stack, and will be the preferred one for receiving events other than ones of cosmetic value.
RC_STYLE  Indicates that the widgets style has been looked up through the rc mechanism; It does not imply that the widget actually had a style defined through the rc mechanism.
COMPOSITE_CHILD  Indicates that the widget is a composite child of its parent; see push_composite_child(), pop_composite_child().
NO_REPARENT  Unused since before GTK+ 1.2, will be removed in a future version.
APP_PAINTABLE  Set and unset by set_app_paintable(); Must be set on widgets whose window the application directly draws on, in order to keep GTK+ from overwriting the drawn stuff.
RECEIVES_DEFAULT  The widget when focused will receive the default action and have HAS_DEFAULT set even if there is a different widget set as default.
DOUBLE_BUFFERED  Set and unset by set_double_buffered(); Indicates that exposes done on the widget should be double-buffered.
NO_SHOW_ALL  The "no_show_all" property, which determines whether calls to show_all() and hide_all() will affect this widget (see Gtk::Widget::set_no_show_all()).

enum Xfc::Gtk::WidgetHelpType

WidgetHelpType defines the type of help, either tooltip or "What's this".

Enumerator:
WIDGET_HELP_TOOLTIP  Tooltip help.
WIDGET_HELP_WHATS_THIS  "What's this" help.

enum Xfc::Gtk::WindowPosition

Window placement can be influenced using this enumeration.

Enumerator:
WIN_POS_NONE  No influence is made on placement.
WIN_POS_CENTER  Windows should be placed in the center of the screen.
WIN_POS_MOUSE  Windows should be placed at the current mouse position.
WIN_POS_CENTER_ALWAYS  Keep window centered as it changes size, etc.
WIN_POS_CENTER_ON_PARENT  Center the window on its transient parent.

enum Xfc::Gtk::WindowType

Specifies the window type to create.

Enumerator:
WINDOW_TOPLEVEL  Windows with type WINDOW_TOPLEVEL (main windows, dialogs) are managed by the window manager and have a frame by default (nearly all windows should be WINDOW_TOPLEVEL).
WINDOW_POPUP  Windows with type WINDOW_POPUP (menus, tooltips) are ignored by the window manager, window manager keybindings won't work on them, the window manager won't decorate the window with a frame, and many GTK+ features that rely on the window manager will not work (such as resize grips, maximization and minimization).

enum Xfc::Gtk::WrapMode

Describes how to wrap the lines of a Layout to the desired width.

In the ellipsization process characters are removed from the text in order to make it fit to a given width and replaced with an ellipsis.

Enumerator:
WRAP_NONE  Do not wrap lines; just make the text area wider.
WRAP_CHAR  Wrap text, breaking lines anywhere the cursor can appear (between characters, usually - if you want to be technical, between graphemes, see Pango::LogAttr::get_log_attrs()).
WRAP_WORD  Wrap text, breaking lines in between words.
WRAP_WORD_CHAR  Wrap text, breaking lines in between words, or if that is not enough, also between graphemes.


Function Documentation

bool Xfc::Gtk::accel_groups_activate ( G::Object &  object,
const AccelKey &  accel_key 
)

Finds the first accelerator in any AccelGroup attached to object that matches the key value and modifiers, and activates that accelerator.

Parameters:
object The G::Object, usually a Gtk::Window, on which to activate the accelerator.
accel_key An AccelKey specifying the accelerator key value and modifiers.
Returns:
true if an accelerator was activated and handled this keypress.

Gdk::ModifierTypeField Xfc::Gtk::accelerator_get_default_mod_mask (  ) 

Gets the value set by set_default_mod_mask().

Returns:
The default accelerator modifier mask.

String Xfc::Gtk::accelerator_get_label ( unsigned int  accelerator_key,
Gdk::ModifierType  accelerator_mods 
)

Converts an accelerator key value and modifier mask into a string which can be used to represent the accelerator to the user.

Parameters:
accelerator_key The accelerator key value.
accelerator_mods The accelerator modifier mask.
Returns:
A String representing the accelerator.

String Xfc::Gtk::accelerator_name ( const AccelKey &  accel_key  ) 

Converts an AccelKey's key value and modifier mask into a string parseable by parse().

Parameters:
accel_key An AccelKey specifying the accelerator key value and modifiers.
Returns:
The accelerator name.
For example, if you pass in GDK_q and Gdk::CONTROL_MASK, this function returns "\<Control\>q".

AccelKey Xfc::Gtk::accelerator_parse ( const String &  accelerator,
AccelFlagsField  accel_flags = Gtk::ACCEL_VISIBLE 
)

Construct an AccelKey from a string representing an accelerator.

Parameters:
accelerator A string representing an accelerator.
accel_flags A flag mask to configure this accelerator.
Returns:
accel_key An AccelKey specifying the accelerator key value and modifiers.
Parses a string representing an accelerator. The format looks like "\<Control\>a" or "\<Shift\>\<Alt\>F1" or "\<Release\>z" (the last one is for key release). The parser is fairly liberal and allows lower or upper case, and also abbreviations such as "\<Ctl\>" and "\<Ctrl\>". If the parse fails, accelerator and its modifiers will be set to 0 (zero).

void Xfc::Gtk::accelerator_set_default_mod_mask ( Gdk::ModifierTypeField  default_mod_mask  ) 

Sets the modifiers that will be considered significant for keyboard accelerators.

Parameters:
default_mod_mask Accelerator modifier mask.
The default mod mask is GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK, that is, Control, Shift, and Alt. Other modifiers will by default be ignored by AccelGroup. You must include at least the three default modifiers in any value you pass to this method.

The default mod mask should be changed on application startup, before using any accelerator groups.

bool Xfc::Gtk::accelerator_valid ( const AccelKey &  accel_key  ) 

Determines whether a given AccelKey is a valid keyboard accelerator.

Parameters:
accel_key An AccelKey specifying the accelerator key value and modifiers.
Returns:
true if the accelerator is valid.
For example, the GDK_a keyval plus Gdk::CONTROL_MASK is valid this is a "Ctrl+a" accelerator. But, you can't, for instance, use the GDK_Control_L key value as an accelerator.

void Xfc::Gtk::draw_insertion_cursor ( Widget &  widget,
Gdk::Drawable &  drawable,
const Gdk::Rectangle &  location,
bool  is_primary,
TextDirection  direction,
bool  draw_arrow,
const Gdk::Rectangle *  area = 0 
)

Draws a text caret on a drawable at the specified location.

Parameters:
widget A Gtk::Widget.
drawable A Gdk::Drawable owned by widget.
location The location where to draw the cursor (location.width() is ignored).
is_primary If the cursor should be the primary cursor color.
direction Whether the cursor is left-to-right or right-to-left (should never be Gtk::TEXT_DIR_NONE).
draw_arrow Whether a directional arrow should be drawn on the cursor. .
area The rectangle to which the output is clipped, or null if the output should not be clipped.
This method is not a style function but merely a convenience function for drawing the standard cursor shape. The text direction should never be Gtk::TEXT_DIR_NONE. The draw_arrow parameter should be false unless the cursor is split.

IconSize Xfc::Gtk::icon_size_from_name ( const String &  name  ) 

Looks up the icon size associated with name.

Parameters:
name The name to look up.
Returns:
The icon size with the given name.

String Xfc::Gtk::icon_size_get_name ( IconSize  size  ) 

Gets the canonical name of the given icon size.

Parameters:
size An IconSize.
Returns:
The name of the given icon size.

bool Xfc::Gtk::icon_size_lookup ( IconSize  size,
int *  width,
int *  height,
Settings *  settings = 0 
)

Obtains the pixel size of a semantic icon size, possibly modified by user preferences for a particular Settings.

Parameters:
size An icon size.
width The location to store icon width.
height The location to store icon height.
settings A Settings object, used to determine which set of user preferences to use, or null to use the settings for the default screen.
Returns:
true if size was a valid size.
Normally size would be ICON_SIZE_MENU, ICON_SIZE_BUTTON, etc. This method isn't normally needed, Gtk::Widget::render_icon() is the usual way to get an icon for rendering, then just look at the size of the rendered pixbuf. The rendered pixbuf may not even correspond to the width/height returned by size_lookup(), because themes are free to render the pixbuf however they like, including changing the usual size.

Note: The default GDK screen is the only screen in the absence of MultiHead support.

IconSize Xfc::Gtk::icon_size_register ( const String &  name,
int  width,
int  height 
)

Registers a new icon size, along the same lines as ICON_SIZE_MENU, etc.

Parameters:
name The name of the icon size.
width The icon width.
height The icon height.
Returns:
The integer value for the size, as an IconSize.

void Xfc::Gtk::icon_size_register_alias ( const String &  alias,
IconSize  target 
)

Registers alias as another name for target.

Parameters:
alias An alias for target.
target An existing icon size.
Calling size_from_name() with alias as the argument will return target.

Xfce Foundation Classes


Copyright © 2004-2005 The XFC Development Team XFC 4.3