diff options
Diffstat (limited to 'kdecore/kaccelmanager.cpp')
| -rw-r--r-- | kdecore/kaccelmanager.cpp | 872 |
1 files changed, 0 insertions, 872 deletions
diff --git a/kdecore/kaccelmanager.cpp b/kdecore/kaccelmanager.cpp deleted file mode 100644 index 6e8f08e0a..000000000 --- a/kdecore/kaccelmanager.cpp +++ /dev/null @@ -1,872 +0,0 @@ -/* This file is part of the KDE project - Copyright (C) 2002 Matthias H�lzer-Kl�pfel <mhk@kde.org> - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Library General Public - License as published by the Free Software Foundation; either - version 2 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Library General Public License for more details. - - You should have received a copy of the GNU Library General Public License - along with this library; see the file COPYING.LIB. If not, write to - the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, - Boston, MA 02110-1301, USA. -*/ - -#include "kaccelmanager.h" - -#include <tqapplication.h> -#include <tqcheckbox.h> -#include <tqcombobox.h> -#include <tqgroupbox.h> -#include <tqlabel.h> -#include <tqlineedit.h> -#include <tqmenubar.h> -#include <tqmemarray.h> -#include <tqmetaobject.h> -#include <tqmainwindow.h> -#include <tqobjectlist.h> -#include <tqpopupmenu.h> -#include <tqptrlist.h> -#include <tqpushbutton.h> -#include <tqradiobutton.h> -#include <tqspinbox.h> -#include <tqtabbar.h> -#include <tqtextview.h> -#include <tqwidget.h> -#include <tqwidgetstack.h> - -#include <kstdaction.h> -#include <kstaticdeleter.h> -#include <kdebug.h> - - -#include "kaccelmanager_private.h" -#include "../tdeui/kstdaction_p.h" -#include "../kutils/kmultitabbar.h" - - -/********************************************************************* - - class Item - helper class containing widget information - - This class stores information about the widgets the need accelerators, - as well as about their relationship. - - *********************************************************************/ - - - -/********************************************************************* - - class KAcceleratorManagerPrivate - internal helper class - - This class does all the work to find accelerators for a hierarchy of - widgets. - - *********************************************************************/ - - -class KAcceleratorManagerPrivate -{ -public: - - static void manage(TQWidget *widget); - static bool programmers_mode; - static bool standardName(const TQString &str); - - static bool checkChange(const KAccelString &as) { - TQString t2 = as.accelerated(); - TQString t1 = as.originalText(); - if (t1 != t2) - { - if (as.accel() == -1) { - removed_string += "<tr><td>" + TQStyleSheet::escape(t1) + "</td></tr>"; - } else if (as.originalAccel() == -1) { - added_string += "<tr><td>" + TQStyleSheet::escape(t2) + "</td></tr>"; - } else { - changed_string += "<tr><td>" + TQStyleSheet::escape(t1) + "</td>"; - changed_string += "<td>" + TQStyleSheet::escape(t2) + "</td></tr>"; - } - return true; - } - return false; - } - static TQString changed_string; - static TQString added_string; - static TQString removed_string; - static TQMap<TQWidget *, int> ignored_widgets; - -private: - class Item; -public: - typedef TQPtrList<Item> ItemList; - -private: - static void traverseChildren(TQWidget *widget, Item *item); - - static void manageWidget(TQWidget *widget, Item *item); - static void manageMenuBar(TQMenuBar *mbar, Item *item); - static void manageTabBar(TQTabBar *bar, Item *item); - - static void calculateAccelerators(Item *item, TQString &used); - - class Item - { - public: - - Item() : m_widget(0), m_children(0), m_index(-1) {} - ~Item(); - - void addChild(Item *item); - - TQWidget *m_widget; - KAccelString m_content; - ItemList *m_children; - int m_index; - - }; -}; - - -bool KAcceleratorManagerPrivate::programmers_mode = false; -TQString KAcceleratorManagerPrivate::changed_string; -TQString KAcceleratorManagerPrivate::added_string; -TQString KAcceleratorManagerPrivate::removed_string; -static TQStringList *kaccmp_sns = 0; -static KStaticDeleter<TQStringList> kaccmp_sns_d; -TQMap<TQWidget*, int> KAcceleratorManagerPrivate::ignored_widgets; - -bool KAcceleratorManagerPrivate::standardName(const TQString &str) -{ - if (!kaccmp_sns) - kaccmp_sns_d.setObject(kaccmp_sns, new TQStringList(KStdAction::internal_stdNames())); - return kaccmp_sns->contains(str); -} - -KAcceleratorManagerPrivate::Item::~Item() -{ - delete m_children; -} - - -void KAcceleratorManagerPrivate::Item::addChild(Item *item) -{ - if (!m_children) { - m_children = new ItemList; - m_children->setAutoDelete(true); - } - - m_children->append(item); -} - -void KAcceleratorManagerPrivate::manage(TQWidget *widget) -{ - if (!widget) - { - kdDebug(131) << "null pointer given to manage" << endl; - return; - } - - if (dynamic_cast<TQPopupMenu*>(widget)) - { - // create a popup accel manager that can deal with dynamic menus - KPopupAccelManager::manage(static_cast<TQPopupMenu*>(widget)); - return; - } - - Item *root = new Item; - - manageWidget(widget, root); - - TQString used; - calculateAccelerators(root, used); - delete root; -} - - -void KAcceleratorManagerPrivate::calculateAccelerators(Item *item, TQString &used) -{ - if (!item->m_children) - return; - - // collect the contents - KAccelStringList contents; - for (Item *it = item->m_children->first(); it != 0; - it = item->m_children->next()) - { - contents << it->m_content; - } - - // find the right accelerators - KAccelManagerAlgorithm::findAccelerators(contents, used); - - // write them back into the widgets - int cnt = -1; - for (Item *it = item->m_children->first(); it != 0; - it = item->m_children->next()) - { - cnt++; - - TQTabBar *tabBar = dynamic_cast<TQTabBar*>(it->m_widget); - if (tabBar) - { - if (checkChange(contents[cnt])) - tabBar->tabAt(it->m_index)->setText(contents[cnt].accelerated()); - continue; - } - TQMenuBar *menuBar = dynamic_cast<TQMenuBar*>(it->m_widget); - if (menuBar) - { - if (it->m_index >= 0) - { - TQMenuItem *mitem = menuBar->findItem(menuBar->idAt(it->m_index)); - if (mitem) - { - checkChange(contents[cnt]); - mitem->setText(contents[cnt].accelerated()); - } - continue; - } - } - // we possibly reserved an accel, but we won't set it as it looks silly - if ( dynamic_cast<TQGroupBox*>( it->m_widget ) ) - continue; - // links look weird with ampersands - if ( dynamic_cast<TQLabel*>( it->m_widget ) && it->m_widget->inherits("KURLLabel") ) - continue; - - int tprop = it->m_widget->tqmetaObject()->findProperty("text", true); - if (tprop != -1) { - if (checkChange(contents[cnt])) - it->m_widget->setProperty("text", contents[cnt].accelerated()); - } else { - tprop = it->m_widget->tqmetaObject()->findProperty("title", true); - if (tprop != -1 && checkChange(contents[cnt])) - it->m_widget->setProperty("title", contents[cnt].accelerated()); - } - } - - // calculate the accelerators for the children - for (Item *it = item->m_children->first(); it != 0; - it = item->m_children->next()) - { - if (it->m_widget && it->m_widget->isVisibleTo( item->m_widget ) ) - calculateAccelerators(it, used); - } -} - - -void KAcceleratorManagerPrivate::traverseChildren(TQWidget *widget, Item *item) -{ - TQObjectList *childList = widget->queryList(TQWIDGET_OBJECT_NAME_STRING, 0, false, false); - for ( TQObject *it = childList->first(); it; it = childList->next() ) - { - TQWidget *w = TQT_TQWIDGET(it); - - if ( !w->isVisibleTo( widget ) || ( w->isTopLevel() && dynamic_cast<TQPopupMenu*>(w) == NULL ) ) - continue; - - if ( KAcceleratorManagerPrivate::ignored_widgets.find( w ) != KAcceleratorManagerPrivate::ignored_widgets.end() ) - continue; - - manageWidget(w, item); - } - delete childList; -} - -void KAcceleratorManagerPrivate::manageWidget(TQWidget *w, Item *item) -{ - // first treat the special cases - - TQTabBar *tabBar = dynamic_cast<TQTabBar*>(w); - if (tabBar) - { - manageTabBar(tabBar, item); - return; - } - - TQWidgetStack *wds = dynamic_cast<TQWidgetStack*>( w ); - if ( wds ) - { - QWidgetStackAccelManager::manage( wds ); - // return; - } - - TQPopupMenu *popupMenu = dynamic_cast<TQPopupMenu*>(w); - if (popupMenu) - { - // create a popup accel manager that can deal with dynamic menus - KPopupAccelManager::manage(popupMenu); - return; - } - - TQWidgetStack *wdst = dynamic_cast<TQWidgetStack*>( w ); - if ( wdst ) - { - QWidgetStackAccelManager::manage( wdst ); - // return; - } - - TQMenuBar *menuBar = dynamic_cast<TQMenuBar*>(w); - if (menuBar) - { - manageMenuBar(menuBar, item); - return; - } - - if (dynamic_cast<TQComboBox*>(w) || dynamic_cast<TQLineEdit*>(w) || - dynamic_cast<TQTextEdit*>(w) || dynamic_cast<TQTextView*>(w) || - dynamic_cast<TQSpinBox*>(w) || static_cast<KMultiTabBar*>(w->qt_cast("KMultiTabBar"))) - return; - - // now treat 'ordinary' widgets - TQLabel *label = dynamic_cast<TQLabel*>(w); - if ( label ) { - if ( !label->buddy() ) - label = 0; - else { - if ( label->textFormat() == Qt::RichText || - ( label->textFormat() == Qt::AutoText && - TQStyleSheet::mightBeRichText( label->text() ) ) ) - label = 0; - } - } - - if (w->isFocusEnabled() || label || dynamic_cast<TQGroupBox*>(w) || dynamic_cast<TQRadioButton*>( w )) - { - TQString content; - TQVariant variant; - int tprop = w->tqmetaObject()->findProperty("text", true); - if (tprop != -1) { - const TQMetaProperty* p = w->tqmetaObject()->property( tprop, true ); - if ( p && p->isValid() ) - w->qt_property( tprop, 1, &variant ); - else - tprop = -1; - } - - if (tprop == -1) { - tprop = w->tqmetaObject()->findProperty("title", true); - if (tprop != -1) { - const TQMetaProperty* p = w->tqmetaObject()->property( tprop, true ); - if ( p && p->isValid() ) - w->qt_property( tprop, 1, &variant ); - } - } - - if (variant.isValid()) - content = variant.toString(); - - if (!content.isEmpty()) - { - Item *i = new Item; - i->m_widget = w; - - // put some more weight on the usual action elements - int weight = KAccelManagerAlgorithm::DEFAULT_WEIGHT; - if (dynamic_cast<TQPushButton*>(w) || dynamic_cast<TQCheckBox*>(w) || dynamic_cast<TQRadioButton*>(w) || dynamic_cast<TQLabel*>(w)) - weight = KAccelManagerAlgorithm::ACTION_ELEMENT_WEIGHT; - - // don't put weight on group boxes, as usually the contents are more important - if (dynamic_cast<TQGroupBox*>(w)) - weight = KAccelManagerAlgorithm::GROUP_BOX_WEIGHT; - - // put a lot of extra weight on the KDialogBaseButton's - if (w->inherits("KDialogBaseButton")) - weight += KAccelManagerAlgorithm::DIALOG_BUTTON_EXTRA_WEIGHT; - - i->m_content = KAccelString(content, weight); - item->addChild(i); - } - } - traverseChildren(w, item); -} - -void KAcceleratorManagerPrivate::manageTabBar(TQTabBar *bar, Item *item) -{ - for (int i=0; i<bar->count(); i++) - { - TQString content = bar->tabAt(i)->text(); - if (content.isEmpty()) - continue; - - Item *it = new Item; - item->addChild(it); - it->m_widget = bar; - it->m_index = i; - it->m_content = KAccelString(content); - } -} - -void KAcceleratorManagerPrivate::manageMenuBar(TQMenuBar *mbar, Item *item) -{ - TQMenuItem *mitem; - TQString s; - - for (uint i=0; i<mbar->count(); ++i) - { - mitem = mbar->findItem(mbar->idAt(i)); - if (!mitem) - continue; - - // nothing to do for separators - if (mitem->isSeparator()) - continue; - - s = mitem->text(); - if (!s.isEmpty()) - { - Item *it = new Item; - item->addChild(it); - it->m_content = - KAccelString(s, - // menu titles are important, so raise the weight - KAccelManagerAlgorithm::MENU_TITLE_WEIGHT); - - it->m_widget = mbar; - it->m_index = i; - } - - // have a look at the popup as well, if present - if (mitem->popup()) - KPopupAccelManager::manage(mitem->popup()); - } -} - - -/********************************************************************* - - class KAcceleratorManager - main entry point - - This class is just here to provide a clean public API... - - *********************************************************************/ - -void KAcceleratorManager::manage(TQWidget *widget) -{ - KAcceleratorManager::manage(widget, false); -} - -void KAcceleratorManager::manage(TQWidget *widget, bool programmers_mode) -{ - kdDebug(131) << "KAcceleratorManager::manage\n"; - KAcceleratorManagerPrivate::changed_string = TQString::null; - KAcceleratorManagerPrivate::added_string = TQString::null; - KAcceleratorManagerPrivate::removed_string = TQString::null; - KAcceleratorManagerPrivate::programmers_mode = programmers_mode; - KAcceleratorManagerPrivate::manage(widget); -} - -void KAcceleratorManager::last_manage(TQString &added, TQString &changed, TQString &removed) -{ - added = KAcceleratorManagerPrivate::added_string; - changed = KAcceleratorManagerPrivate::changed_string; - removed = KAcceleratorManagerPrivate::removed_string; -} - - -/********************************************************************* - - class KAccelString - a string with weighted characters - - *********************************************************************/ - -KAccelString::KAccelString(const TQString &input, int initialWeight) - : m_pureText(input), m_weight() -{ - m_orig_accel = m_pureText.find("(!)&"); - if (m_orig_accel != -1) - m_pureText.remove(m_orig_accel, 4); - - m_orig_accel = m_pureText.find("(&&)"); - if (m_orig_accel != -1) - m_pureText.replace(m_orig_accel, 4, "&"); - - m_origText = m_pureText; - - if (m_pureText.contains('\t')) - m_pureText = m_pureText.left(m_pureText.find('\t')); - - m_orig_accel = m_accel = stripAccelerator(m_pureText); - - if (initialWeight == -1) - initialWeight = KAccelManagerAlgorithm::DEFAULT_WEIGHT; - - calculateWeights(initialWeight); - - // dump(); -} - - -TQString KAccelString::accelerated() const -{ - TQString result = m_origText; - if (result.isEmpty()) - return result; - - if (KAcceleratorManagerPrivate::programmers_mode) - { - if (m_accel != m_orig_accel) { - int oa = m_orig_accel; - - if (m_accel >= 0) { - result.insert(m_accel, "(!)&"); - if (m_accel < m_orig_accel) - oa += 4; - } - if (m_orig_accel >= 0) - result.replace(oa, 1, "(&&)"); - } - } else { - if (m_accel >= 0 && m_orig_accel != m_accel) { - result.remove(m_orig_accel, 1); - result.insert(m_accel, "&"); - } - } - return result; -} - - -TQChar KAccelString::accelerator() const -{ - if ((m_accel < 0) || (m_accel > (int)m_pureText.length())) - return TQChar(); - - return m_pureText[m_accel].lower(); -} - - -void KAccelString::calculateWeights(int initialWeight) -{ - m_weight.resize(m_pureText.length()); - - uint pos = 0; - bool start_character = true; - - while (pos<m_pureText.length()) - { - TQChar c = m_pureText[pos]; - - int weight = initialWeight+1; - - // add special weight to first character - if (pos == 0) - weight += KAccelManagerAlgorithm::FIRST_CHARACTER_EXTRA_WEIGHT; - - // add weight to word beginnings - if (start_character) - { - weight += KAccelManagerAlgorithm::WORD_BEGINNING_EXTRA_WEIGHT; - start_character = false; - } - - // add decreasing weight to left characters - if (pos < 50) - weight += (50-pos); - - // try to preserve the wanted accelarators - if ((int)pos == accel()) { - weight += KAccelManagerAlgorithm::WANTED_ACCEL_EXTRA_WEIGHT; - // kdDebug(131) << "wanted " << m_pureText << " " << KAcceleratorManagerPrivate::standardName(m_origText) << endl; - if (KAcceleratorManagerPrivate::standardName(m_origText)) { - weight += KAccelManagerAlgorithm::STANDARD_ACCEL; - } - } - - // skip non typeable characters - if (!c.isLetterOrNumber()) - { - weight = 0; - start_character = true; - } - - m_weight[pos] = weight; - - ++pos; - } -} - - -int KAccelString::stripAccelerator(TQString &text) -{ - // Note: this code is derived from TQAccel::shortcutKey - int p = 0; - - while (p >= 0) - { - p = text.find('&', p)+1; - - if (p <= 0 || p >= (int)text.length()) - return -1; - - if (text[p] != '&') - { - TQChar c = text[p]; - if (c.isPrint()) - { - text.remove(p-1,1); - return p-1; - } - } - - p++; - } - - return -1; -} - - -int KAccelString::maxWeight(int &index, const TQString &used) -{ - int max = 0; - index = -1; - - for (uint pos=0; pos<m_pureText.length(); ++pos) - if (used.find(m_pureText[pos], 0, FALSE) == -1 && m_pureText[pos].latin1() != 0) - if (m_weight[pos] > max) - { - max = m_weight[pos]; - index = pos; - } - - return max; -} - - -void KAccelString::dump() -{ - TQString s; - for (uint i=0; i<m_weight.count(); ++i) - s += TQString("%1(%2) ").arg(pure()[i]).arg(m_weight[i]); - kdDebug() << "s " << s << endl; -} - - -/********************************************************************* - - findAccelerators - the algorithm determining the new accelerators - - The algorithm is very crude: - - * each character in each widget text is assigned a weight - * the character with the highest weight over all is picked - * that widget is removed from the list - * the weights are recalculated - * the process is repeated until no more accelerators can be found - - The algorithm has some advantages: - - * it favors 'nice' accelerators (first characters in a word, etc.) - * it is quite fast, O(N�) - * it is easy to understand :-) - - The disadvantages: - - * it does not try to find as many accelerators as possible - - TODO: - - * The result is always correct, but not neccesarily optimal. Perhaps - it would be a good idea to add another algorithm with higher complexity - that gets used when this one fails, i.e. leaves widgets without - accelerators. - - * The weights probably need some tweaking so they make more sense. - - *********************************************************************/ - -void KAccelManagerAlgorithm::findAccelerators(KAccelStringList &result, TQString &used) -{ - kdDebug(131) << "findAccelerators\n"; - KAccelStringList accel_strings = result; - - // initally remove all accelerators - for (KAccelStringList::Iterator it = result.begin(); it != result.end(); ++it) { - (*it).setAccel(-1); - } - - // pick the highest bids - for (uint cnt=0; cnt<accel_strings.count(); ++cnt) - { - int max = 0, index = -1, accel = -1; - - // find maximum weight - for (uint i=0; i<accel_strings.count(); ++i) - { - int a; - int m = accel_strings[i].maxWeight(a, used); - if (m>max) - { - max = m; - index = i; - accel = a; - } - } - - // stop if no more accelerators can be found - if (index < 0) - return; - - // insert the accelerator - if (accel >= 0) - { - result[index].setAccel(accel); - used.append(result[index].accelerator()); - } - - // make sure we don't visit this one again - accel_strings[index] = KAccelString(); - } -} - - -/********************************************************************* - - class KPopupAccelManager - managing TQPopupMenu widgets dynamically - - *********************************************************************/ - -KPopupAccelManager::KPopupAccelManager(TQPopupMenu *popup) - : TQObject(popup), m_popup(popup), m_count(-1) -{ - aboutToShow(); // do one check and then connect to show - connect(popup, TQT_SIGNAL(aboutToShow()), TQT_SLOT(aboutToShow())); -} - - -void KPopupAccelManager::aboutToShow() -{ - // Note: we try to be smart and avoid recalculating the accelerators - // whenever possible. Unfortunately, there is no way to know if an - // item has been added or removed, so we can not do much more than - // to compare the items each time the menu is shown :-( - - if (m_count != (int)m_popup->count()) - { - findMenuEntries(m_entries); - calculateAccelerators(); - m_count = m_popup->count(); - } - else - { - KAccelStringList entries; - findMenuEntries(entries); - if (entries != m_entries) - { - m_entries = entries; - calculateAccelerators(); - } - } -} - - -void KPopupAccelManager::calculateAccelerators() -{ - // find the new accelerators - TQString used; - KAccelManagerAlgorithm::findAccelerators(m_entries, used); - - // change the menu entries - setMenuEntries(m_entries); -} - - -void KPopupAccelManager::findMenuEntries(KAccelStringList &list) -{ - TQMenuItem *mitem; - TQString s; - - list.clear(); - - // read out the menu entries - for (uint i=0; i<m_popup->count(); i++) - { - mitem = m_popup->findItem(m_popup->idAt(i)); - if (mitem->isSeparator()) - continue; - - s = mitem->text(); - - // in full menus, look at entries with global accelerators last - int weight = 50; - if (s.contains('\t')) - weight = 0; - - list.append(KAccelString(s, weight)); - - // have a look at the popup as well, if present - if (mitem->popup()) - KPopupAccelManager::manage(mitem->popup()); - } -} - - -void KPopupAccelManager::setMenuEntries(const KAccelStringList &list) -{ - TQMenuItem *mitem; - - uint cnt = 0; - for (uint i=0; i<m_popup->count(); i++) - { - mitem = m_popup->findItem(m_popup->idAt(i)); - if (mitem->isSeparator()) - continue; - - if (KAcceleratorManagerPrivate::checkChange(list[cnt])) - mitem->setText(list[cnt].accelerated()); - cnt++; - } -} - - -void KPopupAccelManager::manage(TQPopupMenu *popup) -{ - // don't add more than one manager to a popup - if (popup->child(0, "KPopupAccelManager", false) == 0 ) - new KPopupAccelManager(popup); -} - -void QWidgetStackAccelManager::manage( TQWidgetStack *stack ) -{ - if ( stack->child( 0, "QWidgetStackAccelManager", false ) == 0 ) - new QWidgetStackAccelManager( stack ); -} - -QWidgetStackAccelManager::QWidgetStackAccelManager(TQWidgetStack *stack) - : TQObject(stack), m_stack(stack) -{ - aboutToShow(stack->visibleWidget()); // do one check and then connect to show - connect(stack, TQT_SIGNAL(aboutToShow(TQWidget *)), TQT_SLOT(aboutToShow(TQWidget *))); -} - -bool QWidgetStackAccelManager::eventFilter ( TQObject * watched, TQEvent * e ) -{ - if ( e->type() == TQEvent::Show && tqApp->activeWindow() ) { - KAcceleratorManager::manage( TQT_TQWIDGET(tqApp->activeWindow()) ); - watched->removeEventFilter( this ); - } - return false; -} - -void QWidgetStackAccelManager::aboutToShow(TQWidget *child) -{ - if (!child) - { - kdDebug(131) << "null pointer given to aboutToShow" << endl; - return; - } - - child->installEventFilter( this ); -} - -void KAcceleratorManager::setNoAccel( TQWidget *widget ) -{ - KAcceleratorManagerPrivate::ignored_widgets[widget] = 1; -} - -#include "kaccelmanager_private.moc" |