Package imgui

Class ImGuiWindowClass

java.lang.Object
imgui.binding.ImGuiStruct
imgui.binding.ImGuiStructDestroyable
imgui.ImGuiWindowClass
public final class ImGuiWindowClass extends ImGuiStructDestroyable
[ALPHA] Rarely used / very advanced uses only. Use with SetNextWindowClass() and DockSpace() functions. Important: the content of this class is still highly WIP and likely to change and be refactored before we stabilize Docking features. Please be mindful if using this. Provide hints: - To the platform backend via altered viewport flags (enable/disable OS decoration, OS task bar icons, etc.) - To the platform backend for OS level parent/child relationships of viewport. - To the docking system for various options and filtering.

  • Constructor Details

    • ImGuiWindowClass

      public ImGuiWindowClass()

    • ImGuiWindowClass

      public ImGuiWindowClass(long ptr)

  • Method Details

    • create

      protected long create()
      Specified by:
      create in class ImGuiStructDestroyable

    • getClassId

      public int getClassId()
      User data. 0 = Default class (unclassed). Windows of different classes cannot be docked with each others.

    • setClassId

      public void setClassId(int value)
      User data. 0 = Default class (unclassed). Windows of different classes cannot be docked with each others.

    • getParentViewportId

      public int getParentViewportId()
      Hint for the platform backend. If non-zero, the platform backend can create a parent<>child relationship between the platform windows. Not conforming backends are free to e.g. parent every viewport to the main viewport or not.

    • setParentViewportId

      public void setParentViewportId(int value)
      Hint for the platform backend. If non-zero, the platform backend can create a parent<>child relationship between the platform windows. Not conforming backends are free to e.g. parent every viewport to the main viewport or not.

    • getFocusRouteParentWindowId

      public int getFocusRouteParentWindowId()
      ID of parent window for shortcut focus route evaluation, e.g. Shortcut() call from Parent Window will succeed when this window is focused.

    • setFocusRouteParentWindowId

      public void setFocusRouteParentWindowId(int value)
      ID of parent window for shortcut focus route evaluation, e.g. Shortcut() call from Parent Window will succeed when this window is focused.

    • getViewportFlagsOverrideSet

      public int getViewportFlagsOverrideSet()
      Viewport flags to set when a window of this class owns a viewport. This allows you to enforce OS decoration or task bar icon, override the defaults on a per-window basis.

    • setViewportFlagsOverrideSet

      public void setViewportFlagsOverrideSet(int value)
      Viewport flags to set when a window of this class owns a viewport. This allows you to enforce OS decoration or task bar icon, override the defaults on a per-window basis.

    • addViewportFlagsOverrideSet

      public void addViewportFlagsOverrideSet(int flags)
      Viewport flags to set when a window of this class owns a viewport. This allows you to enforce OS decoration or task bar icon, override the defaults on a per-window basis.

    • removeViewportFlagsOverrideSet

      public void removeViewportFlagsOverrideSet(int flags)
      Viewport flags to set when a window of this class owns a viewport. This allows you to enforce OS decoration or task bar icon, override the defaults on a per-window basis.

    • hasViewportFlagsOverrideSet

      public boolean hasViewportFlagsOverrideSet(int flags)
      Viewport flags to set when a window of this class owns a viewport. This allows you to enforce OS decoration or task bar icon, override the defaults on a per-window basis.

    • getViewportFlagsOverrideClear

      public int getViewportFlagsOverrideClear()
      Viewport flags to clear when a window of this class owns a viewport. This allows you to enforce OS decoration or task bar icon, override the defaults on a per-window basis.

    • setViewportFlagsOverrideClear

      public void setViewportFlagsOverrideClear(int value)
      Viewport flags to clear when a window of this class owns a viewport. This allows you to enforce OS decoration or task bar icon, override the defaults on a per-window basis.

    • addViewportFlagsOverrideClear

      public void addViewportFlagsOverrideClear(int flags)
      Viewport flags to clear when a window of this class owns a viewport. This allows you to enforce OS decoration or task bar icon, override the defaults on a per-window basis.

    • removeViewportFlagsOverrideClear

      public void removeViewportFlagsOverrideClear(int flags)
      Viewport flags to clear when a window of this class owns a viewport. This allows you to enforce OS decoration or task bar icon, override the defaults on a per-window basis.

    • hasViewportFlagsOverrideClear

      public boolean hasViewportFlagsOverrideClear(int flags)
      Viewport flags to clear when a window of this class owns a viewport. This allows you to enforce OS decoration or task bar icon, override the defaults on a per-window basis.

    • getTabItemFlagsOverrideSet

      public int getTabItemFlagsOverrideSet()
      [EXPERIMENTAL] TabItem flags to set when a window of this class gets submitted into a dock node tab bar. May use with ImGuiTabItemFlags_Leading or ImGuiTabItemFlags_Trailing.

    • setTabItemFlagsOverrideSet

      public void setTabItemFlagsOverrideSet(int value)
      [EXPERIMENTAL] TabItem flags to set when a window of this class gets submitted into a dock node tab bar. May use with ImGuiTabItemFlags_Leading or ImGuiTabItemFlags_Trailing.

    • addTabItemFlagsOverrideSet

      public void addTabItemFlagsOverrideSet(int flags)
      [EXPERIMENTAL] TabItem flags to set when a window of this class gets submitted into a dock node tab bar. May use with ImGuiTabItemFlags_Leading or ImGuiTabItemFlags_Trailing.

    • removeTabItemFlagsOverrideSet

      public void removeTabItemFlagsOverrideSet(int flags)
      [EXPERIMENTAL] TabItem flags to set when a window of this class gets submitted into a dock node tab bar. May use with ImGuiTabItemFlags_Leading or ImGuiTabItemFlags_Trailing.

    • hasTabItemFlagsOverrideSet

      public boolean hasTabItemFlagsOverrideSet(int flags)
      [EXPERIMENTAL] TabItem flags to set when a window of this class gets submitted into a dock node tab bar. May use with ImGuiTabItemFlags_Leading or ImGuiTabItemFlags_Trailing.

    • getDockNodeFlagsOverrideSet

      public int getDockNodeFlagsOverrideSet()
      [EXPERIMENTAL] Dock node flags to set when a window of this class is hosted by a dock node (it doesn't have to be selected!)

    • setDockNodeFlagsOverrideSet

      public void setDockNodeFlagsOverrideSet(int value)
      [EXPERIMENTAL] Dock node flags to set when a window of this class is hosted by a dock node (it doesn't have to be selected!)

    • addDockNodeFlagsOverrideSet

      public void addDockNodeFlagsOverrideSet(int flags)
      [EXPERIMENTAL] Dock node flags to set when a window of this class is hosted by a dock node (it doesn't have to be selected!)

    • removeDockNodeFlagsOverrideSet

      public void removeDockNodeFlagsOverrideSet(int flags)
      [EXPERIMENTAL] Dock node flags to set when a window of this class is hosted by a dock node (it doesn't have to be selected!)

    • hasDockNodeFlagsOverrideSet

      public boolean hasDockNodeFlagsOverrideSet(int flags)
      [EXPERIMENTAL] Dock node flags to set when a window of this class is hosted by a dock node (it doesn't have to be selected!)

    • getDockingAlwaysTabBar

      public boolean getDockingAlwaysTabBar()
      Set to true to enforce single floating windows of this class always having their own docking node (equivalent of setting the global io.ConfigDockingAlwaysTabBar)

    • setDockingAlwaysTabBar

      public void setDockingAlwaysTabBar(boolean value)
      Set to true to enforce single floating windows of this class always having their own docking node (equivalent of setting the global io.ConfigDockingAlwaysTabBar)

    • getDockingAllowUnclassed

      public boolean getDockingAllowUnclassed()
      Set to true to allow windows of this class to be docked/merged with an unclassed window.

    • setDockingAllowUnclassed

      public void setDockingAllowUnclassed(boolean value)
      Set to true to allow windows of this class to be docked/merged with an unclassed window.