---

ob::Bindings Class Reference

#include <bindings.hh>

Collaboration diagram for ob::Bindings:

[legend]List of all members.

Public Types
typedef std::vector< std::string >	StringVect
	A list of strings.
Public Methods
	Bindings ()
	Initializes an Bindings object.
virtual	~Bindings ()
	Destroys the Bindings object.
bool	translate (const std::string &str, Binding &b, bool askey=true) const
	Translates a binding string into the actual Binding.
bool	addKey (const StringVect &keylist, PyObject *callback)
	Adds a new key binding.
void	removeAllKeys ()
	Removes all key bindings.
void	fireKey (int screen, unsigned int modifiers, unsigned int key, Time time, KeyAction::KA action)
void	setResetKey (const std::string &key)
void	grabKeys (bool grab)
bool	grabKeyboard (int screen, PyObject *callback)
void	ungrabKeyboard ()
bool	grabPointer (int screen)
void	ungrabPointer ()
bool	addButton (const std::string &but, MouseContext::MC context, MouseAction::MA action, PyObject *callback)
void	grabButtons (bool grab, Client *client)
void	removeAllButtons ()
	Removes all button bindings.
void	fireButton (MouseData *data)
bool	addEvent (EventAction::EA action, PyObject *callback)
	Bind a callback for an event.
bool	removeEvent (EventAction::EA action, PyObject *callback)
	Unbind the callback function from an event.
void	removeAllEvents ()
	Remove all callback functions.
void	fireEvent (EventData *data)
Private Types
typedef std::list< ButtonBinding * >	ButtonBindingList
Private Methods
KeyBindingTree *	find (KeyBindingTree *search, bool *conflict) const
KeyBindingTree *	buildtree (const StringVect &keylist, PyObject *callback) const
void	assimilate (KeyBindingTree *node)
void	grabButton (bool grab, const Binding &b, MouseContext::MC context, Client *client)
Static Private Methods
void	resetChains (Bindings *self)
Private Attributes
KeyBindingTree	_keytree
KeyBindingTree *	_curpos
Binding	_resetkey
otk::Timer *	_timer
ButtonBindingList	_buttons [MouseContext::NUM_MOUSE_CONTEXT]
CallbackList	_eventlist [EventAction::NUM_EVENTS]
PyObject *	_keybgrab_callback

---

Member Typedef Documentation

typedef std::list<ButtonBinding*> ob::Bindings::ButtonBindingList [private]

Definition at line 79 of file bindings.hh.

typedef std::vector<std::string> ob::Bindings::StringVect

A list of strings. Definition at line 61 of file bindings.hh. Referenced by ob::kbind().

---

Constructor & Destructor Documentation

ob::Bindings::Bindings (    )

