Interface for implementing a CL_DisplayWindow target. More...
#include <display_window_provider.h>
Public Member Functions | |
Construction | |
virtual | ~CL_DisplayWindowProvider () |
Attributes | |
virtual CL_Rect | get_geometry () const =0 |
Returns the position and size of the window frame. | |
virtual CL_Rect | get_viewport () const =0 |
Returns the drawable area of the window. | |
virtual bool | has_focus () const =0 |
Returns true if window has focus. | |
virtual bool | is_minimized () const =0 |
Returns true if the window is minimized. | |
virtual bool | is_maximized () const =0 |
Returns true if the window is maximized. | |
virtual bool | is_visible () const =0 |
Returns true if the window is visible. | |
virtual bool | is_fullscreen () const =0 |
Returns true if the window is fullscreen. | |
virtual CL_Size | get_minimum_size (bool client_area) const =0 |
Returns the minimum size of the window. | |
virtual CL_Size | get_maximum_size (bool client_area) const =0 |
Returns the maximum size of the window. | |
virtual CL_String | get_title () const =0 |
Returns the maximum size of the window. | |
virtual CL_GraphicContext & | get_gc ()=0 |
Return the graphic context for the window. | |
virtual CL_InputContext & | get_ic ()=0 |
Return the input context for the window. | |
virtual Display * | get_display () const =0 |
Returns the X11 display handle. | |
virtual Window | get_window () const =0 |
Handle to X11 window handle. | |
virtual bool | is_clipboard_text_available () const =0 |
Returns true if text is available in the clipboard. | |
virtual bool | is_clipboard_image_available () const =0 |
Returns true if an image is available in the clipboard. | |
virtual CL_String | get_clipboard_text () const =0 |
Returns the text stored in the clipboard. | |
virtual CL_PixelBuffer | get_clipboard_image () const =0 |
Returns the image stored in the clipboard. | |
Operations | |
virtual CL_Point | client_to_screen (const CL_Point &client)=0 |
Convert from window client coordinates to screen coordinates. | |
virtual CL_Point | screen_to_client (const CL_Point &screen)=0 |
Convert from screen coordinates to client coordinates. | |
virtual void | capture_mouse (bool capture)=0 |
Capture/Release the mouse. | |
virtual void | request_repaint (const CL_Rect &rect)=0 |
Invalidates a region of a screen, causing a repaint. | |
virtual void | destroy ()=0 |
Destroys the display window provider. | |
virtual void | create (CL_DisplayWindowSite *site, const CL_DisplayWindowDescription &description)=0 |
Creates window, assigning site and description to provider. | |
virtual void | show_system_cursor ()=0 |
Shows the mouse cursor. | |
virtual CL_CursorProvider * | create_cursor (const CL_SpriteDescription &sprite_description, const CL_Point &hotspot)=0 |
Creates a new custom cursor. | |
virtual void | set_cursor (CL_CursorProvider *cursor)=0 |
Sets the current cursor icon. | |
virtual void | set_cursor (enum CL_StandardCursor type)=0 |
Sets the current cursor icon. | |
virtual void | hide_system_cursor ()=0 |
Hides the mouse cursor. | |
virtual void | set_title (const CL_StringRef &new_title)=0 |
Change window title. | |
virtual void | set_position (const CL_Rect &pos, bool client_area)=0 |
Set window position and size. | |
virtual void | set_size (int width, int height, bool client_area)=0 |
Set size. | |
virtual void | set_minimum_size (int width, int height, bool client_area)=0 |
Set minimum size. | |
virtual void | set_maximum_size (int width, int height, bool client_area)=0 |
Set maximum size. | |
virtual void | set_enabled (bool enable)=0 |
Enables or disables a window. | |
virtual void | minimize ()=0 |
Minimizes the window. | |
virtual void | restore ()=0 |
Restores the window. | |
virtual void | maximize ()=0 |
Maximizes the window. | |
virtual void | show (bool activate)=0 |
Displays the window in its current size and position. | |
virtual void | hide ()=0 |
Hides the window. | |
virtual void | bring_to_front ()=0 |
Raise window on top of other windows. | |
virtual void | flip (int interval)=0 |
Flip opengl buffers. | |
virtual void | update (const CL_Rect &rect)=0 |
Copy a region of the backbuffer to the frontbuffer. | |
virtual void | set_clipboard_text (const CL_StringRef &text)=0 |
Stores text in the clipboard. | |
virtual void | set_clipboard_image (const CL_PixelBuffer &buf)=0 |
Stores an image in the clipboard. | |
virtual void | set_large_icon (const CL_PixelBuffer &image)=0 |
Sets the large icon used for this window. | |
virtual void | set_small_icon (const CL_PixelBuffer &image)=0 |
Sets the small icon used for this window. |
Interface for implementing a CL_DisplayWindow target.
virtual CL_DisplayWindowProvider::~CL_DisplayWindowProvider | ( | ) | [inline, virtual] |
virtual void CL_DisplayWindowProvider::bring_to_front | ( | ) | [pure virtual] |
Raise window on top of other windows.
virtual void CL_DisplayWindowProvider::capture_mouse | ( | bool | capture | ) | [pure virtual] |
Capture/Release the mouse.
virtual CL_Point CL_DisplayWindowProvider::client_to_screen | ( | const CL_Point & | client | ) | [pure virtual] |
Convert from window client coordinates to screen coordinates.
virtual void CL_DisplayWindowProvider::create | ( | CL_DisplayWindowSite * | site, | |
const CL_DisplayWindowDescription & | description | |||
) | [pure virtual] |
Creates window, assigning site and description to provider.
virtual CL_CursorProvider* CL_DisplayWindowProvider::create_cursor | ( | const CL_SpriteDescription & | sprite_description, | |
const CL_Point & | hotspot | |||
) | [pure virtual] |
Creates a new custom cursor.
virtual void CL_DisplayWindowProvider::destroy | ( | ) | [pure virtual] |
Destroys the display window provider.
virtual void CL_DisplayWindowProvider::flip | ( | int | interval | ) | [pure virtual] |
Flip opengl buffers.
virtual CL_PixelBuffer CL_DisplayWindowProvider::get_clipboard_image | ( | ) | const [pure virtual] |
Returns the image stored in the clipboard.
virtual CL_String CL_DisplayWindowProvider::get_clipboard_text | ( | ) | const [pure virtual] |
Returns the text stored in the clipboard.
virtual Display* CL_DisplayWindowProvider::get_display | ( | ) | const [pure virtual] |
Returns the X11 display handle.
virtual CL_GraphicContext& CL_DisplayWindowProvider::get_gc | ( | ) | [pure virtual] |
Return the graphic context for the window.
virtual CL_Rect CL_DisplayWindowProvider::get_geometry | ( | ) | const [pure virtual] |
Returns the position and size of the window frame.
virtual CL_InputContext& CL_DisplayWindowProvider::get_ic | ( | ) | [pure virtual] |
Return the input context for the window.
virtual CL_Size CL_DisplayWindowProvider::get_maximum_size | ( | bool | client_area | ) | const [pure virtual] |
Returns the maximum size of the window.
virtual CL_Size CL_DisplayWindowProvider::get_minimum_size | ( | bool | client_area | ) | const [pure virtual] |
Returns the minimum size of the window.
virtual CL_String CL_DisplayWindowProvider::get_title | ( | ) | const [pure virtual] |
Returns the maximum size of the window.
virtual CL_Rect CL_DisplayWindowProvider::get_viewport | ( | ) | const [pure virtual] |
Returns the drawable area of the window.
virtual Window CL_DisplayWindowProvider::get_window | ( | ) | const [pure virtual] |
Handle to X11 window handle.
virtual bool CL_DisplayWindowProvider::has_focus | ( | ) | const [pure virtual] |
Returns true if window has focus.
virtual void CL_DisplayWindowProvider::hide | ( | ) | [pure virtual] |
Hides the window.
virtual void CL_DisplayWindowProvider::hide_system_cursor | ( | ) | [pure virtual] |
Hides the mouse cursor.
virtual bool CL_DisplayWindowProvider::is_clipboard_image_available | ( | ) | const [pure virtual] |
Returns true if an image is available in the clipboard.
virtual bool CL_DisplayWindowProvider::is_clipboard_text_available | ( | ) | const [pure virtual] |
Returns true if text is available in the clipboard.
virtual bool CL_DisplayWindowProvider::is_fullscreen | ( | ) | const [pure virtual] |
Returns true if the window is fullscreen.
virtual bool CL_DisplayWindowProvider::is_maximized | ( | ) | const [pure virtual] |
Returns true if the window is maximized.
virtual bool CL_DisplayWindowProvider::is_minimized | ( | ) | const [pure virtual] |
Returns true if the window is minimized.
virtual bool CL_DisplayWindowProvider::is_visible | ( | ) | const [pure virtual] |
Returns true if the window is visible.
virtual void CL_DisplayWindowProvider::maximize | ( | ) | [pure virtual] |
Maximizes the window.
virtual void CL_DisplayWindowProvider::minimize | ( | ) | [pure virtual] |
Minimizes the window.
virtual void CL_DisplayWindowProvider::request_repaint | ( | const CL_Rect & | rect | ) | [pure virtual] |
Invalidates a region of a screen, causing a repaint.
virtual void CL_DisplayWindowProvider::restore | ( | ) | [pure virtual] |
Restores the window.
virtual CL_Point CL_DisplayWindowProvider::screen_to_client | ( | const CL_Point & | screen | ) | [pure virtual] |
Convert from screen coordinates to client coordinates.
virtual void CL_DisplayWindowProvider::set_clipboard_image | ( | const CL_PixelBuffer & | buf | ) | [pure virtual] |
Stores an image in the clipboard.
virtual void CL_DisplayWindowProvider::set_clipboard_text | ( | const CL_StringRef & | text | ) | [pure virtual] |
Stores text in the clipboard.
virtual void CL_DisplayWindowProvider::set_cursor | ( | CL_CursorProvider * | cursor | ) | [pure virtual] |
Sets the current cursor icon.
virtual void CL_DisplayWindowProvider::set_cursor | ( | enum CL_StandardCursor | type | ) | [pure virtual] |
Sets the current cursor icon.
virtual void CL_DisplayWindowProvider::set_enabled | ( | bool | enable | ) | [pure virtual] |
Enables or disables a window.
virtual void CL_DisplayWindowProvider::set_large_icon | ( | const CL_PixelBuffer & | image | ) | [pure virtual] |
Sets the large icon used for this window.
virtual void CL_DisplayWindowProvider::set_maximum_size | ( | int | width, | |
int | height, | |||
bool | client_area | |||
) | [pure virtual] |
Set maximum size.
width | = value | |
height | = value | |
client_area | = bool |
virtual void CL_DisplayWindowProvider::set_minimum_size | ( | int | width, | |
int | height, | |||
bool | client_area | |||
) | [pure virtual] |
Set minimum size.
width | = value | |
height | = value | |
client_area | = bool |
virtual void CL_DisplayWindowProvider::set_position | ( | const CL_Rect & | pos, | |
bool | client_area | |||
) | [pure virtual] |
Set window position and size.
virtual void CL_DisplayWindowProvider::set_size | ( | int | width, | |
int | height, | |||
bool | client_area | |||
) | [pure virtual] |
Set size.
width | = value | |
height | = value | |
client_area | = bool |
virtual void CL_DisplayWindowProvider::set_small_icon | ( | const CL_PixelBuffer & | image | ) | [pure virtual] |
Sets the small icon used for this window.
virtual void CL_DisplayWindowProvider::set_title | ( | const CL_StringRef & | new_title | ) | [pure virtual] |
Change window title.
virtual void CL_DisplayWindowProvider::show | ( | bool | activate | ) | [pure virtual] |
Displays the window in its current size and position.
virtual void CL_DisplayWindowProvider::show_system_cursor | ( | ) | [pure virtual] |
Shows the mouse cursor.
virtual void CL_DisplayWindowProvider::update | ( | const CL_Rect & | rect | ) | [pure virtual] |
Copy a region of the backbuffer to the frontbuffer.