---

ob::Actions Class Reference

#include <actions.hh>

Inheritance diagram for ob::Actions:

[legend]Collaboration diagram for ob::Actions:

[legend]List of all members.

---

Detailed Description

The action interface for user-available actions.

When these actions are fired, hooks to the guile engine are fired so that guile code is run.

Definition at line 28 of file actions.hh.

Public Methods
	Actions ()
	Constructs an Actions object.
virtual	~Actions ()
	Destroys the Actions object.
virtual void	buttonPressHandler (const XButtonEvent &e)
	Called whenever a button of the pointer is pressed.
virtual void	buttonReleaseHandler (const XButtonEvent &e)
	Called whenever a button of the pointer is released.
virtual void	enterHandler (const XCrossingEvent &e)
	Called whenever the pointer enters a window.
virtual void	leaveHandler (const XCrossingEvent &e)
	Called whenever the pointer leaves a window.
virtual void	keyPressHandler (const XKeyEvent &e)
	Called whenever any key is pressed.
virtual void	keyReleaseHandler (const XKeyEvent &e)
	Called whenever any key is released.
virtual void	motionHandler (const XMotionEvent &e)
	Called whenever the pointer moved.
Private Methods
void	insertPress (const XButtonEvent &e)
void	removePress (const XButtonEvent &e)
Private Attributes
unsigned int	_button
	The mouse button currently being watched from a press for a CLICK.
ButtonReleaseAction	_release
	The last button release processed for CLICKs.
ButtonPressAction *	_posqueue [BUTTONS]
	The point where the mouse was when each mouse button was pressed.
bool	_dragging
	This is set to true once a drag has started and false when done to make sure the threshold isnt checked anymore once a drag is underway.
Static Private Attributes
const int	BUTTONS = 5

---

Constructor & Destructor Documentation

ob::Actions::Actions (    )

Constructs an Actions object. Definition at line 23 of file actions.cc. References _posqueue, and BUTTONS. : _button(0), _dragging(false) { for (int i=0; i<BUTTONS; ++i) _posqueue[i] = new ButtonPressAction(); }

ob::Actions::~Actions (    )  [virtual]

Destroys the Actions object. Definition at line 32 of file actions.cc. References _posqueue, and BUTTONS. { for (int i=0; i<BUTTONS; ++i) delete _posqueue[i]; }

---

Member Function Documentation

void ob::Actions::buttonPressHandler (  const XButtonEvent &    e )  [virtual]

Called whenever a button of the pointer is pressed. Reimplemented from otk::EventHandler. Definition at line 71 of file actions.cc. References _button, ob::Openbox::bindings(), otk::EventHandler::buttonPressHandler(), buttonReleaseHandler(), ob::Openbox::findClient(), otk::EventDispatcher::findHandler(), ob::Bindings::fireButton(), insertPress(), ob::WidgetBase::mcontext(), ob::openbox, and ob::Client::screen(). { otk::EventHandler::buttonPressHandler(e); insertPress(e); // run the PRESS python hook WidgetBase *w = dynamic_cast<WidgetBase*> (openbox->findHandler(e.window)); if (!w) return; // kill off the Button1Mask etc, only want the modifiers unsigned int state = e.state & (ControlMask | ShiftMask | Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask); int screen; Client *c = openbox->findClient(e.window); if (c) screen = c->screen(); else screen = otk::display->findScreen(e.root)->screen(); MouseData data(screen, c, e.time, state, e.button, w->mcontext(), MouseAction::Press); openbox->bindings()->fireButton(&data); if (_button) return; // won't count toward CLICK events _button = e.button; if (w->mcontext() == MouseContext::Window) { /* Because of how events are grabbed on the client window, we can't get ButtonRelease events, so instead we simply manufacture them here, so that clicks/doubleclicks etc still work. */ //XButtonEvent ev = e; //ev.type = ButtonRelease; buttonReleaseHandler(e); } }

void ob::Actions::buttonReleaseHandler (  const XButtonEvent &    e )  [virtual]

Called whenever a button of the pointer is released. Reimplemented from otk::EventHandler. Definition at line 111 of file actions.cc. References _button, _dragging, _release, ob::MouseData::action, ob::Openbox::bindings(), ob::Actions::ButtonReleaseAction::button, otk::EventHandler::buttonReleaseHandler(), ob::Openbox::findClient(), otk::EventDispatcher::findHandler(), ob::Bindings::fireButton(), ob::WidgetBase::mcontext(), ob::openbox, ob::python_get_long(), removePress(), ob::Client::screen(), ob::Actions::ButtonReleaseAction::time, and ob::Actions::ButtonReleaseAction::win. Referenced by buttonPressHandler(). { otk::EventHandler::buttonReleaseHandler(e); removePress(e); WidgetBase *w = dynamic_cast<WidgetBase*> (openbox->findHandler(e.window)); if (!w) return; // run the RELEASE python hook // kill off the Button1Mask etc, only want the modifiers unsigned int state = e.state & (ControlMask | ShiftMask | Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask); int screen; Client *c = openbox->findClient(e.window); if (c) screen = c->screen(); else screen = otk::display->findScreen(e.root)->screen(); MouseData data(screen, c, e.time, state, e.button, w->mcontext(), MouseAction::Release); openbox->bindings()->fireButton(&data); // not for the button we're watching? if (_button != e.button) return; _button = 0; _dragging = false; // find the area of the window XWindowAttributes attr; if (!XGetWindowAttributes(**otk::display, e.window, &attr)) return; // if not on the window any more, it isnt a CLICK if (!(e.same_screen && e.x >= 0 && e.y >= 0 && e.x < attr.width && e.y < attr.height)) return; // run the CLICK python hook data.action = MouseAction::Click; openbox->bindings()->fireButton(&data); // XXX: dont load this every time!!@* long dblclick; if (!python_get_long("DOUBLE_CLICK_DELAY", &dblclick)) dblclick = 300; if (e.time - _release.time < (unsigned)dblclick && _release.win == e.window && _release.button == e.button) { // run the DOUBLECLICK python hook data.action = MouseAction::DoubleClick; openbox->bindings()->fireButton(&data); // reset so you cant triple click for 2 doubleclicks _release.win = 0; _release.button = 0; _release.time = 0; } else { // save the button release, might be part of a double click _release.win = e.window; _release.button = e.button; _release.time = e.time; } }

void ob::Actions::enterHandler (  const XCrossingEvent &    e )  [virtual]

Called whenever the pointer enters a window. Reimplemented from otk::EventHandler. Definition at line 179 of file actions.cc. References ob::Openbox::bindings(), otk::EventHandler::enterHandler(), ob::Openbox::findClient(), ob::Bindings::fireEvent(), ob::openbox, and ob::Client::screen(). { otk::EventHandler::enterHandler(e); // run the ENTER python hook int screen; Client *c = openbox->findClient(e.window); if (c) screen = c->screen(); else screen = otk::display->findScreen(e.root)->screen(); EventData data(screen, c, EventAction::EnterWindow, e.state); openbox->bindings()->fireEvent(&data); }

void ob::Actions::insertPress (  const XButtonEvent &    e )  [private]

Definition at line 39 of file actions.cc. References _posqueue, ob::Client::area(), ob::Actions::ButtonPressAction::button, BUTTONS, ob::Openbox::findClient(), and ob::openbox. Referenced by buttonPressHandler(). { ButtonPressAction *a = _posqueue[BUTTONS - 1]; // rm'd the last one, shift them all down one for (int i = BUTTONS-1; i > 0; --i) { _posqueue[i] = _posqueue[i-1]; } _posqueue[0] = a; a->button = e.button; a->pos.setPoint(e.x_root, e.y_root); Client *c = openbox->findClient(e.window); if (c) a->clientarea = c->area(); }

void ob::Actions::keyPressHandler (  const XKeyEvent &    e )  [virtual]

Called whenever any key is pressed. Reimplemented from otk::EventHandler. Definition at line 211 of file actions.cc. References ob::Openbox::bindings(), otk::EventHandler::keyPressHandler(), and ob::openbox. { otk::EventHandler::keyPressHandler(e); // kill off the Button1Mask etc, only want the modifiers unsigned int state = e.state & (ControlMask | ShiftMask | Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask); openbox->bindings()-> fireKey(otk::display->findScreen(e.root)->screen(), state, e.keycode, e.time, KeyAction::Press); }

void ob::Actions::keyReleaseHandler (  const XKeyEvent &    e )  [virtual]

Called whenever any key is released. Reimplemented from otk::EventHandler. Definition at line 224 of file actions.cc. References ob::Openbox::bindings(), otk::EventHandler::keyReleaseHandler(), and ob::openbox. { otk::EventHandler::keyReleaseHandler(e); // kill off the Button1Mask etc, only want the modifiers unsigned int state = e.state & (ControlMask | ShiftMask | Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask); // remove from the state the mask of the modifier being released, if it is // a modifier key being released (this is a little ugly..) const XModifierKeymap *map = otk::display->modifierMap(); const int mask_table[] = { ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask }; KeyCode *kp = map->modifiermap; for (int i = 0, n = sizeof(mask_table)/sizeof(mask_table[0]); i < n; ++i) { for (int k = 0; k < map->max_keypermod; ++k) { if (*kp == e.keycode) { // found the keycode state &= ~mask_table[i]; // remove the mask for it i = n; // cause the first loop to break; break; // get outta here! } ++kp; } } openbox->bindings()-> fireKey(otk::display->findScreen(e.root)->screen(), state, e.keycode, e.time, KeyAction::Release); }

void ob::Actions::leaveHandler (  const XCrossingEvent &    e )  [virtual]

Called whenever the pointer leaves a window. Reimplemented from otk::EventHandler. Definition at line 195 of file actions.cc. References ob::Openbox::bindings(), ob::Openbox::findClient(), ob::Bindings::fireEvent(), otk::EventHandler::leaveHandler(), ob::openbox, and ob::Client::screen(). { otk::EventHandler::leaveHandler(e); // run the LEAVE python hook int screen; Client *c = openbox->findClient(e.window); if (c) screen = c->screen(); else screen = otk::display->findScreen(e.root)->screen(); EventData data(screen, c, EventAction::LeaveWindow, e.state); openbox->bindings()->fireEvent(&data); }

void ob::Actions::motionHandler (  const XMotionEvent &    e )  [virtual]

Called whenever the pointer moved. Reimplemented from otk::EventHandler. Definition at line 257 of file actions.cc. References _dragging, _posqueue, ob::Openbox::bindings(), ob::Actions::ButtonPressAction::button, ob::Openbox::findClient(), otk::EventDispatcher::findHandler(), ob::Bindings::fireButton(), ob::WidgetBase::mcontext(), otk::EventHandler::motionHandler(), ob::openbox, ob::Actions::ButtonPressAction::pos, ob::python_get_long(), ob::Client::screen(), otk::Point::x(), and otk::Point::y(). { otk::EventHandler::motionHandler(e); if (!e.same_screen) return; // this just gets stupid int x_root = e.x_root, y_root = e.y_root; // compress changes to a window into a single change XEvent ce; while (XCheckTypedEvent(**otk::display, e.type, &ce)) { if (ce.xmotion.window != e.window) { XPutBackEvent(**otk::display, &ce); break; } else { x_root = e.x_root; y_root = e.y_root; } } WidgetBase *w = dynamic_cast<WidgetBase*> (openbox->findHandler(e.window)); if (!w) return; if (!_dragging) { long threshold; int dx = x_root - _posqueue[0]->pos.x(); int dy = y_root - _posqueue[0]->pos.y(); // XXX: dont get this from python every time! if (!python_get_long("DRAG_THRESHOLD", &threshold)) threshold = 0; if (!(std::abs(dx) >= threshold || std::abs(dy) >= threshold)) return; // not at the threshold yet } _dragging = true; // in a drag now // check if the movement is more than the threshold // run the MOTION python hook // kill off the Button1Mask etc, only want the modifiers unsigned int state = e.state & (ControlMask | ShiftMask | Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask); unsigned int button = _posqueue[0]->button; int screen; Client *c = openbox->findClient(e.window); if (c) screen = c->screen(); else screen = otk::display->findScreen(e.root)->screen(); MouseData data(screen, c, e.time, state, button, w->mcontext(), MouseAction::Motion, x_root, y_root, _posqueue[0]->pos, _posqueue[0]->clientarea); openbox->bindings()->fireButton(&data); }

void ob::Actions::removePress (  const XButtonEvent &    e )  [private]

Definition at line 54 of file actions.cc. References _posqueue, ob::Actions::ButtonPressAction::button, and BUTTONS. Referenced by buttonReleaseHandler(). { int i; ButtonPressAction *a = 0; for (i=0; i<BUTTONS-1; ++i) if (_posqueue[i]->button == e.button) { a = _posqueue[i]; break; } if (a) { // found one, remove it and shift the rest up one for (; i < BUTTONS-1; ++i) _posqueue[i] = _posqueue[i+1]; _posqueue[BUTTONS-1] = a; } _posqueue[BUTTONS-1]->button = 0; }

---

Member Data Documentation

unsigned int ob::Actions::_button [private]

The mouse button currently being watched from a press for a CLICK. Definition at line 50 of file actions.hh. Referenced by buttonPressHandler(), and buttonReleaseHandler().

bool ob::Actions::_dragging [private]

This is set to true once a drag has started and false when done to make sure the threshold isnt checked anymore once a drag is underway. Definition at line 60 of file actions.hh. Referenced by buttonReleaseHandler(), and motionHandler().

ButtonPressAction* ob::Actions::_posqueue[BUTTONS] [private]

The point where the mouse was when each mouse button was pressed. Used for motion events as the starting position. Definition at line 57 of file actions.hh. Referenced by Actions(), insertPress(), motionHandler(), removePress(), and ~Actions().

ButtonReleaseAction ob::Actions::_release [private]

The last button release processed for CLICKs. Definition at line 52 of file actions.hh. Referenced by buttonReleaseHandler().

const int ob::Actions::BUTTONS = 5 [static, private]

Definition at line 21 of file actions.cc. Referenced by Actions(), insertPress(), removePress(), and ~Actions().

---

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

• /src/actions.hh
• /src/actions.cc

---