Api
Editor Classes
PanelWindow
chevron_left Editor Classes
class
PanelWindow

Constructors

functionsPanelWindow

Properties

data_objectAllowNestedFramedata_objectAlwaysFullFrameRatedata_objectBackgroundColordata_objectBorderlessdata_objectCanMaximizedata_objectIsFocuseddata_objectIsMaximizeddata_objectIsOpendata_objectMaxSizedata_objectMinSizedata_objectMousePositiondata_objectOnCloseRequesteddata_objectPositiondata_objectResizeBorderdata_objectRootdata_objectSizedata_objectSizeToContentsdata_objectTitledata_objectVSync

Methods

functionsDisposefunctionsFocusfunctionsMinimizefunctionsPickFolderfunctionsPickOpenFilefunctionsPickSaveFilefunctionsRequestClosefunctionsToggleMaximized

Static Properties

data_objectAlldata_objectFocused

Static Methods

functionsFromPanelfunctionsPopup
PanelWindow
An OS window whose entire contents are panel UI. It owns the window, its swap chain and the UI inside it. Its input comes straight from SDL and never touches the engine's input system - there's no widget toolkit involved anywhere. <para> Editor only. A game has one window and draws its UI into that. </para>
class Editor .
sealedSandbox.Tools

build Constructors 1

PanelWindow (title, size)
Open a window and start running UI in it.

data_object Properties 19

AllowNestedFrame
bool
Let frames run inside a frame that's already running - see IPanelWindow.
AlwaysFullFrameRate
bool
Keep drawing at the display's frame rate even when nobody is looking at this window. Idle windows are paced right down - set this for one with something moving in it that has to keep moving, like a video or a live preview.
BackgroundColor
Color
What the window clears to before the UI is drawn.
Borderless
bool
True if we're drawing the title bar and borders ourselves.
CanMaximize
bool
Whether the OS is allowed to maximize the window - the caption button, double clicking the title bar, Win+Up, snap. Windows drawing their own chrome check this for their maximize button too.
IsFocused
bool
Does this window have keyboard focus?
IsMaximized
bool
Is the window maximized?
IsOpen
bool
Is this window still open?
MaxSize
Vector2
The largest the user can resize the window to. Zero means no limit.
MinSize
Vector2
The smallest the user can resize the window to. Zero means no limit.
MousePosition
Vector2
Where the cursor is, in this window's pixels.
OnCloseRequested
Action
Called when the user clicks the window's close button. The window closes if this is null.
Position
Vector2
Position of the window on the desktop, in pixels.
ResizeBorder
float
How far from the edge of a borderless window counts as a resize handle, in pixels.
Root
RootPanel
The panel everything in this window hangs off.
Size
Vector2
Size of the window's client area, in pixels.
SizeToContents
bool
Resize the window to fit the first thing on the surface. Popups use this so a menu is exactly as big as its contents, however far outside the parent window that ends up.
Title
string
The window's title bar text.
VSync
bool
Does this window's present wait for the display?

functions Methods 8

Dispose ()
Close the window and delete its panels.
Focus ()
Bring the window to the front.
Minimize ()
Minimize the window.
PickFolder (defaultPath)
Task`1
Ask the OS to pick a folder, starting at . Null when the user cancels. One dialog at a time - asking again while one is open joins the first.
PickOpenFile (defaultPath, filters)
Task`1
Ask the OS for a file to open. The filter is name and extension list pairs, like "Scene files|scene;prefab|All files|*". Null when the user cancels.
PickSaveFile (defaultPath, filters)
Task`1
Ask the OS where to save a file. can end in a suggested file name. Filters as in Editor.PanelWindow.PickOpenFile(System.String,System.String). Null when the user cancels.
RequestClose ()
The user clicked the window's close button.
ToggleMaximized ()
Maximize the window, or put it back if it already is.

data_object Static Properties 2

All
IReadOnlyList`1
Every window that's currently open.
Focused
PanelWindow
The window the OS is giving keyboard input to, if it's one of ours.

functions Static Methods 2

FromPanel (panel)
PanelWindow
The window a panel is being shown in, if it's one of ours.
Popup (parent, position, size)
PanelWindow
Open a popup - a borderless window that sits above its parent and can hang outside it, the way an OS menu does. The position is in the parent's client pixels.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.