List of all members
clan::DisplayWindowProvider Class Referenceabstract
clanDisplay Display

Interface for implementing a DisplayWindow target. More...

`#include <display_window_provider.h>`

## Public Member Functions
Construction
virtual | ~DisplayWindowProvider ()
Attributes
virtual Rect | get_geometry () const =0
| Returns the position and size of the window frame. More...
virtual Rect | get_viewport () const =0
| Returns the drawable area of the window. More...
virtual float | get_pixel_ratio () const =0
virtual bool | has_focus () const =0
| Returns true if window has focus. More...
virtual bool | is_minimized () const =0
| Returns true if the window is minimized. More...
virtual bool | is_maximized () const =0
| Returns true if the window is maximized. More...
virtual bool | is_visible () const =0
| Returns true if the window is visible. More...
virtual bool | is_fullscreen () const =0
| Returns true if the window is fullscreen. More...
virtual Size | get_minimum_size (bool client_area) const =0
| Returns the minimum size of the window. More...
virtual Size | get_maximum_size (bool client_area) const =0
| Returns the maximum size of the window. More...
virtual std::string | get_title () const =0
| Returns the maximum size of the window. More...
virtual GraphicContext & | get_gc ()=0
| Returns the graphic context for the window. More...
virtual InputContext | get_ic ()=0
| Returns the input context for the window. More...
virtual DisplayWindowHandle | get_handle () const =0
virtual bool | is_clipboard_text_available () const =0
| Returns true if text is available in the clipboard. More...
virtual bool | is_clipboard_image_available () const =0
| Returns true if an image is available in the clipboard. More...
virtual std::string | get_clipboard_text () const =0
| Returns the text stored in the clipboard. More...
virtual PixelBuffer | get_clipboard_image () const =0
| Returns the image stored in the clipboard. More...
Operations
virtual Point | client_to_screen (const Point &client)=0
| Convert from window client coordinates to screen coordinates. More...
virtual Point | screen_to_client (const Point &screen)=0
| Convert from screen coordinates to client coordinates. More...
virtual void | capture_mouse (bool capture)=0
| Capture/Release the mouse. More...
virtual void | request_repaint (const Rect &rect)=0
| Invalidates a region of a screen, causing a repaint. More...
virtual void | create (DisplayWindowSite *site, const DisplayWindowDescription &description)=0
| Creates window, assigning site and description to provider. More...
virtual void | show_system_cursor ()=0
| Shows the mouse cursor. More...
virtual void | hide_system_cursor ()=0
| Hides the mouse cursor. More...
virtual CursorProvider * | create_cursor (const CursorDescription &cursor_description)=0
| Creates a new custom cursor. More...
virtual void | set_cursor (CursorProvider *cursor)=0
| Sets the current cursor icon. More...
virtual void | set_cursor (StandardCursor type)=0
| Sets the current cursor icon. More...
virtual void | set_title (const std::string &new_title)=0
| Change window title. More...
virtual void | set_position (const Rect &pos, bool client_area)=0
| Sets the position and size of this window on the screen. More...
virtual void | set_size (int width, int height, bool client_area)=0
virtual void | set_minimum_size (int width, int height, bool client_area)=0
virtual void | set_maximum_size (int width, int height, bool client_area)=0
virtual void | set_pixel_ratio (float ratio)=0
virtual void | set_enabled (bool enable)=0
| Enables or disables input into this window. More...
virtual void | minimize ()=0
| Minimizes the window. More...
virtual void | restore ()=0
| Restores the window. More...
virtual void | maximize ()=0
| Maximizes the window. More...
virtual void | show (bool activate)=0
| Displays the window in its current size and position. More...
virtual void | hide ()=0
| Hides the window. More...
virtual void | bring_to_front ()=0
| Raise window on top of other windows. More...
virtual void | flip (int interval)=0
| Flip the window display buffers. More...
virtual void | update (const Rect &rect)=0
| Copy a region of the backbuffer to the frontbuffer. More...
virtual void | set_clipboard_text (const std::string &text)=0
| Stores text in the clipboard. More...
virtual void | set_clipboard_image (const PixelBuffer &buf)=0
| Stores an image in the clipboard. More...
virtual void | set_large_icon (const PixelBuffer &image)=0
| Sets the large icon used for this window. More...
virtual void | set_small_icon (const PixelBuffer &image)=0
| Sets the small icon used for this window. More...
virtual void | enable_alpha_channel (const Rect &blur_rect)=0
virtual void | extend_frame_into_client_area (int left, int top, int right, int bottom)=0

## Detailed Description

Interface for implementing a DisplayWindow target.

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

- display_window_provider.h