MySQL Workbench  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
mforms Namespace Reference

Implementation of a composite used to select a file system object like a file, folder, device, drive etc. More...

Classes

class  App
 Proxy class for interfacing with the host application window. More...
 
class  AppView
 A view that is dockable into the host application window. More...
 
class  Box
 Places child views sequentially in a vertical or horizontal layout. More...
 
class  Button
 A clickable button control. More...
 
class  CheckBox
 A checkbox toggle control. More...
 
class  CodeEditor
 
class  CodeEditorConfig
 Helper class to manage editor configuration files. More...
 
class  Container
 Intermediate class used to collectively check for containers and later maybe implement special container functionality. More...
 
class  ContextMenu
 A menu that can be attached to other controls. More...
 
class  DockingPoint
 Proxy class for interfacing with host application windows. More...
 
struct  DragDetails
 
class  DrawBox
 
class  DropDelegate
 Delegate class for events caused by a drop operation. More...
 
class  FileChooser
 A File Picker dialog. More...
 
class  FindPanel
 
class  Form
 A standalone, top-level window. More...
 
class  FsObjectSelector
 
class  HyperText
 
class  ImageBox
 Shows an image file. More...
 
class  Label
 A control with some static text. More...
 
class  ListBox
 A list control with a single column and multiple rows. More...
 
class  Menu
 
class  MenuBar
 A menu that can be added to the host application. More...
 
class  MenuBase
 
class  MenuItem
 A menu item that can be added to the host application menus. More...
 
class  NativeContainer
 
class  Panel
 A generic single item container with optional border. More...
 
class  PasswordCache
 
class  Popover
 
class  Popup
 
class  ProgressBar
 A progress bar to show completion state of a task. More...
 
class  RadioButton
 A radio button that will unselect other buttons in the same group when selected. More...
 
class  ScrollPanel
 A container panel with scrollbars. More...
 
class  SectionBox
 
class  Selector
 A button (or text entry) with a popup menu that allows selection of a single item. More...
 
class  SimpleForm
 
class  Splitter
 A splitter/split view/paned view to accommodate 2 child views with a draggable divider. More...
 
class  Table
 Container to layout child items in a grid of rows and columns. More...
 
class  TabSwitcher
 
class  TabView
 A Notebook/Tabbed view. More...
 
class  TabViewDockingPoint
 
struct  TextAttributes
 
class  TextBox
 Multiline text editing control. More...
 
class  TextEntry
 Single line text edit control, with support for some special events. More...
 
class  ToolBar
 
struct  ToolBarImplPtrs
 
class  ToolBarItem
 
class  TreeNode
 
struct  TreeNodeCollectionSkeleton
 
class  TreeNodeData
 
struct  TreeNodeRef
 
struct  TreeNodeSkeleton
 
class  TreeNodeView
 Control to show nodes in multiple columns in the form of a tree. More...
 
class  Utilities
 Various Utility functions. More...
 
class  View
 
class  WebBrowser
 HTML browser. More...
 
class  Wizard
 

Typedefs

typedef struct TextAttributes TreeNodeTextAttributes
 
typedef int TimeoutHandle
 

Enumerations

enum  SystemColor { SystemColorHighlight, SystemColorEditor, SystemColorDisabled, SystemColorContainer }
 
enum  ButtonType { PushButton, ToolButton, AdminActionButton, SmallButton }
 
enum  SyntaxHighlighterLanguage {
  LanguageNone, LanguageMySQL50, LanguageMySQL51, LanguageMySQL55,
  LanguageMySQL56, LanguageHtml, LanguageLua, LanguagePython,
  LanguageCpp, LanguageMySQL = LanguageMySQL56
}
 
enum  LineMarkup {
  LineMarkupNone = 0, LineMarkupBreakpoint = 1 << 0, LineMarkupBreakpointHit = 1 << 1, LineMarkupError = 1 << 2,
  LineMarkupStatement = 1 << 3, LineMarkupCurrent = 1 << 4, LineMarkupAll = 0xFF
}
 A number of flags used to specify visual appearance of an editor line. More...
 
enum  RangeIndicator { RangeIndicatorNone = 0, RangeIndicatorError = 1 << 0 }
 
enum  CodeEditorFeature {
  FeatureNone = 0, FeatureWrapText = 1 << 0, FeatureGutter = 1 << 1, FeatureReadOnly = 1 << 2,
  FeatureShowSpecial = 1 << 3, FeatureUsePopup = 1 << 4, FeatureConvertEolOnPaste = 1 << 5, FeatureScrollOnResize = 1 << 6,
  FeatureFolding = 1 << 7, FeatureAll = 0xFFFF
}
 
enum  AutoCompletionEventType { AutoCompletionSelection, AutoCompletionCancelled, AutoCompletionCharDeleted }
 
