Rapicorn - Experimental UI Toolkit - Source Code  13.07.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
Rapicorn::ScreenWindow Class Reference

Interface class for managing window contents on screens and display devices. More...

#include <screenwindow.hh>

Inherits Rapicorn::Deletable.

Inherited by Rapicorn::ScreenWindowX11 [virtual].

List of all members.

Classes

struct  Config
 Structure requesting window configuration changes. More...
struct  Setup
 Structure requesting the initial window setup. More...
struct  State
 Structure describing the current window state. More...

Public Types

enum  Flags {
  MODAL, STICKY, VMAXIMIZED, HMAXIMIZED,
  SHADED, SKIP_TASKBAR, SKIP_PAGER, HIDDEN,
  FULLSCREEN, ABOVE_ALL, BELOW_ALL, ATTENTION,
  FOCUS_DECO, _WM_STATE_MASK, DECORATED, MINIMIZABLE,
  MAXIMIZABLE, DELETABLE, _DECO_MASK, ACCEPT_FOCUS,
  UNFOCUSED, ICONIFY
}
 Flags used to request and reflect certain window operations and states. More...

Public Member Functions

State get_state ()
 Retrieve the current window state.
void beep ()
 Issue an audible bell.
void show ()
 Show window on screen.
void present ()
 Demand user attention for this window.
bool viewable ()
 Check if the window is viewable, i.e. not iconified/shaded/etc.
void destroy ()
 Destroy onscreen window and reset event wakeup.
void configure (const Config &config, bool sizeevent)
 Change window configuration, requesting size event.
void blit_surface (cairo_surface_t *surface, const Rapicorn::Region &region)
 Blit/paint window region.
void start_user_move (uint button, double root_x, double root_y)
 Trigger window movement.
void start_user_resize (uint button, double root_x, double root_y, AnchorType edge)
 Trigger window resizing.
Eventpop_event ()
 Fetch the next event for this Window.
void push_event (Event *event)
 Push back an event, so it's the next event returned by pop().
bool has_event ()
 Indicates if pop_event() will return non-NULL.
void set_event_wakeup (const std::function< void()> &wakeup)
 Callback used to notify new event arrival.
bool peek_events (const std::function< bool(Event *)> &pred)
 Peek/find events via callback.

Static Public Member Functions

static String flags_name (uint64 flags, String combo=",")
 Convert flags to string.

Protected Member Functions

virtual ScreenDriverscreen_driver_async () const =0
 Acces ScreenDriver, called from any thread.
void enqueue_event (Event *event)
 Add an event to the back of the event queue.
bool update_state (const State &state)
 Updates the state returned from get_state().
void queue_command (ScreenCommand *command)
 Helper to queue commands on ScreenDriver.

Detailed Description

Interface class for managing window contents on screens and display devices.


Member Enumeration Documentation

Flags used to request and reflect certain window operations and states.

Enumerator:
MODAL 

Hint to the window manager that window receives input exclusively.

STICKY 

Window is fixed and kept on screen when virtual desktops change.

VMAXIMIZED 

Window is vertically maximized.

HMAXIMIZED 

Window is horizontally maximized.

SHADED 

Only the decoration bar for this window is shown.

SKIP_TASKBAR 

The window is exempt from taskbar listings.

SKIP_PAGER 

The window is exempt from virtual desktop pager display.

HIDDEN 

Window manager indication for non-visible window state.

FULLSCREEN 

Window covers the entire screen, no decoration, for presentation mode.

ABOVE_ALL 

The window is shown on top of most other windows.

BELOW_ALL 

The window is shown below most other windows.

ATTENTION 

The window indicates need for user attention.

FOCUS_DECO 

Window decoration indicates active focus state.

DECORATED 

The window is decorated by window managers.

MINIMIZABLE 

The window manager offers the maximization action for this window.

MAXIMIZABLE 

The window manager offers the maximization action for this window.

DELETABLE 

The window manager offers the deletion action for this window.

ACCEPT_FOCUS 

The window enters keyboard focus mode when selected by the user.

UNFOCUSED 

The window does not get automatic keyboard focus when initially shown.

ICONIFY 

The window is in iconified state, (minimized, but icon shown).


Member Function Documentation

String Rapicorn::ScreenWindow::flags_name ( uint64  flags,
String  combo = "," 
) [static]

Convert flags to string.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines