Commands

[antongit]

All of the commands exist only in Immediate mode. Some Retained nodes are using these commands internally and offer their functionality via pins. Later we'll see if we need SOME of the commands also as nodes in Retained mode, those will be picked and carefully wrapped.

Window Manipulation

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L354

• [x] SetNextWindowPos > ...(Vector2) TODO: Questioned. Part of the Window. See vvvv/VL.StandardLibs#41
• [x] SetNextWindowSize > ...(Vector2) TODO: Questioned. Part of the Window
• [x] SetNextWindowSizeConstraints > ...(Min, Max:Vector2)
• [x] SetNextWindowContentSize > ...(Vector2)
• ~[ ] SetNextWindowCollapsed > ...(Collapsed:bool)~ Part of the Window
• [x] SetNextWindowFocus
• [x] SetNextWindowBgAlpha

Window Scrolling

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L382

• [x] SetScrollX
• [x] SetScrollY
• [x] SetScrollHereX
• [x] SetScrollHereY
• [x] SetScrollFromPosX
• [x] SetScrollFromPosY

Parameters stacks

https://github.com/ocornut/imgui/blob/e57871bb95faec757e51214bc0e1ae29b13258ab/imgui.h#L400

• [x] SetNextItemWidth
• [ ] PushItemWidth
• [ ] PopItemWidth
• [ ] PushTextWrapPos
• [ ] PopTextWrapPos
• [ ] PushAllowKeyboardFocus
• [ ] PopAllowKeyboardFocus
• [ ] PushButtonRepeat
• [ ] PopButtonRepeat

Cursor / Layout

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L423

• [x] SameLine
• [x] NewLine
• [x] Spacing
• [x] Indent
• [x] Unindent
• [x] SetCursorPos > SetCursorPosition (Vector2)
• [x] SetCursorPosX
• [x] SetCursorPosY
• [x] SetCursorScreenPos
• [x] AlignTextToFramePadding
• [x] Separator
• [x] Dummy - is it a command or a Widget ?
• [x] Group (Begin/End)

ID stack/scopes

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L454

• [x] PushID / PopID = SetID

Widgets: Color Editor/Picker

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L579

• [x] SetColorEditOptions

Widgets: Trees

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L589

• [x] SetNextItemOpen - Probably we don't need it, because it is used internally in CollapsingHeader and TreeNode Immediate-Mode widgets. TODO: Remove it if we don't need it

Popups: open/close functions

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L677

• [x] OpenPopup
• [x] CloseCurrentPopup

Only Immediate

Tables

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L731

• [x] TableNextColumn
• [x] TableNextRow
• [x] TableSetupScrollFreeze
• [x] TableHeadersRow
• [x] TableSetColumnEnabled
• [x] TableSetColumnIndex
• [x] TableSetupColumn (1x1 copied from the Retained mode, added just for the completion to the commands)
• [x] TableSetBgColor
• [x] TableHeader

Tabs

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L773

• [x] SetTabItemClosed - Not sure we need it. See the HowTo Tabs from the Immediate section. TODO: Remove it if we don't need it

Drag and Drop

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L791

• [ ] BeginDragDropSource
• [ ] SetDragDropPayload
• [ ] EndDragDropSource
• [ ] BeginDragDropTarget
• [ ] AcceptDragDropPayload
• [ ] EndDragDropTarget
• [ ] GetDragDropPayload - it is a "query", but should it be sorted to queries or left here by the commands?

Clipping

• [ ] PushClipRect
• [ ] PopClipRect

Focus, Activation

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L816

• [x] SetItemDefaultFocus
• [x] SetKeyboardFocusHere

Item/Widgets Utilities and Query Functions

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L821

• [x] SetItemAllowOverlap - couldn't find example how to use it

Input Utilities: Mouse / Keyboard / Gamepad

https://github.com/ocornut/imgui/blob/e57871bb95faec757e51214bc0e1ae29b13258ab/imgui.h#L887

• [ ] SetNextFrameWantCaptureKeyboard
• [ ] SetMouseCursor
• [ ] SetNextFrameWantCaptureMouse

Inputs Utilities: Mouse

• [x] ResetMouseDragDelta Ommited

Clipboard Utilities

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L910

• [x] SetClipboardText
• [x] GetClipboardText - it is actually a query, but added right away for completeness. Used ChannelWidget.

Settings/.Ini Utilities

https://github.com/ocornut/imgui/blob/2d38bc99b3b0013952d3d390397297083b767972/imgui.h#L912

• [x] LoadIniSettingsFromDisk
• [x] LoadIniSettingsFromMemory - TODO: Not sure if channels should be involved
• [x] SaveIniSettingsToDisk
• [x] SaveIniSettingsToMemory - TODO: Not sure if channels should be involved
• TODO Check the Retained mode counterparts

Docking [Beta API]

https://github.com/ocornut/imgui/blob/c191faf0ba478e9c58a69c63306986a21ebfb6e4/imgui.h#L803

• [ ] DockSpace
• [ ] DocSpaceOverViewport
• [ ] SetNextWindowDockID
• [ ] SetNextWindowClass ?

Logging / Capture

• [ ] LogToTTY
• [ ] LogToFile
• [ ] LogToClipboard
• [ ] LogFinish
• [ ] LogButtons
• [ ] LogText

Misc Utils

https://github.com/ocornut/imgui/blob/e57871bb95faec757e51214bc0e1ae29b13258ab/imgui.h#L866

• [ ] SetStateStorage

Context

https://github.com/ocornut/imgui/blob/e57871bb95faec757e51214bc0e1ae29b13258ab/imgui.h#L285

Not sure if it's way too low level

• [ ] CreateContext
• [ ] DestroyContext
• [ ] SetCurrentContext

[antongit]

Questions:

• [x] Should we treat X, Y separately or as a Vector?
• [x] Sometimes it's hard to decide if this or that is command or widget.