enum  EndOfLineMode { EolCRLF = 0, EolCR = 1, EolLF = 2 }
 
enum  FindFlags {
  FindDefault = 0, FindMatchCase = (1 << 0), FindWrapAround = (1 << 1), FindWholeWords = (1 << 2),
  FindRegex = (1 << 3)
}
 
enum  FileChooserType { OpenFile = 1, SaveFile = 2, OpenDirectory = 3 }
 
enum  FindPanelAction {
  FindNext, FindPrevious, Replace, ReplaceAndFind,
  FindAndReplace, ReplaceAll
}
 
enum  FormFlag {
  FormNone = 0, FormSingleFrame = 1 << 0, FormDialogFrame = 1 << 1, FormResizable = 1 << 2,
  FormMinimizable = 1 << 3, FormHideOnClose = 1 << 4, FormStayOnTop = 1 << 5, FormToolWindow = 1 << 6,
  FormNormal = (FormResizable|FormMinimizable)
}
 
enum  LabelStyle {
  NormalStyle, BoldStyle, SmallBoldStyle, BigStyle,
  BigBoldStyle, SmallStyle, VerySmallStyle, InfoCaptionStyle,
  BoldInfoCaptionStyle, WizardHeadingStyle, SmallHelpTextStyle, VeryBigStyle
}
 
enum  MenuItemType { NormalMenuItem = 0, CheckedMenuItem, SeparatorMenuItem }
 
enum  PanelType {
  TransparentPanel, FilledPanel, BorderedPanel, LineBorderPanel,
  TitledBoxPanel, TitledGroupPanel, FilledHeaderPanel, StyledHeaderPanel
}
 
enum  StartPosition { Left, Right, Above, Below }
 
enum  PopoverStyle { PopoverStyleNormal, PopoverStyleTooltip }
 
enum  PopupStyle { PopupPlain, PopupBezel }
 
enum  ScrollPanelFlags { ScrollPanelNoFlags = 0, ScrollPanelBordered = (1<<0), ScrollPanelDrawBackground = (1<<1) }
 
enum  SelectorStyle { SelectorCombobox, SelectorPopup }
 
enum  TableItemFlags {
  NoFillExpandFlag = 0, VExpandFlag = (1 << 0), HExpandFlag = (1 << 1), VFillFlag = (1 << 2),
  HFillFlag = (1 << 3), FillAndExpand = HFillFlag | VFillFlag | VExpandFlag | HExpandFlag
}
 
enum  TabSwitcherType { VerticalIconSwitcher }
 
enum  TabElementPart {
  TabActiveBackground = 0, TabInactiveBackground, TabActiveForeground, TabInactiveForeground,
  TabMainCaption, TabSubCaption, TabLineColor, TabLastElement
}
 
enum  TabViewType {
  TabViewSystemStandard = 0, TabViewTabless = 1, TabViewMainClosable, TabViewDocument,
  TabViewDocumentClosable, TabViewPalette, TabViewSelectorSecondary
}
 
enum  ScrollBars {
  NoScrollBar = 0, HorizontalScrollBar = (1 << 0), VerticalScrollBar = (1 << 1), BothScrollBars = (HorizontalScrollBar | VerticalScrollBar),
  SmallScrollBars = (1 << 2)
}
 
enum  KeyCode {
  KeyNone, KeyChar, KeyModifierOnly, KeyEnter,
  KeyReturn, KeyHome, KeyEnd, KeyPrevious,
  KeyNext, KeyUnkown
}
 Code which abstracts special keys for each platform, to be used in the key event. More...
 
enum  TextEntryType { NormalEntry, PasswordEntry, SearchEntry, SmallSearchEntry = SearchEntry }
 
enum  TextEntryAction {
  EntryActivate, EntryKeyUp, EntryKeyDown, EntryCKeyUp,
  EntryCKeyDown
}
 
enum  ToolBarType {
  MainToolBar, SecondaryToolBar, ToolPickerToolBar, OptionsToolBar,
  PaletteToolBar
}
 
enum  ToolBarItemType {
  LabelItem, ActionItem, TextActionItem, ToggleItem,
  SegmentedToggleItem, SearchFieldItem, SelectorItem, ColorSelectorItem,
  SeparatorItem, ExpanderItem, ImageBoxItem, TitleItem = LabelItem
}
 
enum  TreeColumnType {
  StringColumnType, StringLTColumnType, IntegerColumnType, LongIntegerColumnType,
  CheckColumnType, TriCheckColumnType, IconColumnType, IconStringColumnType = IconColumnType,
  NumberWithUnitColumnType, FloatColumnType
}
 Determines what type a column should have (mainly describing the column editor). More...
 
enum  TreeOptions {
  TreeDefault = 0, TreeNoColumns = 1 << 3, TreeAllowReorderRows = 1 << 4, TreeShowColumnLines = 1 << 5,
  TreeShowRowLines = 1 << 6, TreeNoBorder = 1 << 7, TreeSidebar = 1 << 8, TreeNoHeader = 1 << 9,
  TreeShowHeader = 0, TreeFlatList = 1 << 10, TreeAltRowColors = 1 << 11, TreeSizeSmall = 1 << 12,
  TreeIndexOnTag = 1 << 13, TreeCanBeDragSource = 1 << 14
}
 Options used to customize what to show in the tree. More...
 
enum  TreeSelectionMode { TreeSelectSingle, TreeSelectMultiple }
 
enum  ModifierKey {
  ModifierNoModifier = 0, ModifierControl = 1 << 0, ModifierShift = 1 << 1, ModifierCommand = 1 << 2,
  ModifierAlt = 1 << 3
}
 Flags which describe which modifier key was pressed during a event. More...
 
enum  DialogResult { ResultOk = 1, ResultCancel = 0, ResultOther = -1 }
 
enum  DialogType {
  DialogMessage, DialogError, DialogWarning, DialogQuery,
  DialogSuccess
}
 
enum  Alignment {
  NoAlign, BottomLeft, BottomCenter, BottomRight,
  MiddleLeft, MiddleCenter, MiddleRight, TopLeft,
  TopCenter, TopRight, WizardLabelAlignment
}
 
enum  MouseButton { MouseButtonLeft = 0, MouseButtonRight = 1, MouseButtonOther = 2, MouseButtonNone = 0x80 }
 
enum  DragOperation { DragOperationNone = 0, DragOperationCopy = 1 << 0, DragOperationMove = 1 << 1 }
 

Functions

LineMarkup operator| (LineMarkup a, LineMarkup b)
 
CodeEditorFeature operator| (CodeEditorFeature a, CodeEditorFeature b)
 
FindFlags operator| (FindFlags a, FindFlags b)
 
FindFlagsoperator|= (FindFlags &a, FindFlags b)
 
TableItemFlags operator| (TableItemFlags a, TableItemFlags b)
 
TreeOptions operator| (TreeOptions a, TreeOptions b)
 
ModifierKey operator| (ModifierKey a, ModifierKey b)
 

Variables

const std::string DragFormatText = "com.mysql.workbench.text"
 
const std::string DragFormatFileName = "com.mysql.workbench.file"
 

Detailed Description

Implementation of a composite used to select a file system object like a file, folder, device, drive etc.

Implementation of a control class for a treeview control based on node objects.

The section box is a container with a hidable area (collapse/expand).

This class implements a popup window class which can be used for context menus or drop down menus.

Special window class to be used as a popup with child controls and a special border.

It is used as a "fly-out" or support window similar to tooltips showing e.g. larger amounts of text and can act otherwise like a normal (but floating) window. Other than the mforms popup class (which is meant for menus and the like) the popover cannot be transparent and is non-modal. Outer form, drop shadow etc. is provided by the platform implementations.

A popup is always a modal window and cannot be used to embed other controls nor can itself be embedded.

It provides a header with action buttons and can use tabs for switchable content.

Typedef Documentation

typedef int mforms::TimeoutHandle

Definition at line 93 of file utilities.h.

Definition at line 85 of file treenodeview.h.

Enumeration Type Documentation

Enumerator
NoAlign 
BottomLeft 
BottomCenter 
BottomRight 
MiddleLeft 
MiddleCenter 
MiddleRight 
TopLeft 
TopCenter 
TopRight 
WizardLabelAlignment 

Definition at line 40 of file view.h.

Enumerator
AutoCompletionSelection 
AutoCompletionCancelled 
AutoCompletionCharDeleted 

Definition at line 107 of file code_editor.h.

107  {
108  AutoCompletionSelection, // The user selected an entry in the auto completion list.
109  AutoCompletionCancelled, // Auto completion was cancelled.
110  AutoCompletionCharDeleted, // A character was deleted while auto completion was active.
111  };
Enumerator
PushButton 
ToolButton 
AdminActionButton 
SmallButton 

Definition at line 28 of file button.h.

29  {
30  PushButton,
31  ToolButton, // A button for a tool bar.
32  AdminActionButton, // A push button that will trigger an action which requires admin privileges.
33  // This will add an indicator to the button (a shield on Windows).
35  };
Enumerator
FeatureNone 
FeatureWrapText 
FeatureGutter 
FeatureReadOnly 
FeatureShowSpecial 
FeatureUsePopup 
FeatureConvertEolOnPaste 
FeatureScrollOnResize 
FeatureFolding 
FeatureAll 

Definition at line 85 of file code_editor.h.

85  {
86  FeatureNone = 0,
87  FeatureWrapText = 1 << 0, // Enables word wrapping.
88  FeatureGutter = 1 << 1, // Show/Hide gutter.
89  FeatureReadOnly = 1 << 2,
90  FeatureShowSpecial = 1 << 3, // Show white spaces and line ends with special chars.
91  FeatureUsePopup = 1 << 4, // Use built-in context menu.
92  FeatureConvertEolOnPaste = 1 << 5, // Convert line endings to the current value in the editor
93  // when pasting text.
94  FeatureScrollOnResize = 1 << 6, // Scroll caret into view if it would be hidden by a resize action.
95  FeatureFolding = 1 << 7, // Enable code folding.
96 
97  FeatureAll = 0xFFFF,
98  };
Enumerator
ResultOk 
ResultCancel 
ResultOther 

Definition at line 76 of file utilities.h.

76  {
77  ResultOk = 1,
78  ResultCancel = 0,
79  ResultOther = -1
80  };
Enumerator
DialogMessage 
DialogError 
DialogWarning 
DialogQuery 
DialogSuccess 

Definition at line 83 of file utilities.h.

84  {
89  DialogSuccess, // Like DialogMessage but with a special icon to signal a successful operation.
90  };
Enumerator
DragOperationNone 
DragOperationCopy 
DragOperationMove 

Definition at line 78 of file view.h.

Enumerator
EolCRLF 
EolCR 
EolLF 

Definition at line 113 of file code_editor.h.

113  {
114  EolCRLF = 0,
115  EolCR = 1,
116  EolLF = 2, // Default
117  };
Enumerator
OpenFile 
SaveFile 
OpenDirectory 

Definition at line 28 of file filechooser.h.

Enumerator
FindDefault 
FindMatchCase 
FindWrapAround 
FindWholeWords 
FindRegex 

Definition at line 119 of file code_editor.h.

119  {
120  FindDefault = 0,
121  FindMatchCase = (1 << 0),
122  FindWrapAround = (1 << 1),
123  FindWholeWords = (1 << 2),
124  FindRegex = (1 << 3)
125  };
Enumerator
FindNext 
FindPrevious 
Replace 
ReplaceAndFind 
FindAndReplace 
ReplaceAll 

Definition at line 30 of file find_panel.h.

31  {
32  FindNext, // Select next occurrence after current selection or after current caret position
33  // (if there is no selection).
34  FindPrevious, // Same as FindNext, but backwards.
35  Replace, // Replace what is selected currently.
36  ReplaceAndFind, // Replace current selection (whatever it is) or insert at caret position
37  // (if there is no selection) and select the next occurrence.
38  FindAndReplace, // Replace next occurrence after current selection or after current caret position.
39  ReplaceAll, // Replace all occurrences of the search text.
40  };
Enumerator
FormNone 
FormSingleFrame 
FormDialogFrame 
FormResizable 
FormMinimizable 
FormHideOnClose 
FormStayOnTop 
FormToolWindow 
FormNormal 

Definition at line 34 of file form.h.

35  {
36  FormNone = 0,
37  FormSingleFrame = 1 << 0,
38  FormDialogFrame = 1 << 1,
39  FormResizable = 1 << 2,
40  FormMinimizable = 1 << 3,
41  FormHideOnClose = 1 << 4,
42  FormStayOnTop = 1 << 5,
43  FormToolWindow = 1 << 6, // Not combinable with any of the frame styles above. Also min and max
44  // are not available.
46  };

Code which abstracts special keys for each platform, to be used in the key event.

Enumerator
KeyNone 
KeyChar 

No special char. The key event has the entered character(s) in the text field.

KeyModifierOnly 

A combination of Shift/Control/Command/Alt only, without another key.

KeyEnter 

The numpad <enter> key.

KeyReturn 

The main keyboard <return> key.

KeyHome 
KeyEnd 
KeyPrevious 
KeyNext 
KeyUnkown 

Any other key, not yet mapped.

Definition at line 37 of file textbox.h.

37  {
38  KeyNone,
39  KeyChar,
41  KeyEnter,
42  KeyReturn,
43  KeyHome,
44  KeyEnd,
46  KeyNext,
47  KeyUnkown,
48  };
No special char. The key event has the entered character(s) in the text field.
Definition: textbox.h:39
Any other key, not yet mapped.
Definition: textbox.h:47
The numpad key.
Definition: textbox.h:41
A combination of Shift/Control/Command/Alt only, without another key.
Definition: textbox.h:40
The main keyboard key.
Definition: textbox.h:42
Enumerator
NormalStyle 
BoldStyle 
SmallBoldStyle 
BigStyle 
BigBoldStyle 
SmallStyle 
VerySmallStyle 
InfoCaptionStyle 
BoldInfoCaptionStyle 
WizardHeadingStyle 
SmallHelpTextStyle 
VeryBigStyle 

