CL_GUIWindowManagerProvider Class Reference
[clanGUI System]

GUI window manager interface. More...

#include <gui_window_manager_provider.h>

List of all members.

Public Member Functions

Construction

virtual ~CL_GUIWindowManagerProvider ()
Attributes

virtual
CL_GUIWindowManager::CL_WindowManagerType 
get_window_manager_type () const =0
Operations

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

Detailed Description

GUI window manager interface.


Constructor & Destructor Documentation

virtual CL_GUIWindowManagerProvider::~CL_GUIWindowManagerProvider (  )  [inline, virtual]

Member Function Documentation

virtual CL_GraphicContext CL_GUIWindowManagerProvider::begin_paint ( CL_GUITopLevelWindow *  handle,
const CL_Rect update_region 
) [pure virtual]

Begin paint.

Parameters:
handle = GUITop Level Window
update_region = Rect
Returns:
Graphic Context
virtual void CL_GUIWindowManagerProvider::bring_to_front ( CL_GUITopLevelWindow *  handle  )  [pure virtual]

Bring to front.

Parameters:
handle = GUITop Level Window
virtual void CL_GUIWindowManagerProvider::capture_mouse ( CL_GUITopLevelWindow *  handle,
bool  state 
) [pure virtual]

Capture mouse.

Parameters:
handle = GUITop Level Window
state = bool
virtual void CL_GUIWindowManagerProvider::complete_painting (  )  [pure virtual]

Final completion for painting all top level windows.

virtual void CL_GUIWindowManagerProvider::create_window ( CL_GUITopLevelWindow *  handle,
CL_GUITopLevelWindow *  owner,
CL_GUIComponent component,
CL_GUITopLevelDescription  description 
) [pure virtual]
virtual void CL_GUIWindowManagerProvider::destroy (  )  [pure virtual]

Destroys the provider.

virtual void CL_GUIWindowManagerProvider::destroy_window ( CL_GUITopLevelWindow *  handle  )  [pure virtual]

Destroy window.

Parameters:
handle = GUITop Level Window
virtual void CL_GUIWindowManagerProvider::enable_window ( CL_GUITopLevelWindow *  handle,
bool  enable 
) [pure virtual]

Enable window.

Parameters:
handle = GUITop Level Window
enable = bool
virtual void CL_GUIWindowManagerProvider::end_paint ( CL_GUITopLevelWindow *  handle,
const CL_Rect update_region 
) [pure virtual]

End paint.

Parameters:
handle = GUITop Level Window
update_region = Rect
virtual CL_DisplayWindow CL_GUIWindowManagerProvider::get_display_window ( CL_GUITopLevelWindow *  handle  )  const [pure virtual]

Get display window.

Parameters:
handle = GUITop Level Window
Returns:
Display Window
virtual CL_GraphicContext& CL_GUIWindowManagerProvider::get_gc ( CL_GUITopLevelWindow *  handle  )  const [pure virtual]

Get gc.

Parameters:
handle = GUITop Level Window
Returns:
Graphic Context
virtual CL_Rect CL_GUIWindowManagerProvider::get_geometry ( CL_GUITopLevelWindow *  handle,
bool  client_area 
) const [pure virtual]

Get geometry.

Parameters:
handle = GUITop Level Window
client_area = bool
Returns:
Rect
virtual CL_InputContext& CL_GUIWindowManagerProvider::get_ic ( CL_GUITopLevelWindow *  handle  )  const [pure virtual]

Get ic.

Parameters:
handle = GUITop Level Window
Returns:
Input Context
virtual CL_GUIWindowManager::CL_WindowManagerType CL_GUIWindowManagerProvider::get_window_manager_type (  )  const [pure virtual]
virtual bool CL_GUIWindowManagerProvider::has_focus ( CL_GUITopLevelWindow *  handle  )  const [pure virtual]

Has focus.

Parameters:
handle = GUITop Level Window
Returns:
bool
virtual bool CL_GUIWindowManagerProvider::is_maximized ( CL_GUITopLevelWindow *  handle  )  const [pure virtual]

Is maximized.

Parameters:
handle = GUITop Level Window
Returns:
bool
virtual bool CL_GUIWindowManagerProvider::is_minimized ( CL_GUITopLevelWindow *  handle  )  const [pure virtual]

Is minimized.

Parameters:
handle = GUITop Level Window
Returns:
bool
virtual void CL_GUIWindowManagerProvider::pop_cliprect ( CL_GUITopLevelWindow *  handle,
CL_GraphicContext gc 
) [pure virtual]

Push cliprect.

Parameters:
handle = GUITop Level Window
gc = Graphic Context
virtual void CL_GUIWindowManagerProvider::push_cliprect ( CL_GUITopLevelWindow *  handle,
CL_GraphicContext gc,
const CL_Rect rect 
) [pure virtual]

Push cliprect.

Parameters:
handle = GUITop Level Window
gc = Graphic Context
rect = Clip rect
virtual void CL_GUIWindowManagerProvider::request_repaint ( CL_GUITopLevelWindow *  handle,
const CL_Rect update_region 
) [pure virtual]

Request repaint.

Parameters:
handle = GUITop Level Window
update_region = Rect
virtual void CL_GUIWindowManagerProvider::reset_cliprect ( CL_GUITopLevelWindow *  handle,
CL_GraphicContext gc 
) [pure virtual]

Reset cliprect.

Parameters:
handle = GUITop Level Window
gc = Graphic Context
virtual CL_Point CL_GUIWindowManagerProvider::screen_to_window ( CL_GUITopLevelWindow *  handle,
const CL_Point screen_point,
bool  client_area 
) const [pure virtual]

Screen to window.

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

Set cliprect.

Parameters:
handle = GUITop Level Window
gc = Graphic Context
rect = Rect
virtual void CL_GUIWindowManagerProvider::set_cursor ( CL_GUITopLevelWindow *  handle,
enum CL_StandardCursor  type 
) [pure virtual]

Set cursor.

Parameters:
handle = GUITop Level Window
type = CL_StandardCursor
virtual void CL_GUIWindowManagerProvider::set_cursor ( CL_GUITopLevelWindow *  handle,
const CL_Cursor cursor 
) [pure virtual]

Set cursor.

Parameters:
handle = GUITop Level Window
cursor = Cursor
virtual void CL_GUIWindowManagerProvider::set_geometry ( CL_GUITopLevelWindow *  handle,
const CL_Rect geometry,
bool  client_area 
) [pure virtual]

Set geometry.

Parameters:
handle = GUITop Level Window
geometry = Rect
client_area = bool
virtual void CL_GUIWindowManagerProvider::set_site ( CL_GUIWindowManagerSite site  )  [pure virtual]

Set site.

Parameters:
site = GUIWindow Manager Site
virtual void CL_GUIWindowManagerProvider::set_visible ( CL_GUITopLevelWindow *  handle,
bool  visible,
bool  activate_root_win 
) [pure virtual]

Set visible.

Parameters:
handle = GUITop Level Window
visible = bool
activate_root_win = bool
virtual void CL_GUIWindowManagerProvider::setup_painting (  )  [pure virtual]

Initial setup for painting all top level windows.

virtual void CL_GUIWindowManagerProvider::update (  )  [pure virtual]

Perform any updates.

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

virtual CL_Point CL_GUIWindowManagerProvider::window_to_screen ( CL_GUITopLevelWindow *  handle,
const CL_Point window_point,
bool  client_area 
) const [pure virtual]

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: