-
- enum { WindowNoSnap = 0, WindowSnap, WindowResistance };
- enum { RowSmartPlacement = 1, ColSmartPlacement, CascadePlacement,
- UnderMousePlacement, ClickMousePlacement, LeftRight, RightLeft,
- TopBottom, BottomTop, IgnoreShaded, IgnoreMaximized };
- enum { RoundBullet = 1, TriangleBullet, SquareBullet, NoBullet };
- enum { Restart = 1, RestartOther, Exit, Shutdown, Execute, Reconfigure,
- WindowShade, WindowIconify, WindowMaximize, WindowClose, WindowRaise,
- WindowLower, WindowStick, WindowKill, SetStyle };
- enum FocusModel { SloppyFocus, ClickToFocus };
- enum RootScrollDirection { NoScroll = 0, NormalScroll, ReverseScroll };
-
- BScreen(Blackbox *bb, unsigned int scrn);
- ~BScreen(void);
-
- inline bool isSloppyFocus(void) const { return resource.sloppy_focus; }
- inline bool isRootColormapInstalled(void) const
- { return root_colormap_installed; }
- inline bool doAutoRaise(void) const { return resource.auto_raise; }
- inline bool doClickRaise(void) const { return resource.click_raise; }
- inline bool isScreenManaged(void) const { return managed; }
- inline bool doShadowFonts(void) const { return resource.shadow_fonts; }
- inline bool doAAFonts(void) const { return resource.aa_fonts; }
- inline bool doImageDither(void) const { return image_control->doDither(); }
- inline bool doOrderedDither(void) const { return resource.ordered_dither; }
- inline bool doOpaqueMove(void) const { return resource.opaque_move; }
- inline bool doFullMax(void) const { return resource.full_max; }
- inline bool doFocusNew(void) const { return resource.focus_new; }
- inline bool doFocusLast(void) const { return resource.focus_last; }
- inline int getWindowToWindowSnap(void) const
- { return resource.snap_to_windows; }
- inline int getWindowToEdgeSnap(void) const
- { return resource.snap_to_edges; }
- inline bool getWindowCornerSnap(void) const
- { return resource.window_corner_snap; }
- inline bool allowScrollLock(void) const { return resource.allow_scroll_lock; }
- inline bool doWorkspaceWarping(void) const
- { return resource.workspace_warping; }
- inline int rootScrollDirection(void) const { return resource.root_scroll; }
-
- inline const GC &getOpGC(void) const { return opGC; }
-
- inline Blackbox *getBlackbox(void) { return blackbox; }
- inline BColor *getBorderColor(void) { return &resource.border_color; }
- inline BImageControl *getImageControl(void) { return image_control; }
-
- Workspace *getWorkspace(unsigned int index) const;
-
- inline Workspace *getCurrentWorkspace(void) { return current_workspace; }
-
- inline unsigned int getHandleWidth(void) const
- { return resource.handle_width; }
- inline unsigned int getBevelWidth(void) const
- { return resource.bevel_width; }
- inline unsigned int getFrameWidth(void) const
- { return resource.frame_width; }
- inline unsigned int getBorderWidth(void) const
- { return resource.border_width; }
- inline unsigned int getResizeZones(void) const
- { return resource.resize_zones; }
- inline bool getPlaceIgnoreShaded(void) const
- { return resource.ignore_shaded; }
- inline bool getPlaceIgnoreMaximized(void) const
- { return resource.ignore_maximized; }
-
- inline unsigned int getCurrentWorkspaceID(void) const
- { return current_workspace->getID(); }
- inline unsigned int getWorkspaceCount(void) const
- { return workspacesList.size(); }
- inline unsigned int getIconCount(void) const { return iconList.size(); }
- inline unsigned int getNumberOfWorkspaces(void) const
- { return resource.workspaces; }
- inline int getPlacementPolicy(void) const
- { return resource.placement_policy; }
- inline int getSnapOffset(void) const
- { return resource.snap_offset; }
- inline int getSnapThreshold(void) const
- { return resource.snap_threshold; }
- inline int getResistanceSize(void) const
- { return resource.resistance_size; }
- inline int getRowPlacementDirection(void) const
- { return resource.row_direction; }
- inline int getColPlacementDirection(void) const
- { return resource.col_direction; }
-
- void changeWorkspaceCount(unsigned int new_count);
-
- inline void setRootColormapInstalled(bool r) { root_colormap_installed = r; }
- void saveSloppyFocus(bool s);
- void saveAutoRaise(bool a);
- void saveClickRaise(bool c);
- void saveWorkspaces(unsigned int w);
- void savePlacementPolicy(int p);
- void saveRowPlacementDirection(int d);
- void saveColPlacementDirection(int d);
- void saveSnapThreshold(int t);
- void saveSnapOffset(int o);
- void saveResistanceSize(int s);
- void saveImageDither(bool d);
- void saveShadowFonts(bool f);
- void saveAAFonts(bool f);
- void saveOpaqueMove(bool o);
- void saveFullMax(bool f);
- void saveFocusNew(bool f);
- void saveFocusLast(bool f);
- void saveWindowToEdgeSnap(int s);
- void saveWindowToWindowSnap(int s);
- void saveWindowCornerSnap(bool s);
- void saveResizeZones(unsigned int z);
- void savePlaceIgnoreShaded(bool i);
- void savePlaceIgnoreMaximized(bool i);
- void saveAllowScrollLock(bool a);
- void saveWorkspaceWarping(bool w);
- void saveRootScrollDirection(int d);
-
- inline const char *getStrftimeFormat(void)
- { return resource.strftime_format.c_str(); }
- void saveStrftimeFormat(const std::string& format);
-
- inline WindowStyle *getWindowStyle(void) { return &resource.wstyle; }
-
- BlackboxWindow *getIcon(unsigned int index);
-
- // allAvailableAreas should be used whenever possible instead of this function
- // as then Xinerama will work correctly.
- const Rect& availableArea(void) const;
-#ifdef XINERAMA
- const RectList& allAvailableAreas(void) const;
-#endif // XINERAMA
- void updateAvailableArea(void);
- void addStrut(Strut *strut);
- void removeStrut(Strut *strut);
-
- unsigned int addWorkspace(void);
- unsigned int removeLastWorkspace(void);
- void changeWorkspaceID(unsigned int id);
- void saveWorkspaceNames(void);
-
- void addSystrayWindow(Window window);
- void removeSystrayWindow(Window window);
-
- void addIcon(BlackboxWindow *w);
- void removeIcon(BlackboxWindow *w);
-
- void updateClientList(void);
- void updateStackingList(void);
- void manageWindow(Window w);
- void unmanageWindow(BlackboxWindow *w, bool remap);
- void raiseWindows(Window *workspace_stack, unsigned int num);
- void lowerWindows(Window *workspace_stack, unsigned int num);
- void reassociateWindow(BlackboxWindow *w, unsigned int wkspc_id,
- bool ignore_sticky);
- void propagateWindowName(const BlackboxWindow *bw);
- void prevFocus(void) const;
- void nextFocus(void) const;
- void raiseFocus(void) const;
- void load_rc(void);
- void save_rc(void);
- void reconfigure(void);
- void toggleFocusModel(FocusModel model);
- void shutdown(void);
- void showPosition(int x, int y);
- void showGeometry(unsigned int gx, unsigned int gy);
- void hideGeometry(void);
-
- void buttonPressEvent(const XButtonEvent *xbutton);
- void propertyNotifyEvent(const XPropertyEvent *pe);
+ //! Returns if the screen was successfully managed
+ /*!
+ If this is false, then the screen should be deleted and should NOT be
+ used.
+ */
+ inline bool managed() const { return _managed; }
+
+ //! Returns the config options set by the user scripts
+ const Config& config() const { return _config; }
+
+ //! An offscreen window which gets focus when nothing else has it
+ inline Window focuswindow() const { return _focuswindow; }
+ //! Returns the desktop being displayed
+ inline unsigned int desktop() const { return _desktop; }
+ //! Returns the number of desktops
+ inline unsigned int numDesktops() const { return _num_desktops; }
+ //! When true, the desktop is being shown and all clients are hidden
+ inline bool showingDesktop() const { return _showing_desktop; }
+
+ //! Returns the area of the screen not reserved by applications' Struts
+ /*!
+ @param desktop The desktop number of the area to retrieve for. A value of
+ 0xffffffff will return an area that combines all struts
+ on all desktops.
+ */
+ const otk::Rect& area(unsigned int desktop) const;
+
+ //! Gives the layout of how the desktops are being displayed, the number of
+ //! rows and columns etc.
+ const DesktopLayout& desktopLayout() const { return _layout; }
+
+ //! Shows and focuses the desktop and hides all the client windows, or
+ //! returns to the normal state, showing client windows.
+ void showDesktop(bool show);
+
+ //! Update's the screen's combined strut of all the clients.
+ /*!
+ Clients should call this whenever they change their strut.
+ */
+ void updateStruts();
+
+ //! Manage any pre-existing windows on the screen
+ void manageExisting();
+ //! Manage a client window
+ /*!
+ This gives the window a frame, reparents it, selects events on it, etc.
+ */
+ void manageWindow(Window window);
+ //! Unmanage a client
+ /*!
+ This removes the window's frame, reparents it to root, unselects events on
+ it, etc.
+ @param client The client to unmanage
+ */
+ void unmanageWindow(Client *client);
+
+ //! Raises a client window above all others in its stacking layer
+ /*!
+ raiseWindow has a couple of constraints that lowerWindow does not.<br>
+ 1) raiseWindow can be called after changing a Client's stack layer, and
+ the list will be reorganized properly.<br>
+ 2) raiseWindow guarantees that XRestackWindows() will <i>always</i> be
+ called for the specified client.
+ */
+ void raiseWindow(Client *client);
+
+ //! Lowers a client window below all others in its stacking layer
+ void lowerWindow(Client *client);
+
+ //! Sets the name of a desktop by changing the root window property
+ /*!
+ @param i The index of the desktop to set the name for (starts at 0)
+ @param name The name to set for the desktop
+ If the index is too large, it is simply ignored.
+ */
+ void setDesktopName(unsigned int i, const otk::ustring &name);
+
+ otk::ustring desktopName(unsigned int i) const;
+
+ void installColormap(bool install) const;
+
+ virtual void propertyHandler(const XPropertyEvent &e);
+ virtual void clientMessageHandler(const XClientMessageEvent &e);
+ virtual void mapRequestHandler(const XMapRequestEvent &e);