simplegui#

Fully qualified name: carb::simplegui

namespace simplegui#: Namespace for carb.simplegui plugin.

Enumerations#

Condition: Condition for simplegui::setWindow***(), setNextWindow***(), setNextTreeNode***() functions.
DataType: A primary data type.
Direction: A cardinal direction.
MouseCursor: Enumeration for GetMouseCursor() User code may request binding to display given cursor by calling SetMouseCursor(), which is why we have some cursors that are marked unused here.
StyleColor: Enumeration for pushStyleColor() / popStyleColor()
StyleColorsPreset: Predefined Style Colors presets.
StyleVar: Defines style variable (properties) that can be used to temporarily modify UI styles.

Structs#

ContextDesc: Defines a descriptor for simplegui context.
DrawCommand: Defines a drawing command.
DrawData: Defines the data used for drawing back-ends.
DrawList: Defines a list of draw commands.
DrawVertex: Defines a vertex used for drawing lists.
FontConfig: Structure defining the configuration for a font.
FontCustomRect: Structure of a custom rectangle for a font definition.
ISimpleGui: Defines the simplegui interface.
ListClipper: Helper: Manually clip large list of items.
Payload: Data payload for Drag and Drop operations: acceptDragDropPayload(), getDragDropPayload()
Style: Struct with all style variables.
TextEditCallbackData: Shared state of InputText(), passed to callback when a ImGuiInputTextFlags_Callback* flag is used and the corresponding callback is triggered.
Viewport: The viewports created and managed by simplegui.
WindowClass: [BETA] Rarely used / very advanced uses only. Use with SetNextWindowClass() and DockSpace() functions. Provide hints to the platform back-end via altered viewport flags (enable/disable OS decoration, OS task bar icons, etc.) and OS level parent/child relationships.

Typedefs#

ColorEditFlags: Defines flags to be used in colorEdit3() / colorEdit4() / colorPicker3() / colorPicker4() / colorButton()
ComboFlags: Defines flags to be used in simplegui::beginCombo()
DockNodeFlags: Defines flags to be used in simplegui::dockSpace()
DragDropFlags: Defines flags to be used in simplegui::beginDragDropSource(), simplegui::acceptDragDropPayload()
DrawCallback: Draw callbacks for advanced uses.
DrawCornerFlags: Defines DrawCornerFlags.
FocusedFlags: Defines flags to be used in simplegui::isWindowFocused()
FontEnumFn: Font enumeration function.
HoveredFlags: Defines flags to be used in simplegui::isItemHovered(), simplegui::isWindowHovered()
InputTextFlags: Defines input text flags for simplegui::inputText()
ItemFlags: Defines item flags for simplegui::pushItemFlags().
KeyModifiers: Key modifiers returned by ISimpleGui::getKeyModifiers() .
SelectableFlags: Defines flags to be used in simplegui::selectable()
TabBarFlags: Defines flags to be used in simplegui::beginTabBar()
TabItemFlags: Defines flags to be used in simplegui::beginTabItem()
TextEditCallback: Definition of callback from InputText().
TextureId: User data to identify a texture.
TreeNodeFlags: Defines tree node flags to be used in simplegui::collapsingHeader(), simplegui::treeNodeEx()
ViewportFlags: Flags stored in ImGuiViewport::Flags, giving indications to the platform back-ends.
Wchar: SimpleGui-specific definition of a wide character.
WindowFlags: Defines window flags for simplegui::begin()

Variables#

const ColorEditFlags kColorEditFlagAlphaBar: ColorEdit, ColorPicker: show vertical alpha bar/gradient in picker.
const ColorEditFlags kColorEditFlagAlphaPreview: ColorEdit, ColorPicker, ColorButton: display preview as a transparent color over a checkerboard, instead of opaque.
const ColorEditFlags kColorEditFlagAlphaPreviewHalf: ColorEdit, ColorPicker, ColorButton: display half opaque / half checkerboard, instead of opaque.
const ColorEditFlags kColorEditFlagFloat: [DataType] ColorEdit, ColorPicker, ColorButton: display values formatted as 0.0f..1.0f floats instead of 0..255 integers. No round-trip of value via integers.
const ColorEditFlags kColorEditFlagHDR: (WIP) ColorEdit: Currently only disable 0.0f..1.0f limits in RGBA edition (note: you probably want to use ImGuiColorEditFlags_Float flag as well).
const ColorEditFlags kColorEditFlagHEX: [Inputs]
const ColorEditFlags kColorEditFlagHSV: [Inputs]
const ColorEditFlags kColorEditFlagNoAlpha: ColorEdit, ColorPicker, ColorButton: ignore Alpha component (read 3 components from the input pointer).
const ColorEditFlags kColorEditFlagNoInputs: ColorEdit, ColorPicker: disable inputs sliders/text widgets (e.g. to show only the small preview colored square).
const ColorEditFlags kColorEditFlagNoLabel: ColorEdit, ColorPicker: disable display of inline text label (the label is still forwarded to the tooltip and picker).
const ColorEditFlags kColorEditFlagNoOptions: ColorEdit: disable toggling options menu when right-clicking on inputs/small preview.
const ColorEditFlags kColorEditFlagNoPicker: ColorEdit: disable picker when clicking on colored square.
const ColorEditFlags kColorEditFlagNoSidePreview: ColorPicker: disable bigger color preview on right side of the picker, use small colored square preview instead.
const ColorEditFlags kColorEditFlagNoSmallPreview: ColorEdit, ColorPicker: disable colored square preview next to the inputs. (e.g. to show only the inputs)
const ColorEditFlags kColorEditFlagNoTooltip: ColorEdit, ColorPicker, ColorButton: disable tooltip when hovering the preview.
const ColorEditFlags kColorEditFlagNone: Absence of other color edit flags.
const ColorEditFlags kColorEditFlagPickerHueBar: [PickerMode] // ColorPicker: bar for Hue, rectangle for Sat/Value.
const ColorEditFlags kColorEditFlagPickerHueWheel: [PickerMode] // ColorPicker: wheel for Hue, triangle for Sat/Value.
const ColorEditFlags kColorEditFlagRGB: [Inputs] ColorEdit: choose one among RGB/HSV/HEX. ColorPicker: choose any combination using RGB/HSV/HEX.
const ColorEditFlags kColorEditFlagUint8: [DataType] ColorEdit, ColorPicker, ColorButton: display values formatted as 0..255.
const ComboFlags kComboFlagHeightLarge: Max ~20 items visible.
const ComboFlags kComboFlagHeightLargest: As many fitting items as possible.
const ComboFlags kComboFlagHeightMask: Composed flag.
const ComboFlags kComboFlagHeightRegular: Max ~8 items visible (default)
const ComboFlags kComboFlagHeightSmall: Max ~4 items visible. Tip: If you want your combo popup to be a specific size you can use SetNextWindowSizeConstraints() prior to calling BeginCombo()
const ComboFlags kComboFlagNoArrowButton: Display on the preview box without the square arrow button.
const ComboFlags kComboFlagNoPreview: Display only a square arrow button.
const ComboFlags kComboFlagNone: Absence of other combo flags.
const ComboFlags kComboFlagPopupAlignLeft: Align the popup toward the left by default.
const DockNodeFlags kDockNodeFlagAutoHideTabBar: Tab bar will automatically hide when there is a single window in the dock node.
const DockNodeFlags kDockNodeFlagKeepAliveOnly: Don't display the dockspace node but keep it alive. Windows docked into this dockspace node won't be undocked.
const DockNodeFlags kDockNodeFlagNoDockingInCentralNode: Disable docking inside the Central Node, which will be always kept empty.
const DockNodeFlags kDockNodeFlagNoResize: Disable resizing child nodes using the splitter/separators. Useful with programmatically setup dockspaces.
const DockNodeFlags kDockNodeFlagNoSplit: Disable splitting the node into smaller nodes. Useful e.g. when embedding dockspaces into a main root one (the root one may have splitting disabled to reduce confusion)
const DockNodeFlags kDockNodeFlagNone: Absence of other dock node flags.
const DockNodeFlags kDockNodeFlagPassthruCentralNode: Enable passthru dockspace: 1) DockSpace() will render a ImGuiCol_WindowBg background covering everything excepted the Central Node when empty. Meaning the host window should probably use SetNextWindowBgAlpha(0.0f) prior to Begin() when using this. 2) When Central Node is empty: let inputs pass-through + won't display a DockingEmptyBg background. See demo for details.
const DragDropFlags kDragDropFlagAcceptBeforeDelivery: AcceptDragDropPayload() will returns true even before the mouse button is released. You can then call IsDelivery() to test if the payload needs to be delivered.
const DragDropFlags kDragDropFlagAcceptNoDrawDefaultRect: Do not draw the default highlight rectangle when hovering over target.
const DragDropFlags kDragDropFlagAcceptNoPreviewTooltip: Request hiding the BeginDragDropSource tooltip from the BeginDragDropTarget site.
const DragDropFlags kDragDropFlagAcceptPeekOnly: For peeking ahead and inspecting the payload before delivery.
const DragDropFlags kDragDropFlagNone: Absence of other drag/drop flags.
const DragDropFlags kDragDropFlagSourceAllowNullID: Allow items such as Text(), Image() that have no unique identifier to be used as drag source, by manufacturing a temporary identifier based on their window-relative position. This is extremely unusual within the simplegui ecosystem and so we made it explicit.
const DragDropFlags kDragDropFlagSourceAutoExpirePayload: Automatically expire the payload if the source cease to be submitted (otherwise payloads are persisting while being dragged)
const DragDropFlags kDragDropFlagSourceExtern: External source (from outside of simplegui), won't attempt to read current item/window info. Will always return true. Only one Extern source can be active simultaneously.
const DragDropFlags kDragDropFlagSourceNoDisableHover: By default, when dragging we clear data so that IsItemHovered() will return true, to avoid subsequent user code submitting tooltips. This flag disable this behavior so you can still call IsItemHovered() on the source item.
const DragDropFlags kDragDropFlagSourceNoHoldToOpenOthers: Disable the behavior that allows to open tree nodes and collapsing header by holding over them while dragging a source item.
const DragDropFlags kDragDropFlagSourceNoPreviewTooltip: By default, a successful call to BeginDragDropSource opens a tooltip so you can display a preview or description of the source contents. This flag disable this behavior.
const DrawCornerFlags kDrawCornerFlagAll: All corners.
const DrawCornerFlags kDrawCornerFlagBot: Bottom.
const DrawCornerFlags kDrawCornerFlagBotLeft: Bottom left.
const DrawCornerFlags kDrawCornerFlagBotRight: Bottom right.
const DrawCornerFlags kDrawCornerFlagLeft: Left.
const DrawCornerFlags kDrawCornerFlagRight: Right.
const DrawCornerFlags kDrawCornerFlagTop: Top.
const DrawCornerFlags kDrawCornerFlagTopLeft: Top left.
const DrawCornerFlags kDrawCornerFlagTopRight: Top right.
const FocusedFlags kFocusedFlagAnyWindow: IsWindowFocused(): Return true if any window is focused.
const FocusedFlags kFocusedFlagChildWindows: IsWindowFocused(): Return true if any children of the window is focused.
const FocusedFlags kFocusedFlagNone: Absence of other focused flags.
const FocusedFlags kFocusedFlagRootAndChildWindows: Composed flag.
const FocusedFlags kFocusedFlagRootWindow: IsWindowFocused(): Test from root window (top most parent of the current hierarchy)
const HoveredFlags kHoveredFlagAllowWhenBlockedByActiveItem: Return true even if an active item is blocking access to this item/window. Useful for Drag and Drop patterns.
const HoveredFlags kHoveredFlagAllowWhenBlockedByPopup: Return true even if a popup window is normally blocking access to this item/window.
const HoveredFlags kHoveredFlagAllowWhenDisabled: Return true even if the item is disabled.
const HoveredFlags kHoveredFlagAllowWhenOverlapped: Return true even if the position is overlapped by another window.
const HoveredFlags kHoveredFlagAnyWindow: IsWindowHovered() only: Return true if any window is hovered.
const HoveredFlags kHoveredFlagChildWindows: IsWindowHovered() only: Return true if any children of the window is hovered.
const HoveredFlags kHoveredFlagNone: Return true if directly over the item/window, not obstructed by another window, not obstructed by an active popup or modal blocking inputs under them.
const HoveredFlags kHoveredFlagRectOnly: Composed flag.
const HoveredFlags kHoveredFlagRootAndChildWindows: Composed flag.
const HoveredFlags kHoveredFlagRootWindow: IsWindowHovered() only: Test from root window (top most parent of the current hierarchy)
const InputTextFlags kInputTextFlagAllowTabInput: Pressing TAB input a \t character into the text field.
const InputTextFlags kInputTextFlagAlwaysInsertMode: Insert mode.
const InputTextFlags kInputTextFlagAutoSelectAll: Select entire text when first taking mouse focus.
const InputTextFlags kInputTextFlagCallbackAlways: Call user function every time. User code may query cursor position, modify text buffer.
const InputTextFlags kInputTextFlagCallbackCharFilter: Call user function to filter character. Modify data->EventChar to replace/filter input, or return 1 to discard character.
const InputTextFlags kInputTextFlagCallbackCompletion: Call user function on pressing TAB (for completion handling)
const InputTextFlags kInputTextFlagCallbackHistory: Call user function on pressing Up/Down arrows (for history handling)
const InputTextFlags kInputTextFlagCallbackResize: Callback on buffer capacity changes request (beyond buf_size parameter value)
const InputTextFlags kInputTextFlagCharsDecimal: Allow 0123456789.+-*&zwj;/
const InputTextFlags kInputTextFlagCharsHexadecimal: Allow 0123456789ABCDEFabcdef
const InputTextFlags kInputTextFlagCharsNoBlank: Filter out spaces, tabs.
const InputTextFlags kInputTextFlagCharsScientific: Allow 0123456789.+-*&zwj;/eE (Scientific notation input)
const InputTextFlags kInputTextFlagCharsUppercase: Turn a..z into A..Z
const InputTextFlags kInputTextFlagCtrlEnterForNewLine: In multi-line mode, unfocus with Enter, add new line with Ctrl+Enter (default is opposite: unfocus with Ctrl+Enter, add line with Enter).
const InputTextFlags kInputTextFlagEnterReturnsTrue: Return 'true' when Enter is pressed (as opposed to when the value was modified)
const InputTextFlags kInputTextFlagNoHorizontalScroll: Disable following the cursor horizontally.
const InputTextFlags kInputTextFlagNoUndoRedo: Disable undo/redo. Note that input text owns the text data while active, if you want to provide your own undo/redo stack you need e.g. to call ClearActiveID().
const InputTextFlags kInputTextFlagNone: Absence of other input text flags.
const InputTextFlags kInputTextFlagPassword: Password mode, display all characters as '*'.
const InputTextFlags kInputTextFlagReadOnly: Read-only mode.
const ItemFlags kItemFlagButtonRepeat: Button repeat.
const ItemFlags kItemFlagDefault: Absence of other item flags.
const ItemFlags kItemFlagDisabled: Disable interactions.
const ItemFlags kItemFlagNoNav: No Navigation.
const ItemFlags kItemFlagNoNavDefaultFocus: No Navigation Default Focus.
const ItemFlags kItemFlagSelectableDontClosePopup: MenuItem/Selectable() automatically closes current Popup window.
const ItemFlags kItemFlagsNoTabStop: No tab stop.
const KeyModifiers kKeyModifierAlt: Indicates ALT is held.
const KeyModifiers kKeyModifierCtrl: Indicates CTRL is held.
const KeyModifiers kKeyModifierNone: Indicates no key modifiers.
const KeyModifiers kKeyModifierShift: Indicates SHIFT is held.
const KeyModifiers kKeyModifierSuper: Indicates a "super key" is held (Cmd/Windows/etc.).
const SelectableFlags kSelectableFlagAllowDoubleClick: Generate press events on double clicks too.
const SelectableFlags kSelectableFlagDisabled: Cannot be selected, display grayed out text.
const SelectableFlags kSelectableFlagDontClosePopups: Clicking this don't close parent popup window.
const SelectableFlags kSelectableFlagNone: Absence of other selectable flags.
const SelectableFlags kSelectableFlagSpanAllColumns: Selectable frame can span all columns (text will still fit in current column)
const TabBarFlags kTabBarFlagAutoSelectNewTabs: Automatically select new tabs when they appear.
const TabBarFlags kTabBarFlagFittingPolicyDefault: Composed flag.
const TabBarFlags kTabBarFlagFittingPolicyMask: Composed flag.
const TabBarFlags kTabBarFlagFittingPolicyResizeDown: Resize tabs when they don't fit.
const TabBarFlags kTabBarFlagFittingPolicyScroll: Add scroll buttons when tabs don't fit.
const TabBarFlags kTabBarFlagNoCloseWithMiddleMouseButton: Disable behavior of closing tabs (that are submitted with p_open != NULL ) with middle mouse button. You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false .
const TabBarFlags kTabBarFlagNoTabListScrollingButtons: No scrolling buttons.
const TabBarFlags kTabBarFlagNoTooltip: Disable tooltips when hovering a tab.
const TabBarFlags kTabBarFlagNone: Absence of other tab bar flags.
const TabBarFlags kTabBarFlagReorderable: Allow manually dragging tabs to re-order them + New tabs are appended at the end of list.
const TabBarFlags kTabBarFlagTabListPopupButton: Tab list popup button.
const TabItemFlags kTabItemFlagNoCloseWithMiddleMouseButton: Disable behavior of closing tabs (that are submitted with p_open != NULL ) with middle mouse button. You can still repro this behavior on user's side with if (IsItemHovered() && IsMouseClicked(2)) *p_open = false .
const TabItemFlags kTabItemFlagNoPushId: Don't call PushID(tab->ID)/PopID() on BeginTabItem()/EndTabItem()
const TabItemFlags kTabItemFlagNone: Absence of other tab item flags.
const TabItemFlags kTabItemFlagSetSelected: Trigger flag to programmatically make the tab selected when calling BeginTabItem()
const TabItemFlags kTabItemFlagUnsavedDocument: Append '*' to title without affecting the ID; as a convenience to avoid using the ### operator. Also: tab is selected on closure and closure is deferred by one frame to allow code to undo it without flicker.
const TreeNodeFlags kTreeNodeFlagAllowItemOverlap: Hit testing to allow subsequent widgets to overlap this one.
const TreeNodeFlags kTreeNodeFlagBullet: Display a bullet instead of arrow.
const TreeNodeFlags kTreeNodeFlagCollapsingHeader: Composed flag indicating collapsing header.
const TreeNodeFlags kTreeNodeFlagDefaultOpen: Default node to be open.
const TreeNodeFlags kTreeNodeFlagFramePadding: Use FramePadding (even for an unframed text node) to vertically align text baseline to regular widget.
const TreeNodeFlags kTreeNodeFlagFramed: Full colored frame (e.g. for CollapsingHeader)
const TreeNodeFlags kTreeNodeFlagLeaf: No collapsing, no arrow (use as a convenience for leaf nodes).
const TreeNodeFlags kTreeNodeFlagNavLeftJumpsBackHere: (WIP) Nav: left direction may move to this TreeNode() from any of its child (items submitted between TreeNode and TreePop)
const TreeNodeFlags kTreeNodeFlagNoAutoOpenOnLog: Don't automatically and temporarily open node when Logging is active (by default logging will automatically open tree nodes)
const TreeNodeFlags kTreeNodeFlagNoTreePushOnOpen: Don't do a TreePush() when open (e.g. for CollapsingHeader) = no extra indent nor pushing on ID stack.
const TreeNodeFlags kTreeNodeFlagNone: Absence of other tree node flags.
const TreeNodeFlags kTreeNodeFlagOpenOnArrow: Only open when clicking on the arrow part. If kTreeNodeFlagOpenOnDoubleClick is also set, single-click arrow or double-click all box to open.
const TreeNodeFlags kTreeNodeFlagOpenOnDoubleClick: Need double-click to open node.
const TreeNodeFlags kTreeNodeFlagSelected: Draw as selected.
const ViewportFlags kViewportFlagNoDecoration: Platform Window: Disable platform decorations: title bar; borders; etc.
const ViewportFlags kViewportFlagNoFocusOnAppearing: Platform Window: Don't take focus when created.
const ViewportFlags kViewportFlagNoFocusOnClick: Platform Window: Don't take focus when clicked on.
const ViewportFlags kViewportFlagNoInputs: Platform Window: Make mouse pass through so we can drag this window while peaking behind it.
const ViewportFlags kViewportFlagNoRendererClear: Platform Window: Renderer doesn't need to clear the framebuffer ahead.
const ViewportFlags kViewportFlagNoTaskBarIcon: Platform Window: Disable platform task bar icon (for popups; menus; or all windows if ImGuiConfigFlags_ViewportsNoTaskBarIcons if set)
const ViewportFlags kViewportFlagNone: Absence of other viewport flags.
const ViewportFlags kViewportFlagTopMost: Platform Window: Display on top (for tooltips only)
const WindowFlags kWindowFlagAlwaysAutoResize: Window Flag to resize every window to its content every frame.
const WindowFlags kWindowFlagAlwaysHorizontalScrollbar: Window Flag to always show horizontal scrollbar (even if content Size.x < Size.x).
const WindowFlags kWindowFlagAlwaysUseWindowPadding: Window Flag to ensure child windows without border uses style.WindowPadding. Ignored by default for non-bordered child windows, because more convenient.
const WindowFlags kWindowFlagAlwaysVerticalScrollbar: Window Flag to always show vertical scrollbar (even if content Size.y < Size.y).
const WindowFlags kWindowFlagHorizontalScrollbar: Window Flag to allow horizontal scrollbar to appear (off by default). You may use SetNextWindowContentSize(Float2(width,0.0f)) , prior to calling Begin() to specify width.
const WindowFlags kWindowFlagMenuBar: Window Flag to state that this has a menu-bar.
const WindowFlags kWindowFlagNoBackground: Window Flag to disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f).
const WindowFlags kWindowFlagNoBringToFrontOnFocus: Window Flag to disable bringing window to front when taking focus. (Ex. clicking on it or programmatically giving it focus).
const WindowFlags kWindowFlagNoCollapse: Window Flag to disable user collapsing window by double-clicking on it.
const WindowFlags kWindowFlagNoDecoration: Special composed Window Flag to disable all decorative elements.
const WindowFlags kWindowFlagNoDocking: Disable docking of this window.
const WindowFlags kWindowFlagNoFocusOnAppearing: Window Flag to disable taking focus when transitioning from hidden to visible state.
const WindowFlags kWindowFlagNoInput: Special composed Window Flag to disable input.
const WindowFlags kWindowFlagNoMouseInputs: Window Flag to disable catching mouse, hovering test with pass through.
const WindowFlags kWindowFlagNoMove: Window Flag to disable user moving the window.
const WindowFlags kWindowFlagNoNav: Special composed Window Flag to disable navigation.
const WindowFlags kWindowFlagNoNavFocus: No focusing toward this window with gamepad/keyboard navigation (e.g. skipped by CTRL+TAB)
const WindowFlags kWindowFlagNoNavInputs: No gamepad/keyboard navigation within the window.
const WindowFlags kWindowFlagNoResize: Window Flag to disable user resizing with the lower-right grip.
const WindowFlags kWindowFlagNoSavedSettings: Window Flag to never load/save settings in .ini file.
const WindowFlags kWindowFlagNoScrollWithMouse: Window Flag to disable user vertically scrolling with mouse wheel. On child window, mouse wheel will be forwarded to the parent unless NoScrollbar is also set..
const WindowFlags kWindowFlagNoScrollbar: Window Flag to disable user moving the window.
const WindowFlags kWindowFlagNoTitleBar: Window Flag to disable the title bar.
const WindowFlags kWindowFlagNone: Indicates the absence of all other window flags.
const WindowFlags kWindowFlagUnsavedDocument: Append '*' to title without affecting the ID, as a convenience to avoid using the ### operator. When used in a tab/docking context, tab is selected on closure and closure is deferred by one frame to allow code to cancel the closure (with a confirmation popup, etc.) without flicker.