Source: kcheckaccelerators.h

# Source: kcheckaccelerators.h |
Annotated List
Files
Globals
Hierarchy
Index

    /* This file is part of the KDE libraries
        Copyright (C) 1997 Matthias Kalle Dalheimer (kalle@kde.org)
        Copyright (C) 1998, 1999, 2000 KDE Team

        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., 59 Temple Place - Suite 330,
        Boston, MA 02111-1307, USA.
            */

    // $Id: kcheckaccelerators.h,v 1.3 2002/10/02 17:27:46 tjansen Exp $

    #ifndef KCHECKACCELERATORS_H_
    #define KCHECKACCELERATORS_H_

    #include
    #include
    #include
    #include
    #include

    class QMenuData;

    /**
     @internal
     This class allows translators (and application developers) to check for accelerator
     conflicts in menu and widgets. Put the following in your kdeglobals (or the config
     file for the application you're testing):

     [Development]
     CheckAccelerators=F12
     AutoCheckAccelerators=false
     AlwaysShowCheckAccelerators=false

     The checking can be either manual or automatic. To perform manual check, press
     the keyboard shortcut set to 'CheckAccelerators' (here F12). If automatic checking
     is enabled by setting 'AutoCheckAccelerators' to true, check will be performed every
     time the GUI changes. It's possible that in certain cases the check will be
     done also when no visible changes in the GUI happen or the check won't be done
     even if the GUI changed (in the latter case, use manual check ). Automatic
     checks can be anytime disabled by the checkbox in the dialog presenting
     the results of the check. If you set 'AlwaysShowCheckAccelerators' to true,
     the dialog will be shown even if the automatic check didn't find any conflicts,
     and all submenus will be shown, even those without conflicts.

     The dialog first lists the name of the window, then all results for all menus
     (if the window has a menubar) and then result for all controls in the active
     window (if there are any checkboxes etc.). For every submenu and all controls
     there are shown all conflicts grouped by accelerator, and a list of all used
     accelerators.
    */
    class KCheckAccelerators : public QObject
    {
        Q_OBJECT
        public:
        /**
         * Creates a KCheckAccelerators instance for the given object.
         * @param parent the parent to check
         */
            KCheckAccelerators( QObject* parent );
        /**
         * Re-implemented to filter the parent's events.
         */
            bool eventFilter( QObject * , QEvent * e);
        private:
            void checkAccelerators( bool automatic );
            struct AccelInfo {
                QString item;
    	    QString string;
            };
            typedef QValueList AccelInfoList;
            typedef QMap AccelMap;
            void findAccel( const QString& item, const QString &txt, AccelMap &accels );
            void checkMenuData( const QString& prefix, QMenuData* m );
            void checkMenuData( QMenuData* m );
            QKeySequence key;
            bool alwaysShow;
            bool autoCheck;
            bool block;
            QMap menuAccels;
            QTimer autoCheckTimer;
        private slots:
            void autoCheckSlot();
    };

    #endif

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:15 2003, using kdoc 2.0a54.