CL_GUIWindowManager Class Reference
[clanGUI System]

GUI window manager interface. More...

#include <gui_window_manager.h>

Inheritance diagram for CL_GUIWindowManager:
Inheritance graph
[legend]

List of all members.

Public Types

Enumerations

enum  CL_WindowManagerType { cl_wm_type_system, cl_wm_type_texture }

Public Member Functions

Construction

 CL_GUIWindowManager ()
 Constructs a null instance.
 CL_GUIWindowManager (CL_GUIWindowManagerProvider *provider)
 Constructs a window manager.
 CL_GUIWindowManager (const CL_GUIWindowManager &src)
 Duplicates the reference to a window manager.
 ~CL_GUIWindowManager ()
Attributes

bool is_null () const
 Is Null.
CL_GUIWindowManagerProviderget_provider () const
 Retrieves the provider.
CL_WindowManagerType get_window_manager_type () const
 Get Window manager type.
Operations

void set_site (CL_GUIWindowManagerSite *site)
 Set site.
void create_window (CL_GUITopLevelWindow *handle, CL_GUITopLevelWindow *owner, CL_GUIComponent *component, CL_GUITopLevelDescription description)
void destroy_window (CL_GUITopLevelWindow *handle)
 Destroy window.
void enable_window (CL_GUITopLevelWindow *handle, bool enable)
 Enable window.
bool has_focus (CL_GUITopLevelWindow *handle) const
 Has focus.
void set_visible (CL_GUITopLevelWindow *handle, bool visible, bool activate_root_win)
 Set visible.
void set_geometry (CL_GUITopLevelWindow *handle, const CL_Rect &geometry, bool client_area)
 Set geometry.
CL_Rect get_geometry (CL_GUITopLevelWindow *handle, bool client_area) const
 Get geometry.
CL_Point screen_to_window (CL_GUITopLevelWindow *handle, const CL_Point &screen_point, bool client_area) const
 Screen to window.
CL_Point window_to_screen (CL_GUITopLevelWindow *handle, const CL_Point &window_point, bool client_area) const
 Window to screen.
CL_GraphicContextget_gc (CL_GUITopLevelWindow *handle) const
 Get gc.
CL_InputContextget_ic (CL_GUITopLevelWindow *handle) const
 Get ic.
CL_GraphicContext begin_paint (CL_GUITopLevelWindow *handle, const CL_Rect &update_region)
 Begin paint.
void set_cliprect (CL_GUITopLevelWindow *handle, CL_GraphicContext &gc, const CL_Rect &rect)
 Set cliprect.
void reset_cliprect (CL_GUITopLevelWindow *handle, CL_GraphicContext &gc)
 Reset cliprect.
void push_cliprect (CL_GUITopLevelWindow *handle, CL_GraphicContext &gc, const CL_Rect &rect)
 Push cliprect.
void pop_cliprect (CL_GUITopLevelWindow *handle, CL_GraphicContext &gc)
 Pop cliprect.
void end_paint (CL_GUITopLevelWindow *handle, const CL_Rect &update_region)
 End paint.
void request_repaint (CL_GUITopLevelWindow *handle, const CL_Rect &update_region)
 Request repaint.
void bring_to_front (CL_GUITopLevelWindow *handle)
 Bring to front.
bool is_minimized (CL_GUITopLevelWindow *handle) const
 Is minimized.
bool is_maximized (CL_GUITopLevelWindow *handle) const
 Is maximized.
void process_message ()
 Process message.
void capture_mouse (CL_GUITopLevelWindow *handle, bool state)
 Capture mouse.
CL_DisplayWindow get_display_window (CL_GUITopLevelWindow *handle) const
 Get display window.
void set_cursor (CL_GUITopLevelWindow *handle, const CL_Cursor &cursor)
 Set cursor.
void set_cursor (CL_GUITopLevelWindow *handle, enum CL_StandardCursor type)
 Set cursor.
void update ()
 Perform any updates.
void setup_painting ()
 Initial setup for painting all top level windows.
void complete_painting ()
 Final completion for painting all top level windows.

Detailed Description

GUI window manager interface.


Member Enumeration Documentation

Enumerator:
cl_wm_type_system 
cl_wm_type_texture 

Constructor & Destructor Documentation

CL_GUIWindowManager::CL_GUIWindowManager (  ) 

Constructs a null instance.

CL_GUIWindowManager::CL_GUIWindowManager ( CL_GUIWindowManagerProvider provider  ) 

Constructs a window manager.

Parameters:
provider = The theme provider
CL_GUIWindowManager::CL_GUIWindowManager ( const CL_GUIWindowManager src  ) 

Duplicates the reference to a window manager.

CL_GUIWindowManager::~CL_GUIWindowManager (  ) 

Member Function Documentation

CL_GraphicContext CL_GUIWindowManager::begin_paint ( CL_GUITopLevelWindow *  handle,
const CL_Rect update_region 
)

Begin paint.

Parameters:
handle = GUITop Level Window
update_region = Rect
Returns:
Graphic Context
void CL_GUIWindowManager::bring_to_front ( CL_GUITopLevelWindow *  handle  ) 

Bring to front.

Parameters:
handle = GUITop Level Window
void CL_GUIWindowManager::capture_mouse ( CL_GUITopLevelWindow *  handle,
bool  state 
)

Capture mouse.

Parameters:
handle = GUITop Level Window
state = bool
void CL_GUIWindowManager::complete_painting (  ) 

Final completion for painting all top level windows.

void CL_GUIWindowManager::create_window ( CL_GUITopLevelWindow *  handle,
CL_GUITopLevelWindow *  owner,
CL_GUIComponent component,
CL_GUITopLevelDescription  description 
)
void CL_GUIWindowManager::destroy_window ( CL_GUITopLevelWindow *  handle  ) 