Definition at line 30 of file label.h.

31  {
32  // normal text in normal system font
34  // same as above, but bold
35  BoldStyle,
36  // bold text, slightly smaller
38  // large text
39  BigStyle,
40  // same as above, but bold
42  // smaller than normal text
43  SmallStyle,
44  // As small as possible but still readable, for titles under widgets etc.
46 
47  // style for showing some information, can be same as normal or a bit smaller
50  // wizard heading, in windows its blue, black elsewhere.. also bold and a bigger than normal
52  // description/help text to show for options, smaller than normal for fitting longer descriptions
54 
55  VeryBigStyle // 18pt
56  };

A number of flags used to specify visual appearance of an editor line.

Enumerator
LineMarkupNone 
LineMarkupBreakpoint 
LineMarkupBreakpointHit 
LineMarkupError 
LineMarkupStatement 
LineMarkupCurrent 
LineMarkupAll 

Definition at line 61 of file code_editor.h.

61  {
62  LineMarkupNone = 0, // No markup for the given line.
63  LineMarkupBreakpoint = 1 << 0, // Line has a marker set for a break point.
64  LineMarkupBreakpointHit = 1 << 1, // Line has a marker set for a break point which is currently hit.
65  LineMarkupError = 1 << 2, // Line's background is drawn in red to mark an execution error.
66  LineMarkupStatement = 1 << 3, // Marks a line as having a statement starting on it.
67  LineMarkupCurrent = 1 << 4, // Current execution line.
68 
69  LineMarkupAll = 0xFF, // All markup, useful for remove_markup.
70  };
Enumerator
NormalMenuItem 
CheckedMenuItem 
SeparatorMenuItem 

Definition at line 38 of file menubar.h.

Flags which describe which modifier key was pressed during a event.

Enumerator
ModifierNoModifier 
ModifierControl 
ModifierShift 
ModifierCommand 
ModifierAlt 

Definition at line 61 of file utilities.h.

61  {
63  ModifierControl = 1 << 0,
64  ModifierShift = 1 << 1,
65  ModifierCommand = 1 << 2, // Command on Mac, Windows key on Windows.
66  ModifierAlt = 1 << 3,
67  };
Enumerator
MouseButtonLeft 
MouseButtonRight 
MouseButtonOther 
MouseButtonNone 

Definition at line 69 of file view.h.

69  {
70  MouseButtonLeft = 0,
71  MouseButtonRight = 1,
72  MouseButtonOther = 2,
73 
74  MouseButtonNone = 0x80, // Sometimes the values for the mouse buttons are hard coded, so better use a high value for this.
75  // TODO: identify hard coded values and replace them.
76  };
Enumerator
TransparentPanel 
FilledPanel 
BorderedPanel 
LineBorderPanel 
TitledBoxPanel 
TitledGroupPanel 
FilledHeaderPanel 
StyledHeaderPanel 

Definition at line 25 of file panel.h.

25  {
26  // TODO: re-arrange names so that the all begin with Panel.., as this sorts much better
27  // in lists etc.
28  TransparentPanel, // just a container with no background
29  FilledPanel, // just a container with color filled background
30  BorderedPanel, // container with native border
31  LineBorderPanel, // container with a solid line border
32  TitledBoxPanel, // native grouping box with a title with border
33  TitledGroupPanel, // native grouping container with a title (may have no border)
34  FilledHeaderPanel, // Just like a filled panel but additionally has a header bar with a title.
35  StyledHeaderPanel // Panel which has top round corners for win, rect + gradient fill for osx, plain filled rect for linux
36  };
Enumerator
PopoverStyleNormal 
PopoverStyleTooltip 

Definition at line 44 of file popover.h.

44  {
45  PopoverStyleNormal, // With large rounded corners, tip (arrow) etc.
46  PopoverStyleTooltip // Simplified version with now tip, smaller corners etc.
47  };
Enumerator
PopupPlain 
PopupBezel 

Definition at line 35 of file popup.h.

36  {
37  PopupPlain, // A simple popup window, similar to context menus, but non-modal.
38  PopupBezel, // A semi-transparent black and modal window with rounded corners and a white border.
39  };
Enumerator
RangeIndicatorNone 
RangeIndicatorError 

Definition at line 80 of file code_editor.h.

80  {
82  RangeIndicatorError = 1 << 0, // Red squiggles under a range of text.
83  };
Enumerator
NoScrollBar 

Don't show any scroll bar.

HorizontalScrollBar 

Show only the horizontal scroll bar.

VerticalScrollBar 

Show only the vertical scroll bar.

BothScrollBars 

Show both scroll bars.

SmallScrollBars 

A smaller version of the scrollbars.

Definition at line 26 of file textbox.h.

