property changes on the window and some client messages
*/
-#include "widgetbase.hh"
-#include "otk/point.hh"
+#include "screen.hh"
#include "otk/strut.hh"
#include "otk/rect.hh"
#include "otk/eventhandler.hh"
namespace ob {
class Frame;
+class Screen;
//! The MWM Hints as retrieved from the window property
/*!
class' member variables and call whatever is nessary to complete the
change (such as causing a redraw of the titlebar after the title is changed).
*/
-class Client : public otk::EventHandler, public WidgetBase {
+class Client : public otk::EventHandler {
public:
//! The frame window which decorates around the client window
For example, with xterms, this value it the number of characters being
displayed in the terminal, instead of the number of pixels.
*/
- otk::Point _logical_size;
+ otk::Size _logical_size;
//! Width of the border on the window.
/*!
/*!
If the min is > the max, then the window is not resizable
*/
- otk::Point _min_size;
+ otk::Size _min_size;
//! The maximum size of the client window
/*!
If the min is > the max, then the window is not resizable
*/
- otk::Point _max_size;
+ otk::Size _max_size;
//! The size of increments to resize the client window by
- otk::Point _size_inc;
+ otk::Size _size_inc;
//! The base size of the client window
/*!
This value should be subtracted from the window's actual size when
displaying its size to the user, or working with its min/max size
*/
- otk::Point _base_size;
+ otk::Size _base_size;
//! Window decoration and functionality hints
MwmHints _mwmhints;
*/
DecorationFlags _decorations;
+ //! A bitmask of values in the Client::Decoration enum.
+ /*!
+ Specifies the decorations that should NOT be displayed on the client.
+ */
+ DecorationFlags _disabled_decorations;
+
//! A bitmask of values in the Client::Function enum
/*!
The values in the variable specify the ways in which the user is allowed to
*/
void shade(bool shade);
+ //! Recursively searches the client 'tree' for a modal client, always skips
+ //! the topmost node (the window you're starting with).
+ Client *Client::searchModalTree(Client *node, Client *skip);
+
//! Fires the urgent callbacks which lets the user do what they want with
//! urgent windows
void fireUrgent();
/*!
@param fs true if the window should be made fullscreen; false if it should
be returned to normal state.
+ @param savearea true to have the client's current size and position saved;
+ otherwise, they are not. You should not save when mapping a
+ new window that is set to fullscreen. This has no effect
+ when restoring a window from fullscreen.
+ */
+ void fullscreen(bool fs, bool savearea = true);
+
+ //! Maximize or unmaximize the client window
+ /*!
+ @param max true if the window should be maximized; false if it should be
+ returned to normal size.
+ @param dir 0 to set both horz and vert, 1 to set horz, 2 to set vert.
+ @param savearea true to have the client's current size and position saved;
+ otherwise, they are not. You should not save when mapping a
+ new window that is set to fullscreen. This has no effect
+ when unmaximizing a window.
*/
- void fullscreen(bool fs);
+ void maximize(bool max, int dir, bool savearea = true);
//! Internal version of the Client::move function
/*!
The x and y coordinates must both be sepcified together, or they will have
no effect. When they are specified, the anchor is ignored.
*/
- void internal_resize(Corner anchor, int w, int h, bool user = true,
- int x = INT_MIN, int y = INT_MIN);
+ void internal_resize(Corner anchor, int w, int h,
+ bool user = true, int x = INT_MIN, int y = INT_MIN);
+
+ //! Removes or reapplies the client's border to its window
+ /*!
+ Used when managing and unmanaging a window.
+ @param addborder true if adding the border to the client; false if removing
+ from the client
+ */
+ void toggleClientBorder(bool addborder);
+ //! Applies the states requested when the window mapped
+ /*!
+ This should be called only once, during the window mapping process. It
+ applies things like maximized, and fullscreen.
+ */
+ void applyStartupState();
+
public:
#ifndef SWIG
//! Constructs a new Client object around a specified window id
inline bool urgent() const { return _urgent; }
//! Returns if the window wants to be notified when it receives focus
inline bool focusNotify() const { return _focus_notify; }
+ //! Returns if the window is the focused window
+ inline bool focused() const { return _focused; }
//! Returns if the window uses the Shape extension
inline bool shaped() const { return _shaped; }
//! Returns the window's gravity
//! Returns the decorations that the client window wishes to be displayed on
//! it
inline DecorationFlags decorations() const { return _decorations; }
+ //! Returns the decorations that the user has requested to be disabled on the
+ //! client
+ inline DecorationFlags disabledDecorations() const
+ { return _disabled_decorations; }
//! Returns the functions that the user can perform on the window
inline FunctionFlags funtions() const { return _functions; }
focus while it exists/remains modal.
*/
inline bool modal() const { return _modal; }
- //! Returns if the window is shaded
+ //! The window should not be displayed by pagers
+ inline bool skipPager() const { return _skip_pager; }
+ //! The window should not be displayed by taskbars
+ inline bool skipTaskbar() const { return _skip_taskbar; }
+ //! Returns if the window is shaded
/*!
When the window is shaded, only its titlebar is visible.
*/
//! Returns the window's stacking layer
inline StackLayer layer() const { return _layer; }
- //! Applies the states requested when the window mapped
+ //! Returns the logical size of the window
/*!
- This should be called only once, during the window mapping process. It
- applies things like maximized, and fullscreen.
- */
- void applyStartupState();
-
- //! Removes or reapplies the client's border to its window
- /*!
- Used when managing and unmanaging a window.
- @param addborder true if adding the border to the client; false if removing
- from the client
+ The "logical" size of the window is refers to the user's perception of the
+ size of the window, and is the value that should be displayed to the user.
+ For example, with xterms, this value it the number of characters being
+ displayed in the terminal, instead of the number of pixels.
*/
- void toggleClientBorder(bool addborder);
+ const otk::Size &logicalSize() const { return _logical_size; }
//! Returns the position and size of the client relative to the root window
inline const otk::Rect &area() const { return _area; }
//! Returns the client's strut definition
inline const otk::Strut &strut() const { return _strut; }
- //! Move the client window
+ //! Move the window (actually, its frame) to a position.
/*!
+ This moves the window so that the top-left corner of its frame will be at
+ the position specified.
@param x The X coordinate to move to.
@param y The Y coordinate to move to.
*/
*/
void resize(Corner anchor, int w, int h);
+ //! Reapplies the maximized state to the window
+ /*!
+ Use this to make the window readjust its maximized size to new
+ surroundings (struts, etc).
+ */
+ void remaximize();
+
+ //! Choose a mask of decorations to not display on the client
+ /*!
+ Pass a value of 0 to the function to turn all decorations back on. Note
+ that you cannot add decorations to a window with this, you can only remove
+ decorations that would otherwise have been displayed.
+ @param flags The mask of values from Client::Decoration to specify which
+ decorations should not be displayed.
+ */
+ void disableDecorations(DecorationFlags flags);
+
+ //! Return a modal child of the client window
+ /*!
+ @return A modal child of the client window, or 0 if none was found.
+ */
+ Client *findModalChild();
+
//! Attempt to focus the client window
bool focus();
//! Remove focus from the client window
void unfocus() const;
+ //! Validate client, by making sure no Destroy or Unmap events exist in
+ //! the event queue for the window.
+ /*!
+ @return true if the client is valid; false if the client has already
+ been unmapped/destroyed, and so is invalid.
+ */
+ bool validate() const;
+
+ void installColormap(bool install) const;
+
virtual void focusHandler(const XFocusChangeEvent &e);
virtual void unfocusHandler(const XFocusChangeEvent &e);
virtual void propertyHandler(const XPropertyEvent &e);
virtual void mapRequestHandler(const XMapRequestEvent &e);
#if defined(SHAPE)
virtual void shapeHandler(const XShapeEvent &e);
-#endif // SHAPE
+#endif // SHAPE
+
+ friend void Screen::manageWindow(Window);
+ friend void Screen::unmanageWindow(Client *);
};
}
projects / chaz / openbox / blobdiff