IApplicationWindow

Description

interface Tinman.Engine.Application.IApplicationWindow

Derived from

INativeWindow
IInputState
IRequestClose
IDisposableGeneric<IApplicationWindow>

Extended by

ApplicationWindow abstract

Base interface for classes that define a window which can host an IApplication application.

The object.ToString method of a an implementation class should return a human-understandable identifier for the window type and the native window flags, see INativeWindow.NativeHandleTypes and ApplicationUtil.ToString.

Public / Methods

Focus

public method Focus → ()

returns → bool

true if the input focus has been acquired, false if not.

Tries to acquire input focus.

Process​System​Messages

public method ProcessSystemMessages → ()

returns → bool

true if the window client area is dirty, false if not.

Processes all system messages for this window.

Resize

public method Resize → (1)

size in : Vec2I

The new size of the window client area (see WindowState.Normal.
If Vec2I.X or Vec2I.Y is negative, the window will be maximized, if possible (see WindowState.Maximized).
If Vec2I.X or Vec2I.Y is zero, the window will enter full-screen mode, if possible (see WindowState.Fullscreen).

Tries to change the current size of the application windows client area.

If the client size of an application window cannot be set by code (e.g. it is not a top-level window), the client size will remain unchanged and the State property will be WindowState.Normal.
If full-screen mode is not available, the window will be maximized instead, if possible.

Restore

public method Restore → ()

Restores the previous window state.

Depending on the current window state (see State), the Restore performs the following actions:

Text​Input​Begin

public method TextInputBegin → ()

The application has started to consume text input via InputEventType.Character messages.

Calls to TextInputBegin and TextInputEnd must be balanced and may be nested.

See also

InputEvent.Character

Text​Input​End

public method TextInputEnd → ()

The application has finished consuming text input via InputEventType.Character messages.

Calls to TextInputBegin and TextInputEnd must be balanced and may be nested.

Public / Attributes

Input​Settings

public attribute InputSettings → (get,set)

value : InputSettings

The input settings.

The current settings for processing raw input events.

Defaults to InputSettings.Default.

Is​Focused

public attribute IsFocused → (get)

value : bool

true if the application has the input focus, false if not.

Does the application window currently have the input focus?

Is​Mouse​Inside

public attribute IsMouseInside → (get)

value : bool

true if the mouse cursor is inside the client area, false if it is outside.

Is the mouse cursor currently inside the windows client area?

Is​Text​Input​Active

public attribute IsTextInputActive → (get)

value : bool

true if InputEventType.Character events are generated,
false if text input events may not be generated.

Returns whether the application window is generating text input via InputEventType.Character.

Even if this property returns false, an implementation may choose to still provide text input events. But if this property returns true, the implementation is required to provide text input events.

See also

IApplicationWindow.TextInputBegin
IApplicationWindow.TextInputEnd

Is​Top​Level

public attribute IsTopLevel → (get)

value : bool

true if this is a top-level window,
false if not, for example a control embedded in some GUI form.

Is this a top-level window?

Top-level windows can be put into full-screen mode and can be maximized.

Mouse​Captured

public attribute MouseCaptured → (get,set)

value : bool

true if the mouse is currently captured, false if not.

Is the mouse currently captured by the application window?

While the mouse cursor is captured, the application exhibits the following behaviour:

  • The mouse cursor is not visible and cannot leave the application window, therefore it is not possible to accidentally transfer input focus to another window.

  • The mouse cursor is locked at the center of the application window client area. This way unbounded relative mouse movement can be consumed.

Mouse​Cursor

public attribute MouseCursor → (get,set)

value : MouseCursor

The mouse cursor.

The mouse cursor to show inside the application window.

The default value is MouseCursor.Default.

On​Input

public attribute OnInput → (get)

value : IEventGeneric<InputEvent>

[not-null]
The input event source.

Returns the source for input event.

Resolution

public attribute Resolution → (get)

value : int32

[>0]
The current resolution, in dots per inch (DPI).

Returns the current resolution of the application window.

State

public attribute State → (get)

value : WindowState

The current state.

Returns the current state of the application window.

Title

public attribute Title → (get,set)

value : string

The window title or null.

The current window title.

If the title of an application window cannot be set by code (e.g. it is not a top-level window), the title will remain unchanged.

Extensions

Default​Graphics​Context​Factory

public static method DefaultGraphicsContextFactory → ()

returns → IGraphicsContextFactory

The created graphics context factory.

Creates the default graphics context factory for this application window.

This method delegates to GraphicsContextFactory.Create, passing INativeWindow.NativeHandleType, using the default order for native window type and feature flags.

TinmanException

If there is no factory available.