26  {
27  NoScrollBar= 0,
28  HorizontalScrollBar = (1 << 0),
29  VerticalScrollBar = (1 << 1),
31  SmallScrollBars = (1 << 2)
32  };
Show only the vertical scroll bar.
Definition: textbox.h:29
Don't show any scroll bar.
Definition: textbox.h:27
A smaller version of the scrollbars.
Definition: textbox.h:31
Show only the horizontal scroll bar.
Definition: textbox.h:28
Show both scroll bars.
Definition: textbox.h:30
Enumerator
ScrollPanelNoFlags 
ScrollPanelBordered 
ScrollPanelDrawBackground 

Definition at line 27 of file scrollpanel.h.

Enumerator
SelectorCombobox 

The value list is shown when clicking the arrow. The value is freely editable.

SelectorPopup 

The value list is shown when clicking the arrow.

The value can only be selected out of the values in the list and not freely edited.

Definition at line 29 of file selector.h.

30  {
33  };
The value list is shown when clicking the arrow. The value is freely editable.
Definition: selector.h:31
The value list is shown when clicking the arrow.
Definition: selector.h:32
Enumerator
Left 
Right 
Above 
Below 

Definition at line 37 of file popover.h.

37  {
38  Left, // The popover is initially left to the ref point, having its arrow pointing to the right.
39  Right, // Similar for the other positions.
40  Above,
41  Below
42  };
Enumerator
LanguageNone 
LanguageMySQL50 
LanguageMySQL51 
LanguageMySQL55 
LanguageMySQL56 
LanguageHtml 
LanguageLua 
LanguagePython 
LanguageCpp 
LanguageMySQL 

Definition at line 44 of file code_editor.h.

44  {
50  LanguageHtml, // includes embedded xml, javascript, php, vb, python
53  LanguageCpp, // Lexer for C++, C, Java, and JavaScript (which includes JSON).
54 
55  LanguageMySQL = LanguageMySQL56, // Always the latest language.
56  };
Enumerator
SystemColorHighlight 
SystemColorEditor 
SystemColorDisabled 
SystemColorContainer 

Definition at line 32 of file app.h.

33  {
34  SystemColorHighlight, // The system-defined color of the background of selected items.
35  // This includes selected menu items as well as selected text.
36  SystemColorEditor, // Background color for editor controls.
37  SystemColorDisabled, // Background color for disabled controls.
38  SystemColorContainer, // Usually a gray. The default background for container controls. TODO: Linux.
39  };
Enumerator
TabActiveBackground 
TabInactiveBackground 
TabActiveForeground 
TabInactiveForeground 
TabMainCaption 
TabSubCaption 
TabLineColor 
TabLastElement 

Definition at line 38 of file tabswitcher.h.

Enumerator
NoFillExpandFlag 

Neither expand nor fill.

VExpandFlag 

whether item should try using vertical space leftover from table

HExpandFlag 

same for horizontal expansion

VFillFlag 

whether all allocated vertical space should be filled, or just centered in it

HFillFlag 

same for horizontal filling

FillAndExpand 

Definition at line 30 of file table.h.

31  {
32  NoFillExpandFlag = 0,
33  VExpandFlag = (1 << 0),
34  HExpandFlag = (1 << 1),
35  VFillFlag = (1 << 2),
36  HFillFlag = (1 << 3),
37 
39  };
Neither expand nor fill.
Definition: table.h:32
same for horizontal filling
Definition: table.h:36
whether item should try using vertical space leftover from table
Definition: table.h:33
same for horizontal expansion
Definition: table.h:34
whether all allocated vertical space should be filled, or just centered in it
Definition: table.h:35
Enumerator
VerticalIconSwitcher 

Definition at line 34 of file tabswitcher.h.

Enumerator
TabViewSystemStandard 

Normal tab views with tabs on top in the style used by the system.

TabViewTabless 

System style tab view without tabs. Switching tabs can then be.

TabViewMainClosable 

WB main style tab view (top hanging tabs on Win), closable tabs.

TabViewDocument 

