fluxbox/src/Window.hh
2007-12-21 16:48:11 -08:00

651 lines
23 KiB
C++

// Window.hh for Fluxbox Window Manager
// Copyright (c) 2001 - 2006 Henrik Kinnunen (fluxgen at fluxbox dot org)
//
// Window.hh for Blackbox - an X11 Window manager
// Copyright (c) 1997 - 2000 Brad Hughes (bhughes at tcac.net)
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
// $Id$
#ifndef WINDOW_HH
#define WINDOW_HH
#include "FbTk/Timer.hh"
#include "FbTk/Subject.hh"
#include "FbTk/Observer.hh"
#include "FbTk/EventHandler.hh"
#include "FbTk/XLayerItem.hh"
#include "FbWinFrame.hh"
#include "Focusable.hh"
#include "WinButton.hh"
#include <X11/Xlib.h>
#include <X11/Xutil.h>
#include <sys/time.h>
#include <vector>
#include <string>
#include <memory>
#include <map>
class WinClient;
class FbWinFrameTheme;
class BScreen;
class FbWinFrame;
namespace FbTk {
class TextButton;
class MenuTheme;
class ImageControl;
class XLayer;
class Menu;
}
/// Creates the window frame and handles any window event for it
class FluxboxWindow: public Focusable, public FbTk::Observer,
public FbTk::EventHandler {
public:
/// Motif wm Hints
enum {
MwmHintsFunctions = (1l << 0), ///< use motif wm functions
MwmHintsDecorations = (1l << 1) ///< use motif wm decorations
};
/// Motif wm functions
enum MwmFunc{
MwmFuncAll = (1l << 0), ///< all motif wm functions
MwmFuncResize = (1l << 1), ///< resize
MwmFuncMove = (1l << 2), ///< move
MwmFuncIconify = (1l << 3), ///< iconify
MwmFuncMaximize = (1l << 4), ///< maximize
MwmFuncClose = (1l << 5) ///< close
};
/// Motif wm decorations
enum MwmDecor {
MwmDecorAll = (1l << 0), /// all decorations
MwmDecorBorder = (1l << 1), /// border
MwmDecorHandle = (1l << 2), /// handle
MwmDecorTitle = (1l << 3), /// title
MwmDecorMenu = (1l << 4), /// menu
MwmDecorIconify = (1l << 5), /// iconify
MwmDecorMaximize = (1l << 6) /// maximize
};
/// attributes for BlackboxHints
enum Attrib {
ATTRIB_SHADED = 0x01, ///< shaded
ATTRIB_MAXHORIZ = 0x02, ///< maximized horizontal
ATTRIB_MAXVERT = 0x04, ///< maximized vertical
ATTRIB_OMNIPRESENT = 0x08, ///< omnipresent (sticky)
ATTRIB_WORKSPACE = 0x10, ///< workspace
ATTRIB_STACK = 0x20, ///< stack
ATTRIB_DECORATION = 0x40, ///< decorations
ATTRIB_HIDDEN = 0x80, ///< hidden
};
/**
* Types of maximization
*/
enum MaximizeMode {
MAX_NONE = 0, ///< normal state
MAX_HORZ = 1, ///< maximize horizontal
MAX_VERT = 2, ///< maximize vertical
MAX_FULL = 3 ///< maximize full
};
/**
This enumeration represents individual decoration
attributes, they can be OR-d together to get a mask.
Useful for saving.
*/
enum DecorationMask {
DECORM_TITLEBAR = (1<<0),
DECORM_HANDLE = (1<<1),
DECORM_BORDER = (1<<2),
DECORM_ICONIFY = (1<<3),
DECORM_MAXIMIZE = (1<<4),
DECORM_CLOSE = (1<<5),
DECORM_MENU = (1<<6),
DECORM_STICKY = (1<<7),
DECORM_SHADE = (1<<8),
DECORM_TAB = (1<<9),
DECORM_ENABLED = (1<<10),
DECORM_LAST = (1<<11) // useful for getting "All"
};
enum Decoration {
DECOR_NONE = 0,
DECOR_NORMAL = DECORM_LAST - 1,
DECOR_TINY = DECORM_TITLEBAR|DECORM_ICONIFY|DECORM_MENU|DECORM_TAB,
DECOR_TOOL = DECORM_TITLEBAR|DECORM_MENU,
DECOR_BORDER = DECORM_BORDER|DECORM_MENU,
DECOR_TAB = DECORM_BORDER|DECORM_MENU|DECORM_TAB
};
/// Different resize modes when resizing a window
enum ResizeModel {
QUADRANTRESIZE, ///< resizes from one quadrant
CENTERRESIZE, ///< resizes from center
NEARESTEDGERESIZE, ///< resizes the nearest edge
TOPLEFTRESIZE, ///< resizes top left corner
TOPRESIZE, ///< resizes top edge
TOPRIGHTRESIZE, ///< resizes top right corner
LEFTRESIZE, ///< resizes left edge
RIGHTRESIZE, ///< resizes right edge
BOTTOMLEFTRESIZE, ///< resizes bottom left corner
BOTTOMRESIZE, ///< resizes bottom edge
BOTTOMRIGHTRESIZE, ///< resizes bottom right corner
DEFAULTRESIZE = BOTTOMRIGHTRESIZE ///< default resize mode
};
/**
* Resize direction while resizing
*/
enum ResizeDirection {
NOCORNER = -1,
LEFTTOP = 0,
TOP = 1,
RIGHTTOP = 2,
RIGHT = 3,
RIGHTBOTTOM = 4,
BOTTOM = 5,
LEFTBOTTOM = 6,
LEFT = 7,
ALLCORNERS = 8
};
/// holds old blackbox attributes
typedef struct _blackbox_attributes {
unsigned long flags, attrib, workspace, stack;
long premax_x, premax_y;
unsigned long premax_w, premax_h;
} BlackboxAttributes;
typedef std::list<WinClient *> ClientList;
/// create a window from a client
FluxboxWindow(WinClient &client,
FbWinFrameTheme &tm,
FbTk::XLayer &layer);
virtual ~FluxboxWindow();
/// attach client to our client list and remove it from old window
void attachClient(WinClient &client, int x=-1, int y=-1);
/// detach client (remove it from list) and create a new window for it
bool detachClient(WinClient &client);
/// detach current working client if we have more than one
void detachCurrentClient();
/// remove client from client list
bool removeClient(WinClient &client);
/// set new current client and raise it
bool setCurrentClient(WinClient &client, bool setinput = true);
/**
* Searches for a client
* @param win the client X window
* @return pointer to client matching the window or NULL
*/
WinClient *findClient(Window win);
/// select next client
void nextClient();
/// select previous client
void prevClient();
/// move the current client to the left
void moveClientLeft();
/// move the current client to the right
void moveClientRight();
/**
* Move a client to the right of dest.
* @param win the client to move
* @param dest the left-of-client
*/
void moveClientRightOf(WinClient &win, WinClient &dest);
/**
* Move a client to the right of dest.
* @param win the client to move
* @param dest the left-of-client
*/
void moveClientLeftOf(WinClient &win, WinClient &dest);
/**
* Move client to place specified by pixel position
* @param win the client to move
* @param x position
* @param y position
*/
void moveClientTo(WinClient &win, int x, int y);
/**
* Calculates insertition position in the list by
* using pixel position x and y.
* @param x position
* @param y position
* @return iterator position for insertion
*/
ClientList::iterator getClientInsertPosition(int x, int y);
/**
* Take focus.
* @see Focusable
* @return true if it took focus.
*/
bool focus();
bool allowsFocusFromClient();
/// Raises the window and takes focus (if possible).
void raiseAndFocus() { raise(); focus(); }
/// sets the internal focus flag
void setFocusFlag(bool flag);
/// make this window visible
void show();
/// hide window
void hide(bool interrupt_moving = true);
/// iconify window
void iconify();
/**
* Deiconify window
* @param do_raise raise the window when its been deiconfied
*/
void deiconify(bool do_raise = true);
// ------------------
// Per window transparency addons
unsigned char getFocusedAlpha() const { return frame().getAlpha(true); }
unsigned char getUnfocusedAlpha() const { return frame().getAlpha(false); }
void setFocusedAlpha(unsigned char alpha) { frame().setAlpha(true, alpha); }
void setUnfocusedAlpha(unsigned char alpha) { frame().setAlpha(false, alpha); }
void updateAlpha(bool focused, unsigned char alpha) { frame().setAlpha(focused, alpha); }
bool getUseDefaultAlpha() const { return frame().getUseDefaultAlpha(); }
void setUseDefaultAlpha(bool default_alpha) { frame().setUseDefaultAlpha(default_alpha); }
// ------------------
/// close current client
void close();
/// kill current client
void kill();
/// set fullscreen
void setFullscreen(bool flag);
/// toggle maximize
void maximize(int type = MAX_FULL);
/// sets the maximized state
void setMaximizedState(int type);
/// maximizes the window horizontal
void maximizeHorizontal();
/// maximizes the window vertical
void maximizeVertical();
/// maximizes the window fully
void maximizeFull();
/// toggles shade
void shade();
/// shades window
void shadeOn();
/// unshades window
void shadeOff();
/// toggles sticky
void stick();
/// toggles iconic
void toggleIconic();
void raise();
void lower();
void tempRaise();
void raiseLayer();
void lowerLayer();
/// moves the window to a new layer
void moveToLayer(int layernum, bool force = false);
int getOnHead() const;
void setOnHead(int head);
/// sets the window focus hidden state
void placeWindow(int head);
void setFocusHidden(bool value);
/// sets the window icon hidden state
void setIconHidden(bool value);
void reconfigure();
void installColormap(bool);
void restore(WinClient *client, bool remap);
void restore(bool remap);
/// move frame to x, y
void move(int x, int y);
/// resize frame to width, height
void resize(unsigned int width, unsigned int height);
/// move and resize frame to pox x,y and size width, height
void moveResize(int x, int y, unsigned int width, unsigned int height, bool send_event = false);
/// move to pos x,y and resize client window to size width, height
void moveResizeForClient(int x, int y, unsigned int width, unsigned int height, int gravity = ForgetGravity, unsigned int client_bw = 0);
/**
* Determines maximum size using all clients that this window can have.
* @param width will be filled in with maximum width
* @param height will be filled in with maximum height
*/
void maxSize(unsigned int &width, unsigned int &height);
void setWorkspace(int n);
void updateFunctions();
void restoreAttributes();
/**
* Show window meny at at given position
* @param mx position
* @param my position
*/
void showMenu(int mx, int my);
// popup menu on last button press position
void popupMenu();
void pauseMoving();
void resumeMoving();
/**
@name event handlers
*/
//@{
void handleEvent(XEvent &event);
void keyPressEvent(XKeyEvent &ke);
void buttonPressEvent(XButtonEvent &be);
void buttonReleaseEvent(XButtonEvent &be);
void motionNotifyEvent(XMotionEvent &me);
void destroyNotifyEvent(XDestroyWindowEvent &dwe);
void mapRequestEvent(XMapRequestEvent &mre);
void mapNotifyEvent(XMapEvent &mapev);
void unmapNotifyEvent(XUnmapEvent &unmapev);
void exposeEvent(XExposeEvent &ee);
void configureRequestEvent(XConfigureRequestEvent &ce);
void propertyNotifyEvent(WinClient &client, Atom a);
void enterNotifyEvent(XCrossingEvent &ev);
void leaveNotifyEvent(XCrossingEvent &ev);
//@}
/// handle Subject notifications
void update(FbTk::Subject *subj);
void applyDecorations(bool initial = false);
void toggleDecoration();
unsigned int decorationMask() const;
void setDecorationMask(unsigned int mask, bool apply = true);
/**
* Start moving process, grabs the pointer and draws move rectangle
* @param x position of pointer
* @param y position of pointer
*/
void startMoving(int x, int y);
/**
* Stop moving process
* @param interrupted whether the move was interrupted by hide or destroy
*/
void stopMoving(bool interrupted = false);
/**
* Starts resizing process
* @param x start position
* @param y start position
* @param dir the resize direction
*/
void startResizing(int x, int y, ResizeDirection dir);
/// determine which edge or corner to resize
ResizeDirection getResizeDirection(int x, int y, ResizeModel model);
/// stops the resizing
void stopResizing(bool interrupted = false);
/// starts tabbing
void startTabbing(const XButtonEvent &be);
/**
@name accessors
*/
//@{
// whether this window can be tabbed with other windows,
// and others tabbed with it
inline void setTabable(bool tabable) { functions.tabable = tabable; }
inline bool isTabable() { return functions.tabable; }
inline void setMovable(bool movable) { functions.move = movable; }
inline void setResizable(bool resizable) { functions.resize = resizable; }
inline bool isFocusHidden() const { return m_focus_hidden; }
inline bool isIconHidden() const { return m_icon_hidden; }
inline bool isManaged() const { return m_initialized; }
bool isVisible() const;
inline bool isIconic() { return iconic; }
inline bool isIconic() const { return iconic; }
inline bool isShaded() { return shaded; }
inline bool isShaded() const { return shaded; }
inline bool isFullscreen() const { return fullscreen; }
inline bool isMaximized() const { return maximized == MAX_FULL; }
inline bool isMaximizedVert() const { return (bool)(maximized & MAX_VERT); }
inline bool isMaximizedHorz() const { return (bool)(maximized & MAX_HORZ); }
inline int maximizedState() const { return maximized; }
inline bool isIconifiable() const { return functions.iconify; }
inline bool isMaximizable() const { return functions.maximize; }
inline bool isResizable() const { return functions.resize; }
inline bool isClosable() const { return functions.close; }
inline bool isMoveable() const { return functions.move; }
inline bool isStuck() const { return stuck; }
inline bool hasTitlebar() const { return decorations.titlebar; }
inline bool isMoving() const { return moving; }
inline bool isResizing() const { return resizing; }
bool isGroupable() const;
inline int numClients() const { return m_clientlist.size(); }
inline bool empty() const { return m_clientlist.empty(); }
inline ClientList &clientList() { return m_clientlist; }
inline const ClientList &clientList() const { return m_clientlist; }
inline WinClient &winClient() { return *m_client; }
inline const WinClient &winClient() const { return *m_client; }
bool isTyping();
inline const FbTk::XLayerItem &layerItem() const { return m_frame.layerItem(); }
inline FbTk::XLayerItem &layerItem() { return m_frame.layerItem(); }
Window clientWindow() const;
FbTk::FbWindow &fbWindow();
const FbTk::FbWindow &fbWindow() const;
FbTk::Menu &menu();
const FbTk::Menu &menu() const;
const FbTk::FbWindow &parent() const { return m_parent; }
FbTk::FbWindow &parent() { return m_parent; }
bool acceptsFocus() const;
const FbTk::PixmapWithMask &icon() const;
const std::string &title() const;
const std::string &getWMClassName() const;
const std::string &getWMClassClass() const;
std::string getWMRole() const;
Focusable::WindowType getWindowType() const;
void setWindowType(Focusable::WindowType type);
bool isTransient() const;
inline int x() const { return frame().x(); }
inline int y() const { return frame().y(); }
inline unsigned int width() const { return frame().width(); }
inline unsigned int height() const { return frame().height(); }
int normalX() const;
int normalY() const;
unsigned int normalWidth() const;
unsigned int normalHeight() const;
inline int xOffset() const { return frame().xOffset(); }
inline int yOffset() const { return frame().yOffset(); }
inline int widthOffset() const { return frame().widthOffset(); }
inline int heightOffset() const { return frame().heightOffset(); }
unsigned int workspaceNumber() const { return m_workspace_number; }
int layerNum() const { return m_layernum; }
void setLayerNum(int layernum);
static int getDecoMaskFromString(const std::string &str);
unsigned int titlebarHeight() const;
int initialState() const;
inline FbWinFrame &frame() { return m_frame; }
inline const FbWinFrame &frame() const { return m_frame; }
/**
@name signals
@{
*/
FbTk::Subject &stateSig() { return m_statesig; }
const FbTk::Subject &stateSig() const { return m_statesig; }
FbTk::Subject &layerSig() { return m_layersig; }
const FbTk::Subject &layerSig() const { return m_layersig; }
FbTk::Subject &hintSig() { return m_hintsig; }
const FbTk::Subject &hintSig() const { return m_hintsig; }
FbTk::Subject &workspaceSig() { return m_workspacesig; }
const FbTk::Subject &workspaceSig() const { return m_workspacesig; }
/** @} */ // end group signals
void reconfigTheme();
//@}
class WinSubject: public FbTk::Subject {
public:
WinSubject(FluxboxWindow &w):m_win(w) { }
FluxboxWindow &win() { return m_win; }
const FluxboxWindow &win() const { return m_win; }
private:
FluxboxWindow &m_win;
};
bool oplock; ///< Used to help stop transient loops occurring by locking a window during certain operations
private:
static const int PropBlackboxAttributesElements = 8;
void setupWindow();
void updateButtons();
void init();
void updateClientLeftWindow();
void grabButtons();
/// try to attach current attaching client to a window at pos x, y
void attachTo(int x, int y, bool interrupted = false);
bool getState();
void updateMWMHintsFromClient(WinClient &client);
void updateRememberStateFromClient(WinClient &client);
void saveBlackboxAttribs();
void associateClientWindow(bool use_attrs = false, int x = 0, int y = 0, unsigned int width = 1, unsigned int height = 1, int gravity = ForgetGravity, unsigned int client_bw = 0);
void setState(unsigned long stateval, bool setting_up);
// modifies left and top if snap is necessary
void doSnapping(int &left, int &top);
// user_w/h return the values that should be shown to the user
void fixsize(int *user_w = 0, int *user_h = 0, bool maximizing = false);
void moveResizeClient(WinClient &client, int x, int y, unsigned int width, unsigned int height);
/// sends configurenotify to all clients
void sendConfigureNotify();
static void grabPointer(Window grab_window,
Bool owner_events,
unsigned int event_mask,
int pointer_mode, int keyboard_mode,
Window confine_to,
Cursor cursor,
Time time);
static void ungrabPointer(Time time);
void associateClient(WinClient &client);
// state and hint signals
WinSubject m_hintsig,
m_statesig,
m_layersig,
m_workspacesig;
class ThemeListener: public FbTk::Observer {
public:
ThemeListener(FluxboxWindow &win):m_win(win) { }
void update(FbTk::Subject *) {
m_win.reconfigTheme();
}
private:
FluxboxWindow &m_win;
};
ThemeListener m_themelistener;
time_t m_creation_time;
// Window states
bool moving, resizing, shaded, iconic,
stuck, m_initialized, fullscreen;
int maximized;
WinClient *m_attaching_tab;
FbTk::Timer m_timer;
Display *display; /// display connection
BlackboxAttributes m_blackbox_attrib;
int m_button_grab_x, m_button_grab_y; // handles last button press event for move
int m_last_resize_x, m_last_resize_y; // handles last button press event for resize
int m_last_move_x, m_last_move_y; // handles last pos for non opaque moving
unsigned int m_last_resize_h, m_last_resize_w; // handles height/width for resize "window"
timeval m_last_keypress_time;
unsigned int m_workspace_number;
unsigned long m_current_state; // NormalState | IconicState | Withdrawn
unsigned int m_old_decoration_mask;
ClientList m_clientlist;
WinClient *m_client; ///< current client
typedef std::map<WinClient *, IconButton *> Client2ButtonMap;
Client2ButtonMap m_labelbuttons;
struct _decorations {
bool titlebar, handle, border, iconify,
maximize, close, menu, sticky, shade, tab, enabled;
} decorations;
std::vector<WinButton::Type> m_titlebar_buttons[2];
bool m_toggled_decos;
struct _functions {
bool resize, move, iconify, maximize, close, tabable;
} functions;
bool m_icon_hidden; ///< if the window is in the iconbar
bool m_focus_hidden; ///< if the window is in the NextWindow list
int m_old_pos_x, m_old_pos_y; ///< old position so we can restore from maximized
unsigned int m_old_width, m_old_height; ///< old size so we can restore from maximized state
int m_last_button_x, ///< last known x position of the mouse button
m_last_button_y; ///< last known y position of the mouse button
FbWinFrame m_frame; ///< the actuall window frame
bool m_placed; ///< determine whether or not we should place the window
int m_layernum;
int m_old_layernum;
FbTk::FbWindow &m_parent; ///< window on which we draw move/resize rectangle (the "root window")
ResizeDirection m_resize_corner; //< the current resize corner used while resizing
static int s_num_grabs; ///< number of XGrabPointer's
};
#endif // WINDOW_HH