Initializes an Bindings object. Definition at line 147 of file bindings.cc. : _curpos(&_keytree), _resetkey(0,0), _timer((otk::Timer *) 0), _keybgrab_callback(0) { // setResetKey("C-g"); // set the default reset key }

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

Destroys the Bindings object. Definition at line 157 of file bindings.cc. References _timer, removeAllEvents(), and removeAllKeys(). { if (_timer) delete _timer; removeAllKeys(); //removeAllButtons(); // this is done by each client as they are unmanaged removeAllEvents(); }

---

Member Function Documentation

bool ob::Bindings::addButton (  const std::string &    but, MouseContext::MC    context, MouseAction::MA    action, PyObject *    callback )

Definition at line 480 of file bindings.cc. References _buttons, ob::ButtonBinding::binding, ob::ButtonBinding::callbacks, ob::Screen::clients, grabButton(), ob::Binding::key, ob::Binding::modifiers, ob::openbox, ob::Openbox::screen(), and translate(). { assert(context >= 0 && context < MouseContext::NUM_MOUSE_CONTEXT); assert(action >= 0 && action < MouseAction::NUM_MOUSE_ACTION); Binding b(0,0); if (!translate(but, b, false)) return false; ButtonBindingList::iterator it, end = _buttons[context].end(); // look for a duplicate binding for (it = _buttons[context].begin(); it != end; ++it) if ((*it)->binding.key == b.key && (*it)->binding.modifiers == b.modifiers) { break; } ButtonBinding *bind; // the binding didnt exist yet, add it if (it == end) { bind = new ButtonBinding(); bind->binding.key = b.key; bind->binding.modifiers = b.modifiers; _buttons[context].push_back(bind); // grab the button on all clients for (int sn = 0; sn < ScreenCount(**otk::display); ++sn) { Screen *s = openbox->screen(sn); if (!s) continue; // not managed Client::List::iterator c_it, c_end = s->clients.end(); for (c_it = s->clients.begin(); c_it != c_end; ++c_it) { grabButton(true, bind->binding, context, *c_it); } } } else bind = *it; bind->callbacks[action].push_back(callback); Py_INCREF(callback); return true; }

bool ob::Bindings::addEvent (  EventAction::EA    action, PyObject *    callback )

Bind a callback for an event. Definition at line 604 of file bindings.cc. References _eventlist. { if (action < 0 || action >= EventAction::NUM_EVENTS) { return false; } #ifdef XKB if (action == EventAction::Bell && _eventlist[action].empty()) XkbSelectEvents(**otk::display, XkbUseCoreKbd, XkbBellNotifyMask, XkbBellNotifyMask); #endif // XKB _eventlist[action].push_back(callback); Py_INCREF(callback); return true; }

bool ob::Bindings::addKey (  const StringVect &    keylist, PyObject *    callback )

Adds a new key binding. A binding will fail to be added if the binding already exists (as part of a chain or not), or if any of the strings in the keylist are invalid. Returns: true if the binding could be added; false if it could not. Definition at line 227 of file bindings.cc. References assimilate(), buildtree(), ob::KeyBindingTree::callbacks, ob::destroytree(), find(), and grabKeys(). { KeyBindingTree *tree, *t; bool conflict; if (!(tree = buildtree(keylist, callback))) return false; // invalid binding requested t = find(tree, &conflict); if (conflict) { // conflicts with another binding destroytree(tree); return false; } if (t) { // already bound to something t->callbacks.push_back(callback); destroytree(tree); } else { // grab the server here to make sure no key pressed go missed otk::display->grab(); grabKeys(false); // assimilate this built tree into the main tree assimilate(tree); // assimilation destroys/uses the tree grabKeys(true); otk::display->ungrab(); } Py_INCREF(callback); return true; }

void ob::Bindings::assimilate (  KeyBindingTree *    node )  [private]

Definition at line 168 of file bindings.cc. References _keytree, ob::KeyBindingTree::binding, ob::KeyBindingTree::first_child, and ob::KeyBindingTree::next_sibling. Referenced by addKey(). { KeyBindingTree *a, *b, *tmp, *last; if (!_keytree.first_child) { // there are no nodes at this level yet _keytree.first_child = node; } else { a = _keytree.first_child; last = a; b = node; while (a) { last = a; if (a->binding != b->binding) { a = a->next_sibling; } else { tmp = b; b = b->first_child; delete tmp; a = a->first_child; } } if (last->binding != b->binding) last->next_sibling = b; else { last->first_child = b->first_child; delete b; } } }

KeyBindingTree * ob::Bindings::buildtree (  const StringVect &    keylist, PyObject *    callback )  const [private]

Definition at line 120 of file bindings.cc. References ob::destroytree(), ob::KeyBindingTree, and translate(). Referenced by addKey(). { if (keylist.empty()) return 0; // nothing in the list.. return 0 KeyBindingTree *ret = 0, *p; StringVect::const_reverse_iterator it, end = keylist.rend(); for (it = keylist.rbegin(); it != end; ++it) { p = ret; ret = new KeyBindingTree(); if (!p) { // this is the first built node, the bottom node of the tree ret->chain = false; ret->callbacks.push_back(callback); } ret->first_child = p; if (!translate(*it, ret->binding)) { destroytree(ret); ret = 0; break; } } return ret; }

KeyBindingTree * ob::Bindings::find (  KeyBindingTree *    search, bool *    conflict )  const [private]

Definition at line 200 of file bindings.cc. References _keytree, ob::KeyBindingTree::binding, ob::KeyBindingTree::chain, ob::KeyBindingTree::first_child, and ob::KeyBindingTree::next_sibling. Referenced by addKey(). { *conflict = false; KeyBindingTree *a, *b; a = _keytree.first_child; b = search; while (a && b) { if (a->binding != b->binding) { a = a->next_sibling; } else { if (a->chain == b->chain) { if (!a->chain) { // found it! (return the actual id, not the search's) return a; } } else { *conflict = true; return 0; // the chain status' don't match (conflict!) } b = b->first_child; a = a->first_child; } } return 0; // it just isn't in here }

void ob::Bindings::fireButton (  MouseData *    data )

Definition at line 585 of file bindings.cc. References _buttons, ob::MouseData::action, ob::MouseData::button, ob::MouseData::context, ob::python_callback(), ob::MouseData::state, and ob::MouseData::time. Referenced by ob::Actions::buttonPressHandler(), ob::Actions::buttonReleaseHandler(), and ob::Actions::motionHandler(). { if (data->context == MouseContext::Window) { // Replay the event, so it goes to the client XAllowEvents(**otk::display, ReplayPointer, data->time); } ButtonBindingList::iterator it, end = _buttons[data->context].end(); for (it = _buttons[data->context].begin(); it != end; ++it) if ((*it)->binding.key == data->button && (*it)->binding.modifiers == data->state) { CallbackList::iterator c_it,c_end = (*it)->callbacks[data->action].end(); for (c_it = (*it)->callbacks[data->action].begin(); c_it != c_end; ++c_it) python_callback(*c_it, data); } }

void ob::Bindings::fireEvent (  EventData *    data )

Definition at line 651 of file bindings.cc. References _eventlist, ob::EventData::action, and ob::python_callback(). Referenced by ob::Actions::enterHandler(), ob::Client::fireUrgent(), ob::Actions::leaveHandler(), ob::Screen::manageWindow(), ob::Screen::Screen(), ob::Openbox::setFocusedClient(), ob::Screen::unmanageWindow(), and ob::Screen::~Screen(). { CallbackList::iterator c_it, c_end = _eventlist[data->action].end(); for (c_it = _eventlist[data->action].begin(); c_it != c_end; ++c_it) python_callback(*c_it, data); }

void ob::Bindings::fireKey (  int    screen, unsigned int    modifiers, unsigned int    key, Time    time, KeyAction::KA    action )

Definition at line 420 of file bindings.cc. References _curpos, _resetkey, _timer, ob::KeyBindingTree::binding, ob::KeyBindingTree::callbacks, ob::KeyBindingTree::chain, ob::KeyBindingTree::first_child, ob::Openbox::focusedClient(), grabKeys(), ob::Binding::key, ob::Binding::modifiers, ob::KeyBindingTree::next_sibling, ob::openbox, ob::python_callback(), and resetChains(). { if (_keybgrab_callback) { Client *c = openbox->focusedClient(); KeyData data(screen, c, time, modifiers, key, action); python_callback(_keybgrab_callback, &data); } // KeyRelease events only occur during keyboard grabs if (action == KeyAction::Release) return; if (key == _resetkey.key && modifiers == _resetkey.modifiers) { resetChains(this); } else { KeyBindingTree *p = _curpos->first_child; while (p) { if (p->binding.key == key && p->binding.modifiers == modifiers) { if (p->chain) { if (_timer) delete _timer; _timer = new otk::Timer(5000, // 5 second timeout (otk::Timer::TimeoutHandler)resetChains, this); // grab the server here to make sure no key presses get missed otk::display->grab(); grabKeys(false); _curpos = p; grabKeys(true); otk::display->ungrab(); } else { Client *c = openbox->focusedClient(); KeyData data(screen, c, time, modifiers, key, action); CallbackList::iterator it, end = p->callbacks.end(); for (it = p->callbacks.begin(); it != end; ++it) python_callback(*it, &data); resetChains(this); } break; } p = p->next_sibling; } } }

void ob::Bindings::grabButton (  bool    grab, const Binding &    b, MouseContext::MC    context, Client *    client )  [private]

Definition at line 547 of file bindings.cc. References ob::Client::frame, ob::Binding::key, ob::Binding::modifiers, ob::Frame::plate(), and otk::Widget::window(). Referenced by addButton(), grabButtons(), and removeAllButtons(). { Window win; int mode = GrabModeAsync; unsigned int mask; switch(context) { case MouseContext::Frame: win = client->frame->window(); mask = ButtonPressMask | ButtonMotionMask | ButtonReleaseMask; break; case MouseContext::Window: win = client->frame->plate(); mode = GrabModeSync; // this is handled in fireButton mask = ButtonPressMask; // can't catch more than this with Sync mode // the release event is manufactured by the // master buttonPressHandler break; default: // any other elements already get button events, don't grab on them return; } if (grab) otk::display->grabButton(b.key, b.modifiers, win, false, mask, mode, GrabModeAsync, None, None, false); else otk::display->ungrabButton(b.key, b.modifiers, win); }

void ob::Bindings::grabButtons (  bool    grab, Client *    client )

Definition at line 576 of file bindings.cc. References _buttons, and grabButton(). Referenced by ob::Screen::manageWindow(), and ob::Screen::unmanageWindow(). { for (int i = 0; i < MouseContext::NUM_MOUSE_CONTEXT; ++i) { ButtonBindingList::iterator it, end = _buttons[i].end(); for (it = _buttons[i].begin(); it != end; ++it) grabButton(grab, (*it)->binding, (MouseContext::MC)i, client); } }

bool ob::Bindings::grabKeyboard (  int    screen, PyObject *    callback )

Definition at line 375 of file bindings.cc. References _keybgrab_callback, ob::openbox, and ob::Openbox::screen(). { assert(callback); if (_keybgrab_callback) return false; // already grabbed if (!openbox->screen(screen)) return false; // the screen is not managed Window root = otk::display->screenInfo(screen)->rootWindow(); if (XGrabKeyboard(**otk::display, root, false, GrabModeAsync, GrabModeAsync, CurrentTime)) return false; _keybgrab_callback = callback; return true; }

void ob::Bindings::grabKeys (  bool    grab )

Definition at line 343 of file bindings.cc. References _curpos, _resetkey, ob::KeyBindingTree::binding, ob::KeyBindingTree::first_child, ob::Binding::key, ob::Binding::modifiers, ob::KeyBindingTree::next_sibling, ob::openbox, and ob::Openbox::screen(). Referenced by addKey(), fireKey(), ob::Openbox::Openbox(), removeAllKeys(), resetChains(), and setResetKey(). { for (int i = 0; i < ScreenCount(**otk::display); ++i) { Screen *sc = openbox->screen(i); if (!sc) continue; // not a managed screen Window root = otk::display->screenInfo(i)->rootWindow(); KeyBindingTree *p = _curpos->first_child; while (p) { if (grab) { otk::display->grabKey(p->binding.key, p->binding.modifiers, root, false, GrabModeAsync, GrabModeAsync, false); } else otk::display->ungrabKey(p->binding.key, p->binding.modifiers, root); p = p->next_sibling; } if (_resetkey.key) if (grab) otk::display->grabKey(_resetkey.key, _resetkey.modifiers, root, false, GrabModeAsync, GrabModeAsync, false); else otk::display->ungrabKey(_resetkey.key, _resetkey.modifiers, root); } }

bool ob::Bindings::grabPointer (  int    screen )

Definition at line 402 of file bindings.cc. References ob::openbox, and ob::Openbox::screen(). { if (!openbox->screen(screen)) return false; // the screen is not managed Window root = otk::display->screenInfo(screen)->rootWindow(); XGrabPointer(**otk::display, root, false, 0, GrabModeAsync, GrabModeAsync, None, None, CurrentTime); return true; }

void ob::Bindings::removeAllButtons (    )

Removes all button bindings. Definition at line 523 of file bindings.cc. References _buttons, ob::Screen::clients, grabButton(), ob::openbox, and ob::Openbox::screen(). { for (int i = 0; i < MouseContext::NUM_MOUSE_CONTEXT; ++i) { ButtonBindingList::iterator it, end = _buttons[i].end(); for (it = _buttons[i].begin(); it != end; ++it) { for (int a = 0; a < MouseAction::NUM_MOUSE_ACTION; ++a) { while (!(*it)->callbacks[a].empty()) { Py_XDECREF((*it)->callbacks[a].front()); (*it)->callbacks[a].pop_front(); } } // ungrab the button on all clients for (int sn = 0; sn < ScreenCount(**otk::display); ++sn) { Screen *s = openbox->screen(sn); if (!s) continue; // not managed Client::List::iterator c_it, c_end = s->clients.end(); for (c_it = s->clients.begin(); c_it != c_end; ++c_it) { grabButton(false, (*it)->binding, (MouseContext::MC)i, *c_it); } } } } }

void ob::Bindings::removeAllEvents (    )

Remove all callback functions. Definition at line 641 of file bindings.cc. References _eventlist. Referenced by ~Bindings(). { for (int i = 0; i < EventAction::NUM_EVENTS; ++i) { while (!_eventlist[i].empty()) { Py_XDECREF(_eventlist[i].front()); _eventlist[i].pop_front(); } } }

void ob::Bindings::removeAllKeys (    )

Removes all key bindings. Returns: The callbackid of the binding, or '< 0' if there was no binding to be removed. Definition at line 332 of file bindings.cc. References _keytree, ob::KeyBindingTree::first_child, grabKeys(), and ob::remove_branch(). Referenced by ~Bindings(). { grabKeys(false); if (_keytree.first_child) { remove_branch(_keytree.first_child); _keytree.first_child = 0; } grabKeys(true); }

bool ob::Bindings::removeEvent (  EventAction::EA    action, PyObject *    callback )

Unbind the callback function from an event. Definition at line 619 of file bindings.cc. References _eventlist. { if (action < 0 || action >= EventAction::NUM_EVENTS) { return false; } CallbackList::iterator it = std::find(_eventlist[action].begin(), _eventlist[action].end(), callback); if (it != _eventlist[action].end()) { Py_XDECREF(*it); _eventlist[action].erase(it); #ifdef XKB if (action == EventAction::Bell && _eventlist[action].empty()) XkbSelectEvents(**otk::display, XkbUseCoreKbd, XkbBellNotifyMask, 0); #endif // XKB return true; } return false; }

void ob::Bindings::resetChains (  Bindings *    self )  [static, private]

Definition at line 465 of file bindings.cc. References _curpos, _keytree, _timer, and grabKeys(). Referenced by fireKey(). { if (self->_timer) { delete self->_timer; self->_timer = (otk::Timer *) 0; } // grab the server here to make sure no key pressed go missed otk::display->grab(); self->grabKeys(false); self->_curpos = &self->_keytree; self->grabKeys(true); otk::display->ungrab(); }

void ob::Bindings::setResetKey (  const std::string &    key )

Definition at line 299 of file bindings.cc. References _resetkey, grabKeys(), ob::Binding::key, ob::Binding::modifiers, and translate(). { Binding b(0, 0); if (translate(key, b)) { // grab the server here to make sure no key pressed go missed otk::display->grab(); grabKeys(false); _resetkey.key = b.key; _resetkey.modifiers = b.modifiers; grabKeys(true); otk::display->ungrab(); } }

bool ob::Bindings::translate (  const std::string &    str, Binding &    b, bool    askey = true )  const

Translates a binding string into the actual Binding. Definition at line 73 of file bindings.cc. References _, ob::buttonvalue(), ob::Binding::key, ob::Binding::modifiers, and ob::modvalue(). Referenced by addButton(), buildtree(), and setResetKey(). { // parse out the base key name std::string::size_type keybegin = str.find_last_of('-'); keybegin = (keybegin == std::string::npos) ? 0 : keybegin + 1; std::string key(str, keybegin); // parse out the requested modifier keys unsigned int modval = 0; std::string::size_type begin = 0, end; while (begin != keybegin) { end = str.find_first_of('-', begin); std::string mod(str, begin, end-begin); if (!modvalue(mod, &modval)) { printf(_("Invalid modifier element in key binding: %s\n"), mod.c_str()); return false; } begin = end + 1; } // set the binding b.modifiers = modval; if (askey) { KeySym sym = XStringToKeysym(const_cast<char *>(key.c_str())); if (sym == NoSymbol) { printf(_("Invalid Key name in key binding: %s\n"), key.c_str()); return false; } if (!(b.key = XKeysymToKeycode(**otk::display, sym))) printf(_("No valid keycode for Key in key binding: %s\n"), key.c_str()); return b.key != 0; } else { return buttonvalue(key, &b.key); } }

void ob::Bindings::ungrabKeyboard (    )

Definition at line 392 of file bindings.cc. References _keybgrab_callback. { if (!_keybgrab_callback) return; // not grabbed _keybgrab_callback = 0; XUngrabKeyboard(**otk::display, CurrentTime); XUngrabPointer(**otk::display, CurrentTime); }

void ob::Bindings::ungrabPointer (    )

Definition at line 414 of file bindings.cc. { XUngrabPointer(**otk::display, CurrentTime); }

---

Member Data Documentation

ButtonBindingList ob::Bindings::_buttons[MouseContext::NUM_MOUSE_CONTEXT] [private]

Definition at line 80 of file bindings.hh. Referenced by addButton(), fireButton(), grabButtons(), and removeAllButtons().

KeyBindingTree* ob::Bindings::_curpos [private]

Definition at line 66 of file bindings.hh. Referenced by fireKey(), grabKeys(), and resetChains().

CallbackList ob::Bindings::_eventlist[EventAction::NUM_EVENTS] [private]

Definition at line 85 of file bindings.hh. Referenced by addEvent(), fireEvent(), removeAllEvents(), and removeEvent().

PyObject* ob::Bindings::_keybgrab_callback [private]

Definition at line 87 of file bindings.hh. Referenced by grabKeyboard(), and ungrabKeyboard().

KeyBindingTree ob::Bindings::_keytree [private]

Definition at line 65 of file bindings.hh. Referenced by assimilate(), find(), removeAllKeys(), and resetChains().

Binding ob::Bindings::_resetkey [private]

Definition at line 68 of file bindings.hh. Referenced by fireKey(), grabKeys(), and setResetKey().

otk::Timer* ob::Bindings::_timer [private]

Definition at line 70 of file bindings.hh. Referenced by fireKey(), resetChains(), and ~Bindings().

---

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

• /src/bindings.hh
• /src/bindings.cc

---