WB style for tabbed documents (top standing tabs, sql editors.

TabViewDocumentClosable 

WB style for tabbed documents (top standing tabs, sql editors.

TabViewPalette 

WB style tab view (bottom hanging tabs on Win), unclosable tabs.

TabViewSelectorSecondary 

Sidebar palette selector style, unclosable tabs.

Definition at line 28 of file tabview.h.

29  {
31  TabViewTabless = 1,
32  // performed programmatically only.
35  // and such). unclosable tabs
37  // and such). closable tabs
40  };
WB style tab view (bottom hanging tabs on Win), unclosable tabs.
Definition: tabview.h:38
WB style for tabbed documents (top standing tabs, sql editors.
Definition: tabview.h:34
WB style for tabbed documents (top standing tabs, sql editors.
Definition: tabview.h:36
WB main style tab view (top hanging tabs on Win), closable tabs.
Definition: tabview.h:33
System style tab view without tabs. Switching tabs can then be.
Definition: tabview.h:31
Sidebar palette selector style, unclosable tabs.
Definition: tabview.h:39
Normal tab views with tabs on top in the style used by the system.
Definition: tabview.h:30
Enumerator
EntryActivate 

Enter key was pressed.

EntryKeyUp 

Up arrow key was pressed.

EntryKeyDown 

Down arrow key was pressed.

EntryCKeyUp 

Up arrow key was pressed with Control/Command held.

EntryCKeyDown 

Down arrow key was pressed with Control/Command held.

Definition at line 40 of file textentry.h.

41  {
43  EntryKeyUp,
44  EntryKeyDown,
45  EntryCKeyUp,
47  };
Enter key was pressed.
Definition: textentry.h:42
Up arrow key was pressed with Control/Command held.
Definition: textentry.h:45
Up arrow key was pressed.
Definition: textentry.h:43
Down arrow key was pressed.
Definition: textentry.h:44
Down arrow key was pressed with Control/Command held.
Definition: textentry.h:46
Enumerator
NormalEntry 

a normal plain text entry

PasswordEntry 

password entry, will hide typed characters

SearchEntry 

normal text entry, with a distinctive appearance for search

SmallSearchEntry 

Definition at line 28 of file textentry.h.

29  {
30  NormalEntry,
32  SearchEntry,
33 #ifdef __APPLE__
35 #else
36  SmallSearchEntry = SearchEntry
37 #endif
38  };
normal text entry, with a distinctive appearance for search
Definition: textentry.h:32
a normal plain text entry
Definition: textentry.h:30
password entry, will hide typed characters
Definition: textentry.h:31
Enumerator
LabelItem 
ActionItem 
TextActionItem 
ToggleItem 
SegmentedToggleItem 
SearchFieldItem 
SelectorItem 
ColorSelectorItem 
SeparatorItem 
ExpanderItem 
ImageBoxItem 
TitleItem 

Definition at line 41 of file toolbar.h.

42  {
43  LabelItem,
44  ActionItem,
46  ToggleItem,
54 #ifdef __APPLE__
55  TitleItem
56 #else
57  TitleItem = LabelItem // TODO implement specific TitleItem (bold with #333333 color) for Windows, Linux
58 #endif
59  };
Enumerator
MainToolBar 
SecondaryToolBar 
ToolPickerToolBar 
OptionsToolBar 
PaletteToolBar 

Definition at line 32 of file toolbar.h.

33  {
36  ToolPickerToolBar, // only toggle and separator items are required to work
39  };

Determines what type a column should have (mainly describing the column editor).

Enumerator
StringColumnType 

simple string, with text entry editor

StringLTColumnType 

same as StringColumnType, but truncated at the left end if it doesn't fit

IntegerColumnType 

numeric field, with text entry editor

LongIntegerColumnType 

64bit numeric field, with text entry editor

CheckColumnType 

boolean field, with checkbox

TriCheckColumnType 

checkbox field (same as CheckColumnType) which also accepts -1 as mixed state

IconColumnType 

icon field, value is the icon path

IconStringColumnType 
NumberWithUnitColumnType 

string type, representing numbers with a unit suffix (like KB, MB, ms etc) TODO windows, linux

FloatColumnType 

a double precision floating point number

Definition at line 34 of file treenodeview.h.

35  {
46  };
64bit numeric field, with text entry editor
Definition: treenodeview.h:39
string type, representing numbers with a unit suffix (like KB, MB, ms etc) TODO windows, linux
Definition: treenodeview.h:44
boolean field, with checkbox
Definition: treenodeview.h:40
icon field, value is the icon path
Definition: treenodeview.h:42
numeric field, with text entry editor
Definition: treenodeview.h:38
a double precision floating point number
Definition: treenodeview.h:45
checkbox field (same as CheckColumnType) which also accepts -1 as mixed state
Definition: treenodeview.h:41
simple string, with text entry editor
Definition: treenodeview.h:36
same as StringColumnType, but truncated at the left end if it doesn't fit
Definition: treenodeview.h:37

Options used to customize what to show in the tree.

Enumerator
TreeDefault 
TreeNoColumns 

On non-Windows platforms columns are always on, so switch them on on Windows too by default and use this flag to switch them off, if really needed.

At least gtk has problems with arbitrary items for a tree. Treeview in gtk is built on View-Source model, where source is a row/column based thing. That may require some hacking to support NoColums in gtk, so really think if that is worth it.

TreeAllowReorderRows 

Allows row reordering, sets TreeCanBeDragSource implicitely.

TreeShowColumnLines 

show column separator lines

TreeShowRowLines 

show row separator lines

TreeNoBorder 

Switch off the border around the control. Default is to show the border.

TreeSidebar 

sidebar style treeview

TreeNoHeader 

Don't show a column header. Only meaningful if columns are used.

TreeShowHeader 

for backwards compatibility

TreeFlatList 

no child items expected

TreeAltRowColors 

enable alternating row colors

TreeSizeSmall 

small text

TreeIndexOnTag 

keep a node index on the tags (use with node_with_tag)

TreeCanBeDragSource 

allow the tree to be a drag source, data used depends on actual tree

Definition at line 49 of file treenodeview.h.

50  {
51  TreeDefault = 0,
52  TreeNoColumns = 1 << 3,
53  TreeAllowReorderRows = 1 << 4,
58  TreeShowColumnLines = 1 << 5,
59  TreeShowRowLines = 1 << 6,
60  TreeNoBorder = 1 << 7,
61  TreeSidebar = 1 << 8,
62  TreeNoHeader = 1 << 9,
63  TreeShowHeader = 0,
64  TreeFlatList = 1 << 10,
65  TreeAltRowColors = 1 << 11,
66  TreeSizeSmall = 1 << 12,
67  TreeIndexOnTag = 1 << 13,
68 
69  TreeCanBeDragSource = 1 << 14,
70  };
for backwards compatibility
Definition: treenodeview.h:63
Don't show a column header. Only meaningful if columns are used.
Definition: treenodeview.h:62
show row separator lines
Definition: treenodeview.h:59
no child items expected
Definition: treenodeview.h:64
show column separator lines
Definition: treenodeview.h:58
Switch off the border around the control. Default is to show the border.
Definition: treenodeview.h:60
Allows row reordering, sets TreeCanBeDragSource implicitely.
Definition: treenodeview.h:57
keep a node index on the tags (use with node_with_tag)
Definition: treenodeview.h:67
On non-Windows platforms columns are always on, so switch them on on Windows too by default and use t...
Definition: treenodeview.h:52
allow the tree to be a drag source, data used depends on actual tree
Definition: treenodeview.h:69
enable alternating row colors
Definition: treenodeview.h:65
sidebar style treeview
Definition: treenodeview.h:61
Enumerator
TreeSelectSingle 
TreeSelectMultiple 

Definition at line 79 of file treenodeview.h.

80  {
81  TreeSelectSingle, // 0 or 1 item selected
82  TreeSelectMultiple // 0+ items selection
83  };

Function Documentation

TableItemFlags mforms::operator| ( TableItemFlags  a,
TableItemFlags  b 
)
inline

Definition at line 41 of file table.h.

42  {
43  return (TableItemFlags)((int)a|(int)b);
44  }
TableItemFlags
Definition: table.h:30
ModifierKey mforms::operator| ( ModifierKey  a,
ModifierKey  b 
)
inline

Definition at line 70 of file utilities.h.

71  {
72  return (ModifierKey) ((int) a | (int) b);
73  }
ModifierKey
Flags which describe which modifier key was pressed during a event.
Definition: utilities.h:61
LineMarkup mforms::operator| ( LineMarkup  a,
LineMarkup  b 
)
inline

Definition at line 73 of file code_editor.h.

74  {
75  return (LineMarkup) ((int) a | (int) b);
76  }
LineMarkup
A number of flags used to specify visual appearance of an editor line.
Definition: code_editor.h:61
TreeOptions mforms::operator| ( TreeOptions  a,
TreeOptions  b 
)
inline

Definition at line 73 of file treenodeview.h.

74  {
75  return (TreeOptions) ((int) a | (int) b);
76  }
TreeOptions
Options used to customize what to show in the tree.
Definition: treenodeview.h:49
CodeEditorFeature mforms::operator| ( CodeEditorFeature  a,
CodeEditorFeature  b 
)
inline

Definition at line 101 of file code_editor.h.

102  {
103  return (CodeEditorFeature) ((int) a | (int) b);
104  }
CodeEditorFeature
Definition: code_editor.h:85
FindFlags mforms::operator| ( FindFlags  a,
FindFlags  b 
)
inline

Definition at line 128 of file code_editor.h.

129  {
130  return (FindFlags) ((int) a | (int) b);
131  }
FindFlags& mforms::operator|= ( FindFlags &  a,
FindFlags  b 
)
inline

Definition at line 133 of file code_editor.h.

134  {
135  a = (FindFlags)((int) a | (int) b);
136  return a;
137  }

Variable Documentation

const std::string mforms::DragFormatFileName = "com.mysql.workbench.file"

Definition at line 36 of file view.h.

const std::string mforms::DragFormatText = "com.mysql.workbench.text"

Definition at line 35 of file view.h.

MySQL Workbench 6.1 documentation