Destroy window.

Parameters:
handle = GUITop Level Window
void CL_GUIWindowManager::enable_window ( CL_GUITopLevelWindow *  handle,
bool  enable 
)

Enable window.

Parameters:
handle = GUITop Level Window
enable = bool
void CL_GUIWindowManager::end_paint ( CL_GUITopLevelWindow *  handle,
const CL_Rect update_region 
)

End paint.

Parameters:
handle = GUITop Level Window
update_region = Rect
CL_DisplayWindow CL_GUIWindowManager::get_display_window ( CL_GUITopLevelWindow *  handle  )  const

Get display window.

Parameters:
handle = GUITop Level Window
Returns:
Display Window
CL_GraphicContext& CL_GUIWindowManager::get_gc ( CL_GUITopLevelWindow *  handle  )  const

Get gc.

Parameters:
handle = GUITop Level Window
Returns:
Graphic Context
CL_Rect CL_GUIWindowManager::get_geometry ( CL_GUITopLevelWindow *  handle,
bool  client_area 
) const

Get geometry.

Parameters:
handle = GUITop Level Window
client_area = bool
Returns:
Rect
CL_InputContext& CL_GUIWindowManager::get_ic ( CL_GUITopLevelWindow *  handle  )  const

Get ic.

Parameters:
handle = GUITop Level Window
Returns:
Input Context
CL_GUIWindowManagerProvider* CL_GUIWindowManager::get_provider (  )  const

Retrieves the provider.

Reimplemented in CL_GUIWindowManagerDirect, CL_GUIWindowManagerSystem, and CL_GUIWindowManagerTexture.

CL_WindowManagerType CL_GUIWindowManager::get_window_manager_type (  )  const

Get Window manager type.

Returns:
window_manager_type
bool CL_GUIWindowManager::has_focus ( CL_GUITopLevelWindow *  handle  )  const

Has focus.

Parameters:
handle = GUITop Level Window
Returns:
bool
bool CL_GUIWindowManager::is_maximized ( CL_GUITopLevelWindow *  handle  )  const

Is maximized.

Parameters:
handle = GUITop Level Window
Returns:
bool
bool CL_GUIWindowManager::is_minimized ( CL_GUITopLevelWindow *  handle  )  const

Is minimized.

Parameters:
handle = GUITop Level Window
Returns:
bool
bool CL_GUIWindowManager::is_null (  )  const

Is Null.

Returns:
true = null
void CL_GUIWindowManager::pop_cliprect ( CL_GUITopLevelWindow *  handle,
CL_GraphicContext gc 
)

Pop cliprect.

Parameters:
handle = GUITop Level Window
gc = Graphic Context
void CL_GUIWindowManager::process_message (  ) 

Process message.

void CL_GUIWindowManager::push_cliprect ( CL_GUITopLevelWindow *  handle,
CL_GraphicContext gc,
const CL_Rect rect 
)

Push cliprect.

Parameters:
handle = GUITop Level Window
gc = Graphic Context
rect = Clip rect
void CL_GUIWindowManager::request_repaint ( CL_GUITopLevelWindow *  handle,
const CL_Rect update_region 
)

Request repaint.

Parameters:
handle = GUITop Level Window
update_region = Rect
void CL_GUIWindowManager::reset_cliprect ( CL_GUITopLevelWindow *  handle,
CL_GraphicContext gc 
)

Reset cliprect.

Parameters:
handle = GUITop Level Window
gc = Graphic Context
CL_Point CL_GUIWindowManager::screen_to_window ( CL_GUITopLevelWindow *  handle,
const CL_Point screen_point,
bool  client_area 
) const

Screen to window.

Parameters:
handle = GUITop Level Window
screen_point = Point
client_area = bool
Returns:
Point
void CL_GUIWindowManager::set_cliprect ( CL_GUITopLevelWindow *  handle,
CL_GraphicContext gc,
const CL_Rect rect 
)

Set cliprect.

Parameters:
handle = GUITop Level Window
gc = Graphic Context
rect = Rect
void CL_GUIWindowManager::set_cursor ( CL_GUITopLevelWindow *  handle,
enum CL_StandardCursor  type 
)

Set cursor.

Parameters:
handle = GUITop Level Window
type = CL_StandardCursor
void CL_GUIWindowManager::set_cursor ( CL_GUITopLevelWindow *  handle,
const CL_Cursor cursor 
)

Set cursor.

Parameters:
handle = GUITop Level Window
cursor = Cursor
void CL_GUIWindowManager::set_geometry ( CL_GUITopLevelWindow *  handle,
const CL_Rect geometry,
bool  client_area 
)

Set geometry.

Parameters:
handle = GUITop Level Window
geometry = Rect
client_area = bool
void CL_GUIWindowManager::set_site ( CL_GUIWindowManagerSite site  ) 

Set site.

Parameters:
site = GUIWindow Manager Site
void CL_GUIWindowManager::set_visible ( CL_GUITopLevelWindow *  handle,
bool  visible,
bool  activate_root_win 
)

Set visible.

Parameters:
handle = GUITop Level Window
visible = bool
activate_root_win = bool
void CL_GUIWindowManager::setup_painting (  ) 

Initial setup for painting all top level windows.

void CL_GUIWindowManager::update (  ) 

Perform any updates.

This is called by CL_GUIManager::exec(), after all messages has been processed

CL_Point CL_GUIWindowManager::window_to_screen ( CL_GUITopLevelWindow *  handle,
const CL_Point window_point,
bool  client_area 
) const

Window to screen.

Parameters:
handle = GUITop Level Window
window_point = Point
client_area = bool
Returns:
Point

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