tbx  0.7.6
Public Attributes | List of all members
tbx::ShowSubWindowSpec Struct Reference

Structure used to show a window as a subwindow. More...

#include <showsubwindowspec.h>

Inheritance diagram for tbx::ShowSubWindowSpec:
tbx::ShowFullSpec

Public Attributes

unsigned int window_flags
 Window flags to use for the window. More...
 
WindowHandle wimp_parent
 The parent window handle to make this window a subwindow of. More...
 
unsigned int flags
 Control the use of the window_flags member and the alignment of the sub window inside its parent. More...
 
- Public Attributes inherited from tbx::ShowFullSpec
VisibleArea visible_area
 Location of window on screen and scroll offsets.
 
WindowHandle wimp_window
 Window handle of window to show this above. More...
 

Additional Inherited Members

- Public Types inherited from tbx::ShowFullSpec
enum  { WINDOW_SHOW_TOP = -1, WINDOW_SHOW_BOTTOM = -2, WINDOW_SHOW_BEHIND = -3 }
 Special window handles to specify where a window should be shown in the window stack. More...
 

Detailed Description

Structure used to show a window as a subwindow.

i.e. The window is a nested child of the parent.

Member Data Documentation

◆ flags

unsigned int tbx::ShowSubWindowSpec::flags

Control the use of the window_flags member and the alignment of the sub window inside its parent.

Combine multiple flags using the "|" operator.

See also
SubWindowFlags for a list of flags available

◆ wimp_parent

WindowHandle tbx::ShowSubWindowSpec::wimp_parent

The parent window handle to make this window a subwindow of.

To get the window handle from a toolbox window use the Window::window_handle() method.

◆ window_flags

unsigned int tbx::ShowSubWindowSpec::window_flags

Window flags to use for the window.

The flags parameter must include the NEW_WINDOW_FLAGS bit for this to be used.


The documentation for this struct was generated from the following file: