tbx  0.7.3
Public Member Functions | Friends | List of all members
tbx::WindowState Class Reference

Window state structure for the Window get_state method. More...

#include <window.h>

Inheritance diagram for tbx::WindowState:
tbx::WindowOpenInfo

Public Member Functions

unsigned int flags () const
 Window flags. More...
 
bool open () const
 Window is open.
 
bool fully_visible () const
 Window is fully visible. More...
 
bool full_size () const
 window has been toggled to full size
 
bool toggle_size () const
 the current Open_Window_Request was caused by a click on the Toggle Size icon
 
bool input_focus () const
 window has the input focus
 
bool force_to_screen () const
 force window to screen once on the next Open_Window
 
- 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 state structure for the Window get_state method.

Member Function Documentation

unsigned int tbx::WindowState::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

bool tbx::WindowState::fully_visible ( ) const
inline

Window is fully visible.

i.e. not covered at all


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