API reference
Preparing search index…

ImGui.ImGuiMultiSelectFlags

Const
ImGuiMultiSelectFlags: Readonly<
    {
        BoxSelect1d: 64;
        BoxSelect2d: 128;
        BoxSelectNoScroll: 256;
        ClearOnClickVoid: 1024;
        ClearOnEscape: 512;
        NavWrapX: 65536;
        NoAutoClear: 16;
        NoAutoClearOnReselect: 32;
        NoAutoSelect: 8;
        None: 0;
        NoRangeSelect: 4;
        NoSelectAll: 2;
        ScopeRect: 4096;
        ScopeWindow: 2048;
        SelectOnClick: 8192;
        SelectOnClickRelease: 16384;
        SingleSelect: 1;
    },
> = ...

Multi-selection gestures, clearing rules and interaction scope.

Type declaration

  • ReadonlyBoxSelect1d: 64

    Box-select items sharing the same horizontal position and width.

  • ReadonlyBoxSelect2d: 128

    Box-select varying widths/positions; checks clipped items and costs more.

  • ReadonlyBoxSelectNoScroll: 256

    Do not auto-scroll when box selection reaches scope edges.

  • ReadonlyClearOnClickVoid: 1024

    Clear selection when clicking empty space inside the scope.

  • ReadonlyClearOnEscape: 512

    Escape clears selection while this scope has focus.

  • ReadonlyNavWrapX: 65536

    Temporary option: wrap horizontal navigation between rows.

  • ReadonlyNoAutoClear: 16

    Preserve existing selection when navigating or selecting another item.

  • ReadonlyNoAutoClearOnReselect: 32

    Preserve the selection when clicking an already-selected item.

  • ReadonlyNoAutoSelect: 8

    Navigation does not automatically select the focused item.

  • ReadonlyNone: 0

    Use standard multi-selection behavior.

  • ReadonlyNoRangeSelect: 4

    Disable Shift ranges and merging of contiguous box-selection requests.

  • ReadonlyNoSelectAll: 2

    Disable the Ctrl+A select-all shortcut.

  • ReadonlyScopeRect: 4096

    Limit box selection and empty-space clearing to Begin/EndMultiSelect bounds.

  • ReadonlyScopeWindow: 2048

    Use the whole window for box selection and empty-space clearing (default).

  • ReadonlySelectOnClick: 8192

    Select an unselected item on mouse-down (default).

  • ReadonlySelectOnClickRelease: 16384

    Select on release, allowing an unselected item to be dragged unchanged.

  • ReadonlySingleSelect: 1

    Limit selection to one item while retaining the multi-select API.

Source & inheritance

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0