gtkmm: gtkmm Enums and Flags
Classes | |
| class | Gtk::ResponseType_Wrapper |
| Wrapper for enum ResponseType. More... | |
Typedefs | |
| using | Gtk::ResponseType = ResponseType_Wrapper::ResponseType |
| ResponseType enumerators are scoped by the wrapper class and can be implicitly converted to int. More... | |
Functions | |
| Application::InhibitFlags | Gtk::operator| (Application::InhibitFlags lhs, Application::InhibitFlags rhs) |
| Application::InhibitFlags | Gtk::operator& (Application::InhibitFlags lhs, Application::InhibitFlags rhs) |
| Application::InhibitFlags | Gtk::operator^ (Application::InhibitFlags lhs, Application::InhibitFlags rhs) |
| Application::InhibitFlags | Gtk::operator~ (Application::InhibitFlags flags) |
| Application::InhibitFlags& | Gtk::operator|= (Application::InhibitFlags& lhs, Application::InhibitFlags rhs) |
| Application::InhibitFlags& | Gtk::operator&= (Application::InhibitFlags& lhs, Application::InhibitFlags rhs) |
| Application::InhibitFlags& | Gtk::operator^= (Application::InhibitFlags& lhs, Application::InhibitFlags rhs) |
| Calendar::DisplayOptions | Gtk::operator| (Calendar::DisplayOptions lhs, Calendar::DisplayOptions rhs) |
| Calendar::DisplayOptions | Gtk::operator& (Calendar::DisplayOptions lhs, Calendar::DisplayOptions rhs) |
| Calendar::DisplayOptions | Gtk::operator^ (Calendar::DisplayOptions lhs, Calendar::DisplayOptions rhs) |
| Calendar::DisplayOptions | Gtk::operator~ (Calendar::DisplayOptions flags) |
| Calendar::DisplayOptions& | Gtk::operator|= (Calendar::DisplayOptions& lhs, Calendar::DisplayOptions rhs) |
| Calendar::DisplayOptions& | Gtk::operator&= (Calendar::DisplayOptions& lhs, Calendar::DisplayOptions rhs) |
| Calendar::DisplayOptions& | Gtk::operator^= (Calendar::DisplayOptions& lhs, Calendar::DisplayOptions rhs) |
| CellRendererState | Gtk::operator| (CellRendererState lhs, CellRendererState rhs) |
| CellRendererState | Gtk::operator& (CellRendererState lhs, CellRendererState rhs) |
| CellRendererState | Gtk::operator^ (CellRendererState lhs, CellRendererState rhs) |
| CellRendererState | Gtk::operator~ (CellRendererState flags) |
| CellRendererState& | Gtk::operator|= (CellRendererState& lhs, CellRendererState rhs) |
| CellRendererState& | Gtk::operator&= (CellRendererState& lhs, CellRendererState rhs) |
| CellRendererState& | Gtk::operator^= (CellRendererState& lhs, CellRendererState rhs) |
| AccelFlags | Gtk::operator| (AccelFlags lhs, AccelFlags rhs) |
| AccelFlags | Gtk::operator& (AccelFlags lhs, AccelFlags rhs) |
| AccelFlags | Gtk::operator^ (AccelFlags lhs, AccelFlags rhs) |
| AccelFlags | Gtk::operator~ (AccelFlags flags) |
| AccelFlags& | Gtk::operator|= (AccelFlags& lhs, AccelFlags rhs) |
| AccelFlags& | Gtk::operator&= (AccelFlags& lhs, AccelFlags rhs) |
| AccelFlags& | Gtk::operator^= (AccelFlags& lhs, AccelFlags rhs) |
| PlacesOpenFlags | Gtk::operator| (PlacesOpenFlags lhs, PlacesOpenFlags rhs) |
| PlacesOpenFlags | Gtk::operator& (PlacesOpenFlags lhs, PlacesOpenFlags rhs) |
| PlacesOpenFlags | Gtk::operator^ (PlacesOpenFlags lhs, PlacesOpenFlags rhs) |
| PlacesOpenFlags | Gtk::operator~ (PlacesOpenFlags flags) |
| PlacesOpenFlags& | Gtk::operator|= (PlacesOpenFlags& lhs, PlacesOpenFlags rhs) |
| PlacesOpenFlags& | Gtk::operator&= (PlacesOpenFlags& lhs, PlacesOpenFlags rhs) |
| PlacesOpenFlags& | Gtk::operator^= (PlacesOpenFlags& lhs, PlacesOpenFlags rhs) |
| TargetFlags | Gtk::operator| (TargetFlags lhs, TargetFlags rhs) |
| TargetFlags | Gtk::operator& (TargetFlags lhs, TargetFlags rhs) |
| TargetFlags | Gtk::operator^ (TargetFlags lhs, TargetFlags rhs) |
| TargetFlags | Gtk::operator~ (TargetFlags flags) |
| TargetFlags& | Gtk::operator|= (TargetFlags& lhs, TargetFlags rhs) |
| TargetFlags& | Gtk::operator&= (TargetFlags& lhs, TargetFlags rhs) |
| TargetFlags& | Gtk::operator^= (TargetFlags& lhs, TargetFlags rhs) |
| StateFlags | Gtk::operator| (StateFlags lhs, StateFlags rhs) |
| StateFlags | Gtk::operator& (StateFlags lhs, StateFlags rhs) |
| StateFlags | Gtk::operator^ (StateFlags lhs, StateFlags rhs) |
| StateFlags | Gtk::operator~ (StateFlags flags) |
| StateFlags& | Gtk::operator|= (StateFlags& lhs, StateFlags rhs) |
| StateFlags& | Gtk::operator&= (StateFlags& lhs, StateFlags rhs) |
| StateFlags& | Gtk::operator^= (StateFlags& lhs, StateFlags rhs) |
| InputHints | Gtk::operator| (InputHints lhs, InputHints rhs) |
| InputHints | Gtk::operator& (InputHints lhs, InputHints rhs) |
| InputHints | Gtk::operator^ (InputHints lhs, InputHints rhs) |
| InputHints | Gtk::operator~ (InputHints flags) |
| InputHints& | Gtk::operator|= (InputHints& lhs, InputHints rhs) |
| InputHints& | Gtk::operator&= (InputHints& lhs, InputHints rhs) |
| InputHints& | Gtk::operator^= (InputHints& lhs, InputHints rhs) |
| FileFilter::Flags | Gtk::operator| (FileFilter::Flags lhs, FileFilter::Flags rhs) |
| FileFilter::Flags | Gtk::operator& (FileFilter::Flags lhs, FileFilter::Flags rhs) |
| FileFilter::Flags | Gtk::operator^ (FileFilter::Flags lhs, FileFilter::Flags rhs) |
| FileFilter::Flags | Gtk::operator~ (FileFilter::Flags flags) |
| FileFilter::Flags& | Gtk::operator|= (FileFilter::Flags& lhs, FileFilter::Flags rhs) |
| FileFilter::Flags& | Gtk::operator&= (FileFilter::Flags& lhs, FileFilter::Flags rhs) |
| FileFilter::Flags& | Gtk::operator^= (FileFilter::Flags& lhs, FileFilter::Flags rhs) |
| IconLookupFlags | Gtk::operator| (IconLookupFlags lhs, IconLookupFlags rhs) |
| IconLookupFlags | Gtk::operator& (IconLookupFlags lhs, IconLookupFlags rhs) |
| IconLookupFlags | Gtk::operator^ (IconLookupFlags lhs, IconLookupFlags rhs) |
| IconLookupFlags | Gtk::operator~ (IconLookupFlags flags) |
| IconLookupFlags& | Gtk::operator|= (IconLookupFlags& lhs, IconLookupFlags rhs) |
| IconLookupFlags& | Gtk::operator&= (IconLookupFlags& lhs, IconLookupFlags rhs) |
| IconLookupFlags& | Gtk::operator^= (IconLookupFlags& lhs, IconLookupFlags rhs) |
| RecentFilter::Flags | Gtk::operator| (RecentFilter::Flags lhs, RecentFilter::Flags rhs) |
| RecentFilter::Flags | Gtk::operator& (RecentFilter::Flags lhs, RecentFilter::Flags rhs) |
| RecentFilter::Flags | Gtk::operator^ (RecentFilter::Flags lhs, RecentFilter::Flags rhs) |
| RecentFilter::Flags | Gtk::operator~ (RecentFilter::Flags flags) |
| RecentFilter::Flags& | Gtk::operator|= (RecentFilter::Flags& lhs, RecentFilter::Flags rhs) |
| RecentFilter::Flags& | Gtk::operator&= (RecentFilter::Flags& lhs, RecentFilter::Flags rhs) |
| RecentFilter::Flags& | Gtk::operator^= (RecentFilter::Flags& lhs, RecentFilter::Flags rhs) |
| TextSearchFlags | Gtk::operator| (TextSearchFlags lhs, TextSearchFlags rhs) |
| TextSearchFlags | Gtk::operator& (TextSearchFlags lhs, TextSearchFlags rhs) |
| TextSearchFlags | Gtk::operator^ (TextSearchFlags lhs, TextSearchFlags rhs) |
| TextSearchFlags | Gtk::operator~ (TextSearchFlags flags) |
| TextSearchFlags& | Gtk::operator|= (TextSearchFlags& lhs, TextSearchFlags rhs) |
| TextSearchFlags& | Gtk::operator&= (TextSearchFlags& lhs, TextSearchFlags rhs) |
| TextSearchFlags& | Gtk::operator^= (TextSearchFlags& lhs, TextSearchFlags rhs) |
| ToolPaletteDragTargets | Gtk::operator| (ToolPaletteDragTargets lhs, ToolPaletteDragTargets rhs) |
| ToolPaletteDragTargets | Gtk::operator& (ToolPaletteDragTargets lhs, ToolPaletteDragTargets rhs) |
| ToolPaletteDragTargets | Gtk::operator^ (ToolPaletteDragTargets lhs, ToolPaletteDragTargets rhs) |
| ToolPaletteDragTargets | Gtk::operator~ (ToolPaletteDragTargets flags) |
| ToolPaletteDragTargets& | Gtk::operator|= (ToolPaletteDragTargets& lhs, ToolPaletteDragTargets rhs) |
| ToolPaletteDragTargets& | Gtk::operator&= (ToolPaletteDragTargets& lhs, ToolPaletteDragTargets rhs) |
| ToolPaletteDragTargets& | Gtk::operator^= (ToolPaletteDragTargets& lhs, ToolPaletteDragTargets rhs) |
| TreeModel::Flags | Gtk::operator| (TreeModel::Flags lhs, TreeModel::Flags rhs) |
| TreeModel::Flags | Gtk::operator& (TreeModel::Flags lhs, TreeModel::Flags rhs) |
| TreeModel::Flags | Gtk::operator^ (TreeModel::Flags lhs, TreeModel::Flags rhs) |
| TreeModel::Flags | Gtk::operator~ (TreeModel::Flags flags) |
| TreeModel::Flags& | Gtk::operator|= (TreeModel::Flags& lhs, TreeModel::Flags rhs) |
| TreeModel::Flags& | Gtk::operator&= (TreeModel::Flags& lhs, TreeModel::Flags rhs) |
| TreeModel::Flags& | Gtk::operator^= (TreeModel::Flags& lhs, TreeModel::Flags rhs) |
| DestDefaults | Gtk::operator| (DestDefaults lhs, DestDefaults rhs) |
| DestDefaults | Gtk::operator& (DestDefaults lhs, DestDefaults rhs) |
| DestDefaults | Gtk::operator^ (DestDefaults lhs, DestDefaults rhs) |
| DestDefaults | Gtk::operator~ (DestDefaults flags) |
| DestDefaults& | Gtk::operator|= (DestDefaults& lhs, DestDefaults rhs) |
| DestDefaults& | Gtk::operator&= (DestDefaults& lhs, DestDefaults rhs) |
| DestDefaults& | Gtk::operator^= (DestDefaults& lhs, DestDefaults rhs) |
| PrintCapabilities | Gtk::operator| (PrintCapabilities lhs, PrintCapabilities rhs) |
| PrintCapabilities | Gtk::operator& (PrintCapabilities lhs, PrintCapabilities rhs) |
| PrintCapabilities | Gtk::operator^ (PrintCapabilities lhs, PrintCapabilities rhs) |
| PrintCapabilities | Gtk::operator~ (PrintCapabilities flags) |
| PrintCapabilities& | Gtk::operator|= (PrintCapabilities& lhs, PrintCapabilities rhs) |
| PrintCapabilities& | Gtk::operator&= (PrintCapabilities& lhs, PrintCapabilities rhs) |
| PrintCapabilities& | Gtk::operator^= (PrintCapabilities& lhs, PrintCapabilities rhs) |
Detailed Description
Typedef Documentation
| using Gtk::ResponseType = typedef ResponseType_Wrapper::ResponseType |
ResponseType enumerators are scoped by the wrapper class and can be implicitly converted to int.
Enumeration Type Documentation
|
strong |
Accelerator flags used with Gtk::AccelGroup::connect().
- Bitwise operators:
AccelFlags operator|(AccelFlags, AccelFlags)
AccelFlags operator&(AccelFlags, AccelFlags)
AccelFlags operator^(AccelFlags, AccelFlags)
AccelFlags operator~(AccelFlags)
AccelFlags& operator|=(AccelFlags&, AccelFlags)
AccelFlags& operator&=(AccelFlags&, AccelFlags)
AccelFlags& operator^=(AccelFlags&, AccelFlags)
| Enumerator | |
|---|---|
| VISIBLE |
Accelerator is visible. |
| LOCKED |
Accelerator not removable. |
| MASK |
Mask. |
|
strong |
Describes whether a Gtk::FileChooser is being used to open existing files or to save to a possibly new file.
|
strong |
Controls how a widget deals with extra space in a single (x or y) dimension.
Alignment only matters if the widget receives a “too large” allocation, for example if you packed the widget with the Gtk::Widget::property_expand() flag inside a Gtk::Box, then the widget might get extra space. If you have for example a 16x16 icon inside a 32x32 space, the icon could be scaled and stretched, it could be centered, or it could be positioned to one side of the space.
Note that in horizontal context GTK_ALIGN_START and GTK_ALIGN_END are interpreted relative to text direction.
GTK_ALIGN_BASELINE support for it is optional for containers and widgets, and it is only supported for vertical alignment. When its not supported by a child or a container it is treated as GTK_ALIGN_FILL.
|
strong |
Used to indicate the direction in which an arrow should point.
| Enumerator | |
|---|---|
| UP |
Represents an upward pointing arrow. Panned upwards. Move up. |
| DOWN |
Represents a downward pointing arrow. Panned downwards. Move down. |
| LEFT |
Represents a left pointing arrow. Left side border window. Panned towards the left. The feature is at the left edge. The text is placed at the left edge of the label. Move left. |
| RIGHT |
Represents a right pointing arrow. Right side border window. Panned towards the right. The feature is at the right edge. The text is placed at the right edge of the label. Move right. |
| NONE |
No arrow. Do not sort the returned list of recently used resources. No units. No buttons at all. The sequence is handled, but not grabbed. Events are not delivered automatically. No special behaviour suggested. Do not wrap lines; just make the text area wider. No influence is made on placement. No outline. No selection is possible. No scrolling. No transition. No relief. No direction. Those can be manually fed through Gtk::EventController::handle_event(). This should only be used when full control about when, or whether the controller handles the event is needed. |
|
strong |
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 Gtk::BaselinePosition to select where to put the baseline inside the extra availible space.
| Enumerator | |
|---|---|
| TOP | |
| CENTER | |
| BOTTOM | |
|
strong |
Built-in stock icon sizes.
|
strong |
Used to dictate the style that a Gtk::ButtonBox uses to layout the buttons it contains.
| Enumerator | |
|---|---|
| SPREAD |
Buttons are evenly spread across the box. |
| EDGE |
Buttons are placed at the edges of the box. |
| START | |
| END | |
| CENTER | |
| EXPAND |
Buttons expand to fill the box. This entails giving buttons a "linked" appearance, making button sizes homogeneous, and setting spacing to 0 (same as calling Gtk::Box::set_homogeneous() and Gtk::Box::set_spacing() manually). |
|
strong |
The role specifies the desired appearance of a Gtk::ModelButton.
| Enumerator | |
|---|---|
| NORMAL | |
| CHECK |
A check button. |
| RADIO |
A radio button. |
|
strong |
Prebuilt sets of buttons for the dialog.
If none of these choices are appropriate, simply use Gtk::ButtonsType::NONE then call Gtk::Dialog::add_buttons().
Please note that Gtk::ButtonsType::OK, Gtk::ButtonsType::YES_NO and Gtk::ButtonsType::OK_CANCEL are discouraged by the GNOME Human Interface Guidelines.
| Enumerator | |
|---|---|
| NONE | |
| OK |
An OK button. |
| CLOSE |
A Close button. |
| CANCEL |
A Cancel button. |
| YES_NO |
Yes and No buttons. |
| OK_CANCEL |
OK and Cancel buttons. |
|
strong |
Identifies how the user can interact with a particular cell.
|
strong |
Tells how a cell is to be rendered.
- Bitwise operators:
CellRendererState operator|(CellRendererState, CellRendererState)
CellRendererState operator&(CellRendererState, CellRendererState)
CellRendererState operator^(CellRendererState, CellRendererState)
CellRendererState operator~(CellRendererState)
CellRendererState& operator|=(CellRendererState&, CellRendererState)
CellRendererState& operator&=(CellRendererState&, CellRendererState)
CellRendererState& operator^=(CellRendererState&, CellRendererState)
| Enumerator | |
|---|---|
| SELECTED |
The cell is currently selected, and probably has a selection colored background to render to. Widget is selected. |
| PRELIT |
The mouse is hovering over the cell. |
| INSENSITIVE |
The cell is drawn in an insensitive manner. Widget is insensitive. |
| SORTED |
The cell is in a sorted row. |
| FOCUSED |
The cell is in the focus row. Widget has the keyboard focus. |
| EXPANDABLE |
The cell is in a row that can be expanded. |
| EXPANDED |
The cell is in a row that is expanded. |
|
strong |
Used as a return value of handlers for the Gtk::FileChooser::signal_confirm_overwrite() signal of a Gtk::FileChooser.
This value determines whether the file chooser will present the stock confirmation dialog, accept the user’s choice of a filename, or let the user choose another filename.
|
strong |
Specifies which corner a child widget should be placed in when packed into a Gtk::ScrolledWindow.
This is effectively the opposite of where the scroll bars are placed.
|
strong |
See also: Gtk::Entry::signal_delete_from_cursor().
|
strong |
The Gtk::DestDefaults enumeration specifies the various types of action that will be taken on behalf of the user for a drag destination site.
- Bitwise operators:
DestDefaults operator|(DestDefaults, DestDefaults)
DestDefaults operator&(DestDefaults, DestDefaults)
DestDefaults operator^(DestDefaults, DestDefaults)
DestDefaults operator~(DestDefaults)
DestDefaults& operator|=(DestDefaults&, DestDefaults)
DestDefaults& operator&=(DestDefaults&, DestDefaults)
DestDefaults& operator^=(DestDefaults&, DestDefaults)
|
strong |
|
strong |
Gives an indication why a drag operation failed.
The value can by obtained by connecting to the Gtk::Widget::signal_drag_failed() signal.
|
strong |
Describes the state of a Gdk::EventSequence in a Gtk::Gesture.
| Enumerator | |
|---|---|
| NONE | |
| CLAIMED |
The sequence is handled and grabbed. |
| DENIED |
The sequence is denied. |
|
strong |
These flags indicate what parts of a Gtk::FileFilterInfo struct are filled or need to be filled.
- Bitwise operators:
FileFilter::Flags operator|(FileFilter::Flags, FileFilter::Flags)
FileFilter::Flags operator&(FileFilter::Flags, FileFilter::Flags)
FileFilter::Flags operator^(FileFilter::Flags, FileFilter::Flags)
FileFilter::Flags operator~(FileFilter::Flags)
FileFilter::Flags& operator|=(FileFilter::Flags&, FileFilter::Flags)
FileFilter::Flags& operator&=(FileFilter::Flags&, FileFilter::Flags)
FileFilter::Flags& operator^=(FileFilter::Flags&, FileFilter::Flags)
|
strong |
Used to specify options for Gtk::IconTheme::lookup_icon()
- Bitwise operators:
IconLookupFlags operator|(IconLookupFlags, IconLookupFlags)
IconLookupFlags operator&(IconLookupFlags, IconLookupFlags)
IconLookupFlags operator^(IconLookupFlags, IconLookupFlags)
IconLookupFlags operator~(IconLookupFlags)
IconLookupFlags& operator|=(IconLookupFlags&, IconLookupFlags)
IconLookupFlags& operator&=(IconLookupFlags&, IconLookupFlags)
IconLookupFlags& operator^=(IconLookupFlags&, IconLookupFlags)
| Enumerator | |
|---|---|
| NO_SVG |
Never get SVG icons, even if gdk-pixbuf supports them. Cannot be used together with Gtk::IconLookupFlags::FORCE_SVG. |
| FORCE_SVG |
Get SVG icons, even if gdk-pixbuf doesn’t support them. Cannot be used together with Gtk::IconLookupFlags::NO_SVG. |
| USE_BUILTIN |
When passed to Gtk::IconTheme::lookup_icon() includes builtin icons as well as files. For a builtin icon, Gtk::IconInfo::get_filename() is |
| GENERIC_FALLBACK |
Try to shorten icon name at '-' characters before looking at inherited themes. This flag is only supported in functions that take a single icon name. For more general fallback, see Gtk::IconTheme::choose_icon(). |
| FORCE_SIZE |
Always get the icon scaled to the requested size. |
| FORCE_REGULAR |
Try to always load regular icons, even when symbolic icon names are given. |
| FORCE_SYMBOLIC |
Try to always load symbolic icons, even when regular icon names are given. |
| DIR_LTR | |
| DIR_RTL | |
|
strong |
Types of user actions that may be blocked by Gtk::Application::inhibit().
- Bitwise operators:
Application::InhibitFlags operator|(Application::InhibitFlags, Application::InhibitFlags)
Application::InhibitFlags operator&(Application::InhibitFlags, Application::InhibitFlags)
Application::InhibitFlags operator^(Application::InhibitFlags, Application::InhibitFlags)
Application::InhibitFlags operator~(Application::InhibitFlags)
Application::InhibitFlags& operator|=(Application::InhibitFlags&, Application::InhibitFlags)
Application::InhibitFlags& operator&=(Application::InhibitFlags&, Application::InhibitFlags)
Application::InhibitFlags& operator^=(Application::InhibitFlags&, Application::InhibitFlags)
|
strong |
Describes hints that might be taken into account by input methods or applications.
Note that input methods may already tailor their behaviour according to the Gtk::InputPurpose of the entry.
Some common sense is expected when using these flags - mixing GTK_INPUT_HINT_LOWERCASE with any of the uppercase hints makes no sense.
This enumeration may be extended in the future; input methods should ignore unknown values.
- Bitwise operators:
InputHints operator|(InputHints, InputHints)
InputHints operator&(InputHints, InputHints)
InputHints operator^(InputHints, InputHints)
InputHints operator~(InputHints)
InputHints& operator|=(InputHints&, InputHints)
InputHints& operator&=(InputHints&, InputHints)
InputHints& operator^=(InputHints&, InputHints)
|
strong |
Describes primary purpose of the input widget.
This information is useful for on-screen keyboards and similar input methods to decide which keys should be presented to the user.
Note that the purpose is not meant to impose a totally strict rule about allowed characters, and does not replace input validation. It is fine for an on-screen keyboard to let the user override the character set restriction that is expressed by the purpose. The application is expected to validate the entry contents, even if it specified a purpose.
The difference between GTK_INPUT_PURPOSE_DIGITS and GTK_INPUT_PURPOSE_NUMBER is that the former accepts only digits while the latter also some punctuation (like commas or points, plus, minus) and “e” or “E” as in 3.14E+000.
This enumeration may be extended in the future; input methods should interpret unknown values as “free form”.
|
strong |
Used for justifying the text inside a Gtk::Label widget.
(See also Gtk::Alignment).
| Enumerator | |
|---|---|
| LEFT | |
| RIGHT | |
| CENTER | |
| FILL | |
|
strong |
The type of license for an application.
This enumeration can be expanded at later date.
| Enumerator | |
|---|---|
| UNKNOWN |
No license specified. |
| CUSTOM |
A license text is going to be specified by the developer. Sort the returned list using a custom sorting function passed using Gtk::RecentChooser::set_sort_func(). |
| GPL_2_0 |
The GNU General Public License, version 2.0 or later. |
| GPL_3_0 |
The GNU General Public License, version 3.0 or later. |
| LGPL_2_1 |
The GNU Lesser General Public License, version 2.1 or later. |
| LGPL_3_0 |
The GNU Lesser General Public License, version 3.0 or later. |
| BSD |
The BSD standard license. |
| MIT_X11 |
The MIT/X11 standard license. |
| ARTISTIC |
The Artistic License, version 2.0. |
| GPL_2_0_ONLY |
The GNU General Public License, version 2.0 only. |
| GPL_3_0_ONLY |
The GNU General Public License, version 3.0 only. |
| LGPL_2_1_ONLY |
The GNU Lesser General Public License, version 2.1 only. |
| LGPL_3_0_ONLY |
The GNU Lesser General Public License, version 3.0 only. |
| AGPL_3_0 |
The GNU Affero General Public License, version 3.0 or later. |
|
strong |
|
strong |
The mode of the size group determines the directions in which the size group affects the requested sizes of its component widgets.
| Enumerator | |
|---|---|
| NONE |
Group has no effect. |
| HORIZONTAL |
Group affects horizontal requisition. |
| VERTICAL |
Group affects vertical requisition. |
| BOTH |
Group affects both horizontal and vertical requisition. |
|
strong |
|
strong |
Used to determine the layout of pages on a sheet when printing multiple pages per sheet.
|
strong |
Represents the orientation of widgets and other objects which can be switched between horizontal and vertical orientation on the fly, like Gtk::Toolbar or Gtk::GesturePan.
| Enumerator | |
|---|---|
| HORIZONTAL |
The element is in horizontal orientation. Horizontal duplex. |
| VERTICAL |
The element is in vertical orientation. Vertical duplex. |
|
strong |
|
strong |
Packing options for adding child widgets to a Box with pack_start() and pack_end().
|
strong |
Represents the packing location Gtk::Box children.
(See: Gtk::VBox, Gtk::HBox, and Gtk::ButtonBox).
| Enumerator | |
|---|---|
| START | |
| END | |
|
strong |
See also Gtk::PrintSettings::set_orientation().
| Enumerator | |
|---|---|
| PORTRAIT |
Portrait mode. |
| LANDSCAPE |
Landscape mode. |
| REVERSE_PORTRAIT |
Reverse portrait mode. |
| REVERSE_LANDSCAPE |
Reverse landscape mode. |
|
strong |
See also Gtk::PrintJob::set_page_set().
| Enumerator | |
|---|---|
| ALL | |
| EVEN |
Even pages. |
| ODD |
Odd pages. |
|
strong |
Describes the panning direction of a Gtk::GesturePan.
| Enumerator | |
|---|---|
| LEFT | |
| RIGHT | |
| UP | |
| DOWN | |
|
strong |
These flags serve two purposes.
First, the application can call Gtk::PlacesSidebar::set_open_flags() using these flags as a bitmask. This tells the sidebar that the application is able to open folders selected from the sidebar in various ways, for example, in new tabs or in new windows in addition to the normal mode.
Second, when one of these values gets passed back to the application in the Gtk::PlacesSidebar::signal_open_location() signal, it means that the application should open the selected location in the normal way, in a new tab, or in a new window. The sidebar takes care of determining the desired way to open the location, based on the modifier keys that the user is pressing at the time the selection is made.
If the application never calls Gtk::PlacesSidebar::set_open_flags(), then the sidebar will only use Gtk::PlacesOpenFlags::NORMAL in the Gtk::PlacesSidebar::signal_open_location() signal. This is the default mode of operation.
- Bitwise operators:
PlacesOpenFlags operator|(PlacesOpenFlags, PlacesOpenFlags)
PlacesOpenFlags operator&(PlacesOpenFlags, PlacesOpenFlags)
PlacesOpenFlags operator^(PlacesOpenFlags, PlacesOpenFlags)
PlacesOpenFlags operator~(PlacesOpenFlags)
PlacesOpenFlags& operator|=(PlacesOpenFlags&, PlacesOpenFlags)
PlacesOpenFlags& operator&=(PlacesOpenFlags&, PlacesOpenFlags)
PlacesOpenFlags& operator^=(PlacesOpenFlags&, PlacesOpenFlags)
| Enumerator | |
|---|---|
| NORMAL |
This is the default mode that Gtk::PlacesSidebar uses if no other flags are specified. Normal quality. A plain button. State during normal operation. Draw a normal relief. It indicates that the calling application should open the selected location in the normal way, for example, in the folder view beside the sidebar. |
| NEW_TAB |
When passed to Gtk::PlacesSidebar::set_open_flags(), this indicates that the application can open folders selected from the sidebar in new tabs. This value will be passed to the Gtk::PlacesSidebar::signal_open_location() signal when the user selects that a location be opened in a new tab instead of in the standard fashion. |
| NEW_WINDOW |
Similar to GTK_PLACES_OPEN_NEW_TAB, but indicates that the application can open folders in new windows. |
|
strong |
Defines the policy to be used in a scrollable widget when updating the scrolled window adjustments in a given orientation.
| Enumerator | |
|---|---|
| MINIMUM |
Scrollable adjustments are based on the minimum size. |
| NATURAL |
Scrollable adjustments are based on the natural size. |
|
strong |
Determines how the size should be computed to achieve the one of the visibility mode for the scrollbars.
| Enumerator | |
|---|---|
| ALWAYS |
The scrollbar is always visible. The view size is independent of the content. |
| AUTOMATIC |
The scrollbar will appear and disappear as necessary. For example, when all of a Gtk::TreeView can not be seen. |
| NEVER |
The scrollbar should never appear. In this mode the content determines the size. |
| EXTERNAL |
Don't show a scrollbar, but don't force the size to follow the content. This can be used e.g. to make multiple scrolled windows share a scrollbar. |
|
strong |
Describes which edge of a widget a certain feature is positioned at, e.g.
the tabs of a Gtk::Notebook, the handle of a Gtk::HandleBox or the label of a Gtk::Scale.
|
strong |
An enum for specifying which features the print dialog should offer.
If neither Gtk::PrintCapabilities::GENERATE_PDF nor Gtk::PrintCapabilities::GENERATE_PS is specified, GTK+ assumes that all formats are supported.
- Bitwise operators:
PrintCapabilities operator|(PrintCapabilities, PrintCapabilities)
PrintCapabilities operator&(PrintCapabilities, PrintCapabilities)
PrintCapabilities operator^(PrintCapabilities, PrintCapabilities)
PrintCapabilities operator~(PrintCapabilities)
PrintCapabilities& operator|=(PrintCapabilities&, PrintCapabilities)
PrintCapabilities& operator&=(PrintCapabilities&, PrintCapabilities)
PrintCapabilities& operator^=(PrintCapabilities&, PrintCapabilities)
|
strong |
See also Gtk::PrintSettings::set_duplex().
| Enumerator | |
|---|---|
| SIMPLEX |
No duplex. |
| HORIZONTAL | |
| VERTICAL | |
|
strong |
See also Gtk::PrintJob::set_pages()
| Enumerator | |
|---|---|
| ALL |
All pages. If set, specifies that all default actions should be taken. |
| CURRENT |
Current page. |
| RANGES |
Range of pages. |
| SELECTION |
Selected pages. |
|
strong |
See also Gtk::PrintSettings::set_quality().
| Enumerator | |
|---|---|
| LOW |
Low quality. |
| NORMAL | |
| HIGH |
High quality. |
| DRAFT |
Draft quality. |
|
strong |
The status gives a rough indication of the completion of a running print operation.
|
strong |
Describes the stage at which events are fed into a Gtk::EventController.
|
strong |
|
strong |
Indicated the relief to be drawn around a Gtk::Button.
| Enumerator | |
|---|---|
| NORMAL | |
| NONE | |
Predefined values for use as response ids in Gtk::Dialog::add_button().
All predefined values are negative, GTK+ leaves positive values for application-defined response ids.
|
strong |
These enumeration values describe the possible transitions when the child of a Gtk::Revealer widget is shown or hidden.
|
strong |
Scrolling types.
|
strong |
Used to control what selections users are allowed to make.
| Enumerator | |
|---|---|
| NONE | |
| SINGLE |
Zero or one element may be selected. |
| 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 Gtk::SelectionMode::BROWSE. What is really enforced is that the user can’t deselect a currently selected element except by selecting another element. |
| 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. |
|
strong |
|
strong |
Used to change the appearance of an outline typically provided by a Gtk::Frame.
Note that many themes do not differentiate the appearance of the various shadow types: Either their is no visible shadow ( GTK_SHADOW_NONE), or there is (any other value).
|
strong |
GtkShortcutType specifies the kind of shortcut that is being described.
More values may be added to this enumeration over time.
| Enumerator | |
|---|---|
| ACCELERATOR |
The shortcut is a keyboard accelerator. The Gtk::ShortcutsShortcut::property_accelerator() property will be used. |
| GESTURE_PINCH |
The shortcut is a pinch gesture. GTK+ provides an icon and subtitle. |
| GESTURE_STRETCH |
The shortcut is a stretch gesture. GTK+ provides an icon and subtitle. |
| GESTURE_ROTATE_CLOCKWISE |
The shortcut is a clockwise rotation gesture. GTK+ provides an icon and subtitle. |
| GESTURE_ROTATE_COUNTERCLOCKWISE |
The shortcut is a counterclockwise rotation gesture. GTK+ provides an icon and subtitle. |
| GESTURE_TWO_FINGER_SWIPE_LEFT |
The shortcut is a two-finger swipe gesture. GTK+ provides an icon and subtitle. |
| GESTURE_TWO_FINGER_SWIPE_RIGHT |
The shortcut is a two-finger swipe gesture. GTK+ provides an icon and subtitle. |
| GESTURE |
The shortcut is a gesture. The Gtk::ShortcutsShortcut::property_icon() property will be used. |
| GESTURE_SWIPE_LEFT |
The shortcut is a swipe gesture. GTK+ provides an icon and subtitle. |
| GESTURE_SWIPE_RIGHT |
The shortcut is a swipe gesture. GTK+ provides an icon and subtitle. |
|
strong |
|
strong |
|
strong |
The values of the GtkSpinType enumeration are used to specify the change to make in Gtk::SpinButton::spin().
| Enumerator | |
|---|---|
| STEP_FORWARD | |
| STEP_BACKWARD | |
| PAGE_FORWARD | |
| PAGE_BACKWARD | |
| HOME |
Go to the adjustments lower bound. |
| END | |
| USER_DEFINED |
Change by a specified amount. |
|
strong |
These enumeration values describe the possible transitions between pages in a Gtk::Stack widget.
New values may be added to this enumeration over time.
|
strong |
Describes a widget state.
Widget states are used to match the widget against CSS pseudo-classes. Note that GTK extends the regular CSS classes and sometimes uses different names.
- Bitwise operators:
StateFlags operator|(StateFlags, StateFlags)
StateFlags operator&(StateFlags, StateFlags)
StateFlags operator^(StateFlags, StateFlags)
StateFlags operator~(StateFlags)
StateFlags& operator|=(StateFlags&, StateFlags)
StateFlags& operator&=(StateFlags&, StateFlags)
StateFlags& operator^=(StateFlags&, StateFlags)
| Enumerator | |
|---|---|
| NORMAL | |
| ACTIVE |
Widget is active. |
| PRELIGHT |
Widget has a mouse pointer over it. |
| SELECTED | |
| INSENSITIVE | |
| INCONSISTENT |
Widget is inconsistent. |
| FOCUSED | |
| BACKDROP |
Widget is in a background toplevel window. |
| DIR_LTR |
Widget is in left-to-right text direction. Try to load a variant of the icon for left-to-right text direction. |
| DIR_RTL |
Widget is in right-to-left text direction. Try to load a variant of the icon for right-to-left text direction. |
| LINK |
Widget is a link. |
| VISITED |
The location the widget points to has already been visited. |
| CHECKED |
Widget is checked. |
| DROP_ACTIVE |
Widget is highlighted as a drop target for DND. |
|
strong |
The Gtk::TargetFlags enumeration is used to specify constraints on a Gtk::TargetEntry.
- Bitwise operators:
TargetFlags operator|(TargetFlags, TargetFlags)
TargetFlags operator&(TargetFlags, TargetFlags)
TargetFlags operator^(TargetFlags, TargetFlags)
TargetFlags operator~(TargetFlags)
TargetFlags& operator|=(TargetFlags&, TargetFlags)
TargetFlags& operator&=(TargetFlags&, TargetFlags)
TargetFlags& operator^=(TargetFlags&, TargetFlags)
|
strong |
|
strong |
Flags affecting how a search is done.
If neither Gtk::TextSearchFlags::VISIBLE_ONLY nor Gtk::TextSearchFlags::TEXT_ONLY are enabled, the match must be exact; the special 0xFFFC character will match embedded pixbufs or child widgets.
- Bitwise operators:
TextSearchFlags operator|(TextSearchFlags, TextSearchFlags)
TextSearchFlags operator&(TextSearchFlags, TextSearchFlags)
TextSearchFlags operator^(TextSearchFlags, TextSearchFlags)
TextSearchFlags operator~(TextSearchFlags)
TextSearchFlags& operator|=(TextSearchFlags&, TextSearchFlags)
TextSearchFlags& operator&=(TextSearchFlags&, TextSearchFlags)
TextSearchFlags& operator^=(TextSearchFlags&, TextSearchFlags)
|
strong |
Used to reference the parts of Gtk::TextView.
| Enumerator | |
|---|---|
| PRIVATE |
Private value, used internally. |
| WIDGET |
Window that floats over scrolling areas. |
| TEXT | |
| LEFT | |
| RIGHT | |
| TOP | |
| BOTTOM | |
|
strong |
Used to customize the appearance of a Gtk::Toolbar.
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 GTK_TOOLBAR_ICONS is used, the label will be visible, and vice versa.
| Enumerator | |
|---|---|
| ICONS |
Buttons display only icons in the toolbar. |
| TEXT |
Buttons display only text labels in the toolbar. Scrollable text window. |
| BOTH |
Buttons display text and icons in the toolbar. |
| BOTH_HORIZ |
Buttons display icons and text alongside each other, rather than vertically stacked. |
|
strong |
Flags used to specify the supported drag targets.
- Bitwise operators:
ToolPaletteDragTargets operator|(ToolPaletteDragTargets, ToolPaletteDragTargets)
ToolPaletteDragTargets operator&(ToolPaletteDragTargets, ToolPaletteDragTargets)
ToolPaletteDragTargets operator^(ToolPaletteDragTargets, ToolPaletteDragTargets)
ToolPaletteDragTargets operator~(ToolPaletteDragTargets)
ToolPaletteDragTargets& operator|=(ToolPaletteDragTargets&, ToolPaletteDragTargets)
ToolPaletteDragTargets& operator&=(ToolPaletteDragTargets&, ToolPaletteDragTargets)
ToolPaletteDragTargets& operator^=(ToolPaletteDragTargets&, ToolPaletteDragTargets)
| Enumerator | |
|---|---|
| ITEMS |
Support drag of items. |
| GROUPS |
Support drag of groups. |
|
strong |
The different types of sections indicate parts of a CSS document as parsed by GTK’s CSS parser.
They are oriented towards the CSS Grammar, but may contain extensions.
More types might be added in the future as the parser incorporates more features.
| Enumerator | |
|---|---|
| DOCUMENT |
The section describes a complete document. This section time is the only one where Gtk::CssSection::get_parent() might return |
| IMPORT |
The section defines an import rule. |
| COLOR_DEFINITION |
The section defines a color. This is a GTK extension to CSS. |
| BINDING_SET |
The section defines a binding set. This is a GTK extension to CSS. |
| RULESET |
The section defines a CSS ruleset. |
| SELECTOR |
The section defines a CSS selector. |
| DECLARATION |
The section defines the declaration of a CSS variable. |
| VALUE |
The section defines the value of a CSS declaration. |
| KEYFRAMES |
The section defines keyframes. See CSS Animations for details. |
|
strong |
See also Gtk::PrintSettings::set_paper_width().
| Enumerator | |
|---|---|
| NONE | |
| POINTS |
Dimensions in points. |
| INCH |
Dimensions in inches. |
| MM |
Dimensions in millimeters. |
|
strong |
Window placement can be influenced using this enumeration.
Note that using Gtk::WindowPosition::CENTER_ALWAYS is almost always a bad idea. It won’t necessarily work well with all window managers or on all windowing systems.
| Enumerator | |
|---|---|
| NONE | |
| CENTER | |
| MOUSE |
Windows should be placed at the current mouse position. |
| CENTER_ALWAYS |
Keep window centered as it changes size, etc. |
| CENTER_ON_PARENT |
Center the window on its transient parent (see Gtk::Window::set_transient_for()). |
|
strong |
A Gtk::Window can be one of these types.
Most things you’d consider a “window” should have type Gtk::WindowType::TOPLEVEL; windows with this type are managed by the window manager and have a frame by default (call Gtk::Window::set_decorated() to toggle the frame). Windows with type Gtk::WindowType::POPUP 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, many GTK+ features that rely on the window manager will not work (e.g. resize grips and maximization/minimization). Gtk::WindowType::POPUP is used to implement widgets such as Gtk::Menu or tooltips that you normally don’t think of as windows per se. Nearly all windows should be Gtk::WindowType::TOPLEVEL. In particular, do not use Gtk::WindowType::POPUP just to turn off the window borders; use Gtk::Window::set_decorated() for that.
| Enumerator | |
|---|---|
| TOPLEVEL |
A regular window, such as a dialog. |
| POPUP |
A special window such as a tooltip. |
Function Documentation
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
