/***********************************************************************
System Object
***********************************************************************/
/// <summary>
/// Represents a screen.
/// </summary>
class
INativeScreen
:
public
virtual
IDescriptable
,
public
Description
<
INativeScreen
>
{
public
:
/// <summary>
/// Get the bounds of the screen.
/// </summary>
/// <returns>The bounds of the screen.</returns>
virtual
NativeRect
GetBounds
()=
0
;
/// <summary>
/// Get the bounds of the screen client area.
/// </summary>
/// <returns>The bounds of the screen client area.</returns>
virtual
NativeRect
GetClientBounds
()=
0
;
/// <summary>
/// Get the name of the screen.
/// </summary>
/// <returns>The name of the screen.</returns>
virtual
WString
GetName
()=
0
;
/// <summary>
/// Test is the screen is a primary screen.
/// </summary>
/// <returns>Returns true if the screen is a primary screen.</returns>
virtual
bool
IsPrimary
()=
0
;
/// <summary>
/// Get the scaling for the screen's horizontal edge.
/// </summary>
/// <returns>The scaling. For example, in Windows when you have a 96 DPI, this function returns 1.0.</returns>
virtual
double
GetScalingX
() =
0
;
/// <summary>
/// Get the scaling for the screen's vertical edge.
/// </summary>
/// <returns>The scaling. For example, in Windows when you have a 96 DPI, this function returns 1.0.</returns>
virtual
double
GetScalingY
() =
0
;
};
/// <summary>
/// Represents a cursor.
/// </summary>
class
INativeCursor
:
public
virtual
IDescriptable
,
public
Description
<
INativeCursor
>
{
public
:
/// <summary>
/// Represents a predefined cursor type.
/// </summary>
enum
SystemCursorType
{
/// <summary>
/// Small waiting cursor.
/// </summary>
SmallWaiting
,
/// <summary>
/// large waiting cursor.
/// </summary>
LargeWaiting
,
/// <summary>
/// Arrow cursor.
/// </summary>
Arrow
,
/// <summary>
/// Cross cursor.
/// </summary>
Cross
,
/// <summary>
/// Hand cursor.
/// </summary>
Hand
,
/// <summary>
/// Help cursor.
/// </summary>
Help
,
/// <summary>
/// I beam cursor.
/// </summary>
IBeam
,
/// <summary>
/// Sizing in all direction cursor.
/// </summary>
SizeAll
,
/// <summary>
/// Sizing NE-SW cursor.
/// </summary>
SizeNESW
,
/// <summary>
/// Sizing N-S cursor.
/// </summary>
SizeNS
,
/// <summary>
/// Sizing NW-SE cursor.
/// </summary>
SizeNWSE
,
/// <summary>
/// Sizing W-E cursor.
/// </summary>
SizeWE
,
/// <summary>
/// Number of available cursors, this is not an available cursor by itself.
/// </summary>
LastSystemCursor
=
SizeWE
,
};
static
const
vint
SystemCursorCount
=
LastSystemCursor
+
1
;
public
:
/// <summary>
/// Test is the cursor a system provided cursor.
/// </summary>
/// <returns>Returns true if the cursor a system provided cursor.</returns>
virtual
bool
IsSystemCursor
()=
0
;
/// <summary>
/// Get the cursor type if the cursor a system provided cursor.
/// Convert point from native coordinate to GUI coordinate.
/// </summary>
/// <returns>The converted result.</returns>
/// <param name="value">The coordinate to convert.</param>
virtual
Point
Convert
(
NativePoint
value
) =
0
;
/// <summary>
/// Convert point from GUI coordinate to native coordinate.
/// </summary>
/// <returns>The converted result.</returns>
/// <param name="value">The coordinate to convert.</param>
virtual
NativePoint
Convert
(
Point
value
) =
0
;
/// <summary>
/// Convert size from native coordinate to GUI coordinate.
/// </summary>
/// <returns>The converted result.</returns>
/// <param name="value">The coordinate to convert.</param>
virtual
Size
Convert
(
NativeSize
value
) =
0
;
/// <summary>
/// Convert size from GUI coordinate to native coordinate.
/// </summary>
/// <returns>The converted result.</returns>
/// <param name="value">The coordinate to convert.</param>
virtual
NativeSize
Convert
(
Size
value
) =
0
;
/// <summary>
/// Convert margin from native coordinate to GUI coordinate.
/// </summary>
/// <returns>The converted result.</returns>
/// <param name="value">The coordinate to convert.</param>
virtual
Margin
Convert
(
NativeMargin
value
) =
0
;
/// <summary>
/// Convert margin from GUI coordinate to native coordinate.
/// </summary>
/// <returns>The converted result.</returns>
/// <param name="value">The coordinate to convert.</param>
virtual
NativeMargin
Convert
(
Margin
value
) =
0
;
/// <summary>
/// Get the bounds of the window.
/// </summary>
/// <returns>The bounds of the window.</returns>
virtual
NativeRect
GetBounds
()=
0
;
/// <summary>
/// Set the bounds of the window.
/// </summary>
/// <param name="bounds">The bounds of the window.</param>
virtual
void
SetBounds
(
const
NativeRect
&
bounds
)=
0
;
/// <summary>
/// Get the client size of the window.
/// </summary>
/// <returns>The client size of the window.</returns>
virtual
NativeSize
GetClientSize
()=
0
;
/// <summary>
/// Set the client size of the window.
/// </summary>
/// <param name="size">The client size of the window.</param>
virtual
void
SetClientSize
(
NativeSize
size
)=
0
;
/// <summary>
/// Get the client bounds in screen space.
/// </summary>
/// <returns>The client bounds in screen space.</returns>
virtual
NativeRect
GetClientBoundsInScreen
()=
0
;
/// <summary>
/// Get the title of the window. A title will be displayed as a name of this window.
/// </summary>
/// <returns>The title of the window.</returns>
virtual
WString
GetTitle
()=
0
;
/// <summary>
/// Set the title of the window. A title will be displayed as a name of this window.
/// </summary>
/// <param name="title">The title of the window.</param>
virtual
void
SetTitle
(
WString
title
)=
0
;
/// <summary>
/// Get the mouse cursor of the window. When the mouse is on the window, the mouse cursor will be rendered.
/// </summary>
/// <returns>The mouse cursor of the window.</returns>
virtual
INativeCursor
*
GetWindowCursor
()=
0
;
/// <summary>
/// Set the mouse cursor of the window. When the mouse is on the window, the mouse cursor will be rendered.
/// </summary>
/// <param name="cursor">The mouse cursor of the window.</param>
virtual
void
SetWindowCursor
(
INativeCursor
*
cursor
)=
0
;
/// <summary>
/// Get the caret point of the window. When an input method editor is opened, the input text box will be located to the caret point.
/// </summary>
/// <returns>The caret point of the window.</returns>
virtual
NativePoint
GetCaretPoint
()=
0
;
/// <summary>
/// Set the caret point of the window. When an input method editor is opened, the input text box will be located to the caret point.
/// </summary>
/// <param name="point">The caret point of the window.</param>
virtual
void
SetCaretPoint
(
NativePoint
point
)=
0
;
/// <summary>
/// Get the parent window.
/// A parent window doesn't contain a child window. It always displayed below the child windows. When a parent window is minimized or restored, so as its child windows.
/// </summary>
/// <returns>The parent window.</returns>
virtual
INativeWindow
*
GetParent
()=
0
;
/// <summary>
/// Set the parent window. A parent window doesn't contain a child window. It always displayed below the child windows. When a parent window is minimized or restored, so as its child windows.
/// Such window is expected to be disabled activation, [M:vl.presentation.INativeWindow.DisableActivate] must be called manually.
/// Such window is expected to have a parent window, [M:vl.presentation.INativeWindow.SetParent] must be called before [M:vl.presentation.INativeWindow.ShowDeactivated].
/// This window is automatically closed when the top level window is deactivated or clicked.
/// </summary>
Tooltip
,
/// <summary>
/// A popup window.
/// Such window is expected to be disabled activation, [M:vl.presentation.INativeWindow.DisableActivate] must be called manually.
/// Such window is expected to have a parent window, [M:vl.presentation.INativeWindow.SetParent] must be called before [M:vl.presentation.INativeWindow.ShowDeactivated].
/// This window is automatically closed when the top level window is deactivated or clicked.
/// </summary>
Popup
,
/// <summary>
/// A menu window.
/// Such window is expected to be disabled activation, [M:vl.presentation.INativeWindow.DisableActivate] must be called manually.
/// Such window is expected to have a parent window, [M:vl.presentation.INativeWindow.SetParent] must be called before [M:vl.presentation.INativeWindow.ShowDeactivated].
/// This window is automatically closed when the top level window is deactivated or clicked.
/// </summary>
Menu
,
};
/// <summary>
/// Get the window mode.
/// </summary>
/// <returns>The window mode.</summary>
virtual
WindowMode
GetWindowMode
() =
0
;
/// <summary>
/// Enable the window customized frame mode.
/// </summary>
virtual
void
EnableCustomFrameMode
()=
0
;
/// <summary>
/// Disable the window customized frame mode.
/// </summary>
virtual
void
DisableCustomFrameMode
()=
0
;
/// <summary>
/// Test is the window customized frame mode enabled.
/// </summary>
/// <returns>Returns true if the window customized frame mode is enabled.</returns>
virtual
bool
IsCustomFrameModeEnabled
()=
0
;
/// <summary>
/// Get the amount of the border. The window template may need this value to calculate where to put the client area.
/// </summary>
/// <returns>Returns the amount of the border.</returns>
virtual
NativeMargin
GetCustomFramePadding
() =
0
;
/// <summary>Window size state.</summary>
enum
WindowSizeState
{
/// <summary>Minimized.</summary>
Minimized
,
/// <summary>Restored.</summary>
Restored
,
/// <summary>Maximized.</summary>
Maximized
,
};
/// <summary>
/// Get the icon.
/// </summary>
/// <returns>Returns the icon.</returns>
virtual
Ptr
<
GuiImageData
>
GetIcon
()=
0
;
/// <summary>
/// Set the icon.
/// </summary>
/// <param name="icon">The icon. Set to null to use the default icon.</param>
virtual
void
SetIcon
(
Ptr
<
GuiImageData
>
icon
)=
0
;
/// <summary>
/// Get the window size state.
/// </summary>
/// <returns>Returns the window size state.</returns>
virtual
WindowSizeState
GetSizeState
()=
0
;
/// <summary>
/// Show the window.
/// If the window disabled activation, this function enables it again.
/// </summary>
virtual
void
Show
()=
0
;
/// <summary>
/// Show the window without activation.
/// </summary>
virtual
void
ShowDeactivated
()=
0
;
/// <summary>
/// Restore the window.
/// </summary>
virtual
void
ShowRestored
()=
0
;
/// <summary>
/// Maximize the window.
/// </summary>
virtual
void
ShowMaximized
()=
0
;
/// <summary>
/// Minimize the window.
/// </summary>
virtual
void
ShowMinimized
()=
0
;
/// <summary>
/// Hide the window.
/// </summary>
/// <param name="closeWindow">Set to true to really close the window. Or the window will just be hidden. This parameter only affect the main window.</param>
virtual
void
Hide
(
bool
closeWindow
)=
0
;
/// <summary>
/// Test is the window visible.
/// </summary>
/// <returns>Returns true if the window is visible.</returns>
virtual
bool
IsVisible
()=
0
;
/// <summary>
/// Enable the window.
/// </summary>
virtual
void
Enable
()=
0
;
/// <summary>
/// Disable the window.
/// </summary>
virtual
void
Disable
()=
0
;
/// <summary>
/// Test is the window enabled.
/// </summary>
/// <returns>Returns true if the window is enabled.</returns>
virtual
bool
IsEnabled
()=
0
;
/// <summary>
/// Set focus to the window.
/// A window with activation disabled cannot receive focus.
/// </summary>
virtual
void
SetFocus
()=
0
;
/// <summary>
/// Test is the window focused.
/// </summary>
/// <returns>Returns true if the window is focused.</returns>
virtual
bool
IsFocused
()=
0
;
/// <summary>
/// Activate to the window.
/// If the window disabled activation, this function enables it again.
/// </summary>
virtual
void
SetActivate
()=
0
;
/// <summary>
/// Test is the window activated.
/// </summary>
/// <returns>Returns true if the window is activated.</returns>
virtual
bool
IsActivated
()=
0
;
/// <summary>
/// Show the icon in the task bar.
/// </summary>
virtual
void
ShowInTaskBar
()=
0
;
/// <summary>
/// Hide the icon in the task bar.
/// </summary>
virtual
void
HideInTaskBar
()=
0
;
/// <summary>
/// Test is the window icon appeared in the task bar.
/// </summary>
/// <returns>Returns true if the window icon appears in the task bar.</returns>
virtual
bool
IsAppearedInTaskBar
()=
0
;
/// <summary>
/// Enable activation to the window.
/// </summary>
virtual
void
EnableActivate
()=
0
;
/// <summary>
/// Disable activation to the window.
/// Clicking a window with activation disabled doesn't bring activation and focus.
/// Activation will be automatically enabled by calling <see cref="Show"/> or <see cref="SetActivate"/>.
/// </summary>
virtual
void
DisableActivate
()=
0
;
/// <summary>
/// Test is the window allowed to be activated.
/// </summary>
/// <returns>Returns true if the window is allowed to be activated.</returns>
virtual
bool
IsEnabledActivate
()=
0
;
/// <summary>
/// Require mouse message capturing to this window. If the capture is required, all mouse message will be send to this window.
/// When the window becomes invisible after calling this function, the window will still receive mouse messages, if the OS supports this feature.
/// Otherwise, the capturing must be released when the window becomes invisible.
/// </summary>
/// <returns>Returns true if this operation succeeded.</returns>
virtual
bool
RequireCapture
()=
0
;
/// <summary>
/// Release mouse message capturing to this window. If the capture is required, all mouse message will be send to this window.
/// </summary>
/// <returns>Returns true if this operation succeeded.</returns>
virtual
bool
ReleaseCapture
()=
0
;
/// <summary>
/// Test if the window is capturing mouse messages.
/// </summary>
/// <returns>Returns true if the window is capturing mouse messages.</returns>
virtual
bool
IsCapturing
()=
0
;
/// <summary>
/// Test is the maximize box visible.
/// </summary>
/// <returns>Returns true if the maximize box is visible.</returns>
virtual
bool
GetMaximizedBox
()=
0
;
/// <summary>
/// Make the maximize box visible or invisible.
/// </summary>
/// <param name="visible">True to make the maximize box visible.</param>
virtual
void
SetMaximizedBox
(
bool
visible
)=
0
;
/// <summary>
/// Test is the minimize box visible.
/// </summary>
/// <returns>Returns true if the minimize box is visible.</returns>
virtual
bool
GetMinimizedBox
()=
0
;
/// <summary>
/// Make the minimize box visible or invisible.
/// </summary>
/// <param name="visible">True to make the minimize box visible.</param>
virtual
void
SetMinimizedBox
(
bool
visible
)=
0
;
/// <summary>
/// Test is the border visible.
/// </summary>
/// <returns>Returns true if the border is visible.</returns>
virtual
bool
GetBorder
()=
0
;
/// <summary>
/// Make the border visible or invisible.
/// </summary>
/// <param name="visible">True to make the border visible.</param>
virtual
void
SetBorder
(
bool
visible
)=
0
;
/// <summary>
/// Test is the size box visible.
/// </summary>
/// <returns>Returns true if the size box is visible.</returns>
virtual
bool
GetSizeBox
()=
0
;
/// <summary>
/// Make the size box visible or invisible.
/// </summary>
/// <param name="visible">True to make the size box visible.</param>
virtual
void
SetSizeBox
(
bool
visible
)=
0
;
/// <summary>
/// Test is the icon visible.
/// </summary>
/// <returns>Returns true if the icon is visible.</returns>
virtual
bool
GetIconVisible
()=
0
;
/// <summary>
/// Make the icon visible or invisible.
/// </summary>
/// <param name="visible">True to make the icon visible.</param>
virtual
void
SetIconVisible
(
bool
visible
)=
0
;
/// <summary>
/// Test is the title bar visible.
/// </summary>
/// <returns>Returns true if the title bar is visible.</returns>
virtual
bool
GetTitleBar
()=
0
;
/// <summary>
/// Make the title bar visible or invisible.
/// </summary>
/// <param name="visible">True to make the title bar visible.</param>
virtual
void
SetTitleBar
(
bool
visible
)=
0
;
/// <summary>
/// Test is the window always on top of the desktop.
/// </summary>
/// <returns>Returns true if the window is always on top of the desktop.</returns>
virtual
bool
GetTopMost
()=
0
;
/// <summary>
/// Make the window always or never on top of the desktop.
/// </summary>
/// <param name="topmost">True to make the window always on top of the desktop.</param>
virtual
void
SetTopMost
(
bool
topmost
)=
0
;
/// <summary>
/// Supress the system's Alt+X hot key
/// </summary>
virtual
void
SupressAlt
() =
0
;
/// <summary>
/// Install an message listener.
/// </summary>
/// <returns>Returns true if this operation succeeded.</returns>
/// <param name="listener">The listener to install.</param>
virtual
bool
InstallListener
(
INativeWindowListener
*
listener
)=
0
;
/// <summary>
/// Uninstall an message listener.
/// </summary>
/// <returns>Returns true if this operation succeeded.</returns>
/// <param name="listener">The listener to uninstall.</param>
virtual
bool
UninstallListener
(
INativeWindowListener
*
listener
)=
0
;
/// <summary>
/// Redraw the content of the window.
/// </summary>
virtual
void
RedrawContent
()=
0
;
};
/// <summary>
/// Mouse message information.
/// </summary>
/// <typeparam name="T">Type of the coordinate.</typeparam>
template
<
typename
T
>
struct
WindowMouseInfo_
{
/// <summary>True if the control button is pressed.</summary>
bool
ctrl
;
/// <summary>True if the shift button is pressed.</summary>
bool
shift
;
/// <summary>True if the left mouse button is pressed.</summary>
bool
left
;
/// <summary>True if the middle mouse button is pressed.</summary>
bool
middle
;
/// <summary>True if the right mouse button is pressed.</summary>
bool
right
;
/// <summary>The mouse position of x dimension.</summary>
T
x
;
/// <summary>The mouse position of y dimension.</summary>
T
y
;
/// <summary>The delta of the wheel.</summary>
vint
wheel
;
/// <summary>True if the mouse is in the non-client area.</summary>
bool
nonClient
;
};
using
WindowMouseInfo
=
WindowMouseInfo_
<
GuiCoordinate
>;
using
NativeWindowMouseInfo
=
WindowMouseInfo_
<
NativeCoordinate
>;
/// <summary>
/// Key message information.
/// </summary>
struct
NativeWindowKeyInfo
{
/// <summary>Key code of the key that sends this message.</summary>
VKEY
code
;
/// <summary>True if the control button is pressed.</summary>
bool
ctrl
;
/// <summary>True if the shift button is pressed.</summary>
bool
shift
;
/// <summary>True if the alt button is pressed.</summary>
bool
alt
;
/// <summary>True if the capslock button is pressed.</summary>
bool
capslock
;
/// <summary>True if this repeated event is generated because a key is holding down.</summary>
bool
autoRepeatKeyDown
;
};
using
WindowKeyInfo
=
NativeWindowKeyInfo
;
/// <summary>
/// Character message information.
/// </summary>
struct
NativeWindowCharInfo
{
/// <summary>Character that sends this message.</summary>
wchar_t
code
;
/// <summary>True if the control button is pressed.</summary>
bool
ctrl
;
/// <summary>True if the shift button is pressed.</summary>
bool
shift
;
/// <summary>True if the alt button is pressed.</summary>
bool
alt
;
/// <summary>True if the capslock button is pressed.</summary>
bool
capslock
;
};
using
WindowCharInfo
=
NativeWindowCharInfo
;
/// <summary>
/// Represents a message listener to an <see cref="INativeWindow"/>.
/// </summary>
class
INativeWindowListener
:
public
Interface
{
public
:
/// <summary>Hit test result for a native window.</summary>
enum
HitTestResult
{
/// <summary>Border that doesn't contain sizing functionalitiy.</summary>
BorderNoSizing
,
/// <summary>Left border.</summary>
BorderLeft
,
/// <summary>Right border.</summary>
BorderRight
,
/// <summary>Top border.</summary>
BorderTop
,
/// <summary>Bottom border.</summary>
BorderBottom
,
/// <summary>Left top border.</summary>
BorderLeftTop
,
/// <summary>Right top border.</summary>
BorderRightTop
,
/// <summary>Left bottom border.</summary>
BorderLeftBottom
,
/// <summary>Right bottom border.</summary>
BorderRightBottom
,
/// <summary>Title</summary>
Title
,
/// <summary>Minimum button.</summary>
ButtonMinimum
,
/// <summary>Maximum button.</summary>
ButtonMaximum
,
/// <summary>Close button.</summary>
ButtonClose
,
/// <summary>Client button.</summary>
Client
,
/// <summary>Icon.</summary>
Icon
,
/// <summary>Let the OS window layer decide.</summary>
NoDecision
,
};
/// <summary>
/// Perform a hit test.
/// </summary>
/// <returns>Returns the hit test result. If "NoDecision" is returned, the native window provider should call the OS window layer to do the hit test.</returns>
/// <param name="location">The location to do the hit test. This location is in the window space (not the client space).</param>
virtual
HitTestResult
HitTest
(
NativePoint
location
);
/// <summary>
/// Called when the window is moving.
/// </summary>
/// <param name="bounds">The bounds. Message handler can change the bounds.</param>
/// <param name="fixSizeOnly">True if the message raise only want the message handler to change the size, and keep the position unchanged.</param>
/// <param name="draggingBorder">True if the message raise because the user is dragging the border to change the size.</param>
virtual
void
Moving
(
NativeRect
&
bounds
,
bool
fixSizeOnly
,
bool
draggingBorder
);
/// <summary>
/// Called when the window is moved.
/// </summary>
virtual
void
Moved
();
/// <summary>
/// Called when the dpi associated with this window is changed.
/// </summary>
virtual
void
DpiChanged
();
/// <summary>
/// Called when the window is enabled.
/// </summary>
virtual
void
Enabled
();
/// <summary>
/// Called when the window is disabled.
/// </summary>
virtual
void
Disabled
();
/// <summary>
/// Called when the window got the focus.
/// </summary>
virtual
void
GotFocus
();
/// <summary>
/// Called when the window lost the focus.
/// </summary>
virtual
void
LostFocus
();
/// <summary>
/// Called when the window is activated.
/// </summary>
virtual
void
Activated
();
/// <summary>
/// Called when the window is deactivated.
/// </summary>
virtual
void
Deactivated
();
/// <summary>
/// Called when the window is opened.
/// </summary>
virtual
void
Opened
();
/// <summary>
/// Called when the window is closing.
/// </summary>
/// <param name="cancel">Change the value to true to prevent the windows from being closed.</param>
virtual
void
Closing
(
bool
&
cancel
);
/// <summary>
/// Called when the window is closed.
/// </summary>
virtual
void
Closed
();
/// <summary>
/// Called when the window is painting.
/// </summary>
virtual
void
Paint
();
/// <summary>
/// Called when the window is destroying.
/// </summary>
virtual
void
Destroying
();
/// <summary>
/// Called when the window is destroyed.
/// </summary>
virtual
void
Destroyed
();
/// <summary>
/// Called when the left mouse button is pressed.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
LeftButtonDown
(
const
NativeWindowMouseInfo
&
info
);
/// <summary>
/// Called when the left mouse button is released.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
LeftButtonUp
(
const
NativeWindowMouseInfo
&
info
);
/// <summary>
/// Called when the left mouse button performed a double click.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
LeftButtonDoubleClick
(
const
NativeWindowMouseInfo
&
info
);
/// <summary>
/// Called when the right mouse button is pressed.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
RightButtonDown
(
const
NativeWindowMouseInfo
&
info
);
/// <summary>
/// Called when the right mouse button is released.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
RightButtonUp
(
const
NativeWindowMouseInfo
&
info
);
/// <summary>
/// Called when the right mouse button performed a double click.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
RightButtonDoubleClick
(
const
NativeWindowMouseInfo
&
info
);
/// <summary>
/// Called when the middle mouse button is pressed.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
MiddleButtonDown
(
const
NativeWindowMouseInfo
&
info
);
/// <summary>
/// Called when the middle mouse button is released.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
MiddleButtonUp
(
const
NativeWindowMouseInfo
&
info
);
/// <summary>
/// Called when the middle mouse button performed a double click.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
MiddleButtonDoubleClick
(
const
NativeWindowMouseInfo
&
info
);
/// <summary>
/// Called when the horizontal mouse wheel scrolls.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
HorizontalWheel
(
const
NativeWindowMouseInfo
&
info
);
/// <summary>
/// Called when the horizontal vertical wheel scrolls.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
VerticalWheel
(
const
NativeWindowMouseInfo
&
info
);
/// <summary>
/// Called when the mouse is moving on the window.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
MouseMoving
(
const
NativeWindowMouseInfo
&
info
);
/// <summary>
/// Called when the mouse entered the window.
/// </summary>
virtual
void
MouseEntered
();
/// <summary>
/// Called when the mouse leaved the window.
/// </summary>
virtual
void
MouseLeaved
();
/// <summary>
/// Called a key is pressed.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
KeyDown
(
const
NativeWindowKeyInfo
&
info
);
/// <summary>
/// Called a key is released.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
KeyUp
(
const
NativeWindowKeyInfo
&
info
);
/// <summary>
/// Called a system key is pressed.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
SysKeyDown
(
const
NativeWindowKeyInfo
&
info
);
/// <summary>
/// Called a system key is released.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
virtual
void
SysKeyUp
(
const
NativeWindowKeyInfo
&
info
);
/// <summary>
/// Called an input character is generated.
/// </summary>
/// <param name="info">Detailed information to this message.</param>
/// <summary>If the current task is pending, cancel the task.</summary>
/// <returns>Returns true if this operation succeeded.</returns>
virtual
bool
Cancel
()=
0
;
};
/// <summary>
/// Asynchronized operation service. GacUI is not a thread safe library except for this service. To access this service, use [M:vl.presentation.INativeController.AsyncService].
/// </summary>
class
INativeAsyncService
:
public
virtual
IDescriptable
,
public
Description
<
INativeAsyncService
>
{
public
:
/// <summary>
/// Test is the current thread the main thread.
/// </summary>
/// <returns>Returns true if the current thread is the main thread.</returns>
/// <param name="window">A window to access the corressponding main thread.</param>
virtual
bool
IsInMainThread
(
INativeWindow
*
window
)=
0
;
/// <summary>
/// Invoke a specified function with an specified argument asynchronisly.
/// Message box button to indicate what the user selected.
/// </summary>
enum
MessageBoxButtonsOutput
{
/// <summary>Select OK.</summary>
SelectOK
,
/// <summary>Select Cancel.</summary>
SelectCancel
,
/// <summary>Select Yes.</summary>
SelectYes
,
/// <summary>Select No.</summary>
SelectNo
,
/// <summary>Select Retry.</summary>
SelectRetry
,
/// <summary>Select Abort.</summary>
SelectAbort
,
/// <summary>Select Ignore.</summary>
SelectIgnore
,
/// <summary>Select TryAgain.</summary>
SelectTryAgain
,
/// <summary>Select Continue.</summary>
SelectContinue
,
};
/// <summary>
/// Message box default button.
/// </summary>
enum
MessageBoxDefaultButton
{
/// <summary>First.</summary>
DefaultFirst
,
/// <summary>Second.</summary>
DefaultSecond
,
/// <summary>Third.</summary>
DefaultThird
,
};
/// <summary>
/// Message box icons.
/// </summary>
enum
MessageBoxIcons
{
/// <summary>No icon.</summary>
IconNone
,
/// <summary>Error icon.</summary>
IconError
,
/// <summary>Question icon.</summary>
IconQuestion
,
/// <summary>Warning icon.</summary>
IconWarning
,
/// <summary>Information icon.</summary>
IconInformation
,
};
/// <summary>
/// Message box model options.
/// </summary>
enum
MessageBoxModalOptions
{
/// <summary>Disable the current window.</summary>
ModalWindow
,
/// <summary>Disable all windows in the application.</summary>
ModalTask
,
/// <summary>Top most message box in the whole system.</summary>
ModalSystem
,
};
/// <summary>Show a message box.</summary>
/// <returns>Returns the user selected button.</returns>
/// <param name="window">The current window. This argument can be null.</param>
/// <param name="text">The content of the message box.</param>
/// <param name="title">The title of the message box.</param>
/// <param name="buttons">The display button combination of the message box.</param>
/// <param name="defaultButton">The default button of the message box.</param>
/// <param name="icon">The icon of the message box.</param>
/// <param name="modal">The modal option of the message box.</param>
virtual
MessageBoxButtonsOutput
ShowMessageBox
(
INativeWindow
*
window
,
const
WString
&
text
,
const
WString
&
title
=
L""
,
MessageBoxButtonsInput
buttons
=
DisplayOK
,
MessageBoxDefaultButton
defaultButton
=
DefaultFirst
,
MessageBoxIcons
icon
=
IconNone
,
MessageBoxModalOptions
modal
=
ModalWindow
)=
0
;
/// <summary>
/// Color dialog custom color options
/// </summary>
enum
ColorDialogCustomColorOptions
{
/// <summary>Disable the custom color panel.</summary>
CustomColorDisabled
,
/// <summary>Enable the custom color panel.</summary>
CustomColorEnabled
,
/// <summary>Open the custom color panel at the beginning.</summary>
CustomColorOpened
,
};
/// <summary>Show a color dialog.</summary>
/// <returns>Returns true if the user selected the OK button.</returns>
/// <param name="window">The current window.</param>
/// <param name="selection">The color that the user selected.</param>
/// <param name="selected">Make the color dialog selected the color specified in the "selection" parameter at the beginning.</param>
/// <param name="customColorOptions">Custom color panel options.</param>
/// <param name="customColors">The initial 16 colors in custom color boxes. This argument can be null.</param>
virtual
bool
ShowColorDialog
(
INativeWindow
*
window
,
Color
&
selection
,
bool
selected
=
false
,
ColorDialogCustomColorOptions
customColorOptions
=
CustomColorEnabled
,
Color
*
customColors
=
0
)=
0
;
/// <summary>Show a font dialog.</summary>
/// <returns>Returns true if the user selected the OK button.</returns>
/// <param name="window">The current window.</param>
/// <param name="selectionFont">The font that the user selected.</param>
/// <param name="selectionColor">The color that the user selected.</param>
/// <param name="selected">Make the font dialog selected the font specified in the "selectionFont" and "selectionColor" parameters at the beginning.</param>
/// <param name="showEffect">Enable the user to edit some extended font properties.</param>
/// <param name="forceFontExist">Force the user to select existing font.</param>
virtual
bool
ShowFontDialog
(
INativeWindow
*
window
,
FontProperties
&
selectionFont
,
Color
&
selectionColor
,
bool
selected
=
false
,
bool
showEffect
=
true
,
bool
forceFontExist
=
true
)=
0
;
/// <summary>
/// File dialog type.
/// </summary>
enum
FileDialogTypes
{
/// <summary>Open file dialog.</summary>
FileDialogOpen
,
/// <summary>Open file dialog with preview.</summary>
FileDialogOpenPreview
,
/// <summary>Save file dialog.</summary>
FileDialogSave
,
/// <summary>Save file dialog with preview.</summary>
FileDialogSavePreview
,
};
/// <summary>
/// File dialog options.
/// </summary>
enum
FileDialogOptions
{
/// <summary>Allow multiple selection.</summary>
FileDialogAllowMultipleSelection
=
1
,
/// <summary>Prevent the user to select unexisting files.</summary>
FileDialogFileMustExist
=
2
,
/// <summary>Show the "Read Only" check box.</summary>
FileDialogShowReadOnlyCheckBox
=
4
,
/// <summary>Dereference link files.</summary>
FileDialogDereferenceLinks
=
8
,
/// <summary>Show the "Network" button.</summary>
FileDialogShowNetworkButton
=
16
,
/// <summary>Prompt if a new file is going to be created.</summary>
FileDialogPromptCreateFile
=
32
,
/// <summary>Promt if a existing file is going to be overwritten.</summary>
FileDialogPromptOverwriteFile
=
64
,
/// <summary>Prevent the user to select an unexisting directory.</summary>
FileDialogDirectoryMustExist
=
128
,
/// <summary>Add user selected files to "Recent" directory.</summary>
FileDialogAddToRecent
=
256
,
};
/// <summary>Show a file dialog.</summary>
/// <returns>Returns true if the user selected the OK button.</returns>
/// <param name="window">The current window.</param>
/// <param name="selectionFileNames">The file names that the user selected.</param>
/// <param name="selectionFilterIndex">The filter that the user selected.</param>
/// <param name="dialogType">The type of the file dialog.</param>
/// <param name="title">The title of the file dialog.</param>
/// <returns>The screen information service</returns>
virtual
INativeScreenService
*
ScreenService
()=
0
;
/// <summary>
/// Get the window service.
/// </summary>
/// <returns>The window service</returns>
virtual
INativeWindowService
*
WindowService
()=
0
;
/// <summary>
/// Get the user input service.
/// </summary>
/// <returns>The user input service</returns>
virtual
INativeInputService
*
InputService
()=
0
;
/// <summary>
/// Get the dialog service.
/// </summary>
/// <returns>The user dialog service</returns>
virtual
INativeDialogService
*
DialogService
()=
0
;
/// <summary>
/// Get the file path of the current executable.
/// </summary>
/// <returns>The file path of the current executable.</returns>
virtual
WString
GetExecutablePath
()=
0
;
};
/// <summary>
/// Represents a global message listener to an <see cref="INativeController"/>.
/// </summary>
class
INativeControllerListener
:
public
Interface
{
public
:
/// <summary>
/// Called when the global timer message raised. To receive or not receive this message, use <see cref="INativeInputService::StartTimer"/> or <see cref="INativeInputService::StopTimer"/>
/// </summary>
virtual
void
GlobalTimer
();
/// <summary>
/// Called when the content of the clipboard is updated.
/// </summary>
virtual
void
ClipboardUpdated
();
/// <summary>
/// Called when a window is created.
/// </summary>
/// <param name="window">The created window.</param>