tbx  0.7.6
Public Member Functions | Friends | List of all members
tbx::WindowInfo Class Reference

Window Information structure for the Window get_info method. More...

#include <window.h>

Inheritance diagram for tbx::WindowInfo:
tbx::WindowOpenInfo

Public Member Functions

unsigned int flags () const
 Window flags. More...
 
unsigned int work_area_flags () const
 Work area flags. More...
 
ButtonType button_type () const
 Button type.
 
const BBoxwork_area () const
 Work area.
 
WimpColour title_foreground () const
 Title foreground and frame colour. More...
 
WimpColour title_background () const
 Title background colour. More...
 
WimpColour work_area_foreground () const
 Work area foreground colour. More...
 
WimpColour work_area_background () const
 Work area background colour. More...
 
WimpColour scroll_outer () const
 Scroll bar outer colour. More...
 
WimpColour scroll_inner () const
 Scroll bar inner colour. More...
 
WimpColour title_highlight () const
 Title background highlight colour. More...
 
int min_width () const
 Minimum width of the window. More...
 
int min_height () const
 Minimum height of the window. More...
 
- Public Member Functions inherited from tbx::WindowOpenInfo
WindowHandle window_handle () const
 WIMP window handle of this window.
 
const VisibleAreavisible_area () const
 Visible area of this window.
 
VisibleAreavisible_area ()
 Visible area of this window.
 
WindowHandle window_handle_in_front () const
 WIMP handle of window on top of this window or -1 for none.
 

Friends

class Window
 

Additional Inherited Members

- Protected Attributes inherited from tbx::WindowOpenInfo
WindowHandle _window_handle
 WIMP window handle.
 
VisibleArea _visible_area
 Position on screen and scroll settings.
 
WindowHandle _window_handle_in_front
 Handle of window in front of this one.
 

Detailed Description

Window Information structure for the Window get_info method.

Member Function Documentation

◆ flags()

unsigned int tbx::WindowInfo::flags ( ) const
inline

Window flags.

See RISC OS PRM for details of all flags. Common flags have a method to interrogate it in this class

◆ min_height()

int tbx::WindowInfo::min_height ( ) const
inline

Minimum height of the window.

Returns
minimum height of window in OS coordinates.

◆ min_width()

int tbx::WindowInfo::min_width ( ) const
inline

Minimum width of the window.

If the minimum width and height are both 0 the minimum width is taken from the title width.

Returns
minimum width of window in OS coordinates.

◆ scroll_inner()

WimpColour tbx::WindowInfo::scroll_inner ( ) const
inline

Scroll bar inner colour.

Returns
WimpColour for the inner area of the scroll bar

◆ scroll_outer()

WimpColour tbx::WindowInfo::scroll_outer ( ) const
inline

Scroll bar outer colour.

Returns
WimpColour for the outer area of the scroll bar

◆ title_background()

WimpColour tbx::WindowInfo::title_background ( ) const
inline

Title background colour.

Returns
WimpColour for title backgronud

◆ title_foreground()

WimpColour tbx::WindowInfo::title_foreground ( ) const
inline

Title foreground and frame colour.

Returns
WimpColour or WimpColour::no_colour if window has no control area or frame.

◆ title_highlight()

WimpColour tbx::WindowInfo::title_highlight ( ) const
inline

Title background highlight colour.

Returns
WimpColour for title background when the window has the focus

◆ work_area_background()

WimpColour tbx::WindowInfo::work_area_background ( ) const
inline

Work area background colour.

Returns
WimpColour for the work area background or WimpColour::no_colour if the Wimp does not draw the background.

◆ work_area_flags()

unsigned int tbx::WindowInfo::work_area_flags ( ) const
inline

Work area flags.

Split up in methods below

◆ work_area_foreground()

WimpColour tbx::WindowInfo::work_area_foreground ( ) const
inline

Work area foreground colour.

Returns
WimpColour for the work area foreground

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