workspace/khotkeys/libkhotkeysprivate/action_data/action_data_group.h

   1 /****************************************************************************
   2
   3  KHotKeys
   4
   5  Copyright (C) 1999-2001 Lubos Lunak <l.lunak@kde.org>
   6
   7  Distributed under the terms of the GNU General Public License version 2.
   8
   9 ****************************************************************************/
  10
  11 #ifndef ACTION_DATA_GROUP_H
  12 #define ACTION_DATA_GROUP_H
  13
  14 #include "action_data_base.h"
  15 #include "actions/actions.h"
  16 #include "triggers/triggers.h"
  17
  18 #include "QtCore/QList"
  19
  20 #include "kdemacros.h"
  21
  22
  23 class KHotkeysModel;
  24
  25 namespace KHotKeys {
  26
  27
  28 /**
  29  * A group of \c ActionDataBase objects
  30  *
  31  * # The group can contain actions or action groups.
  32  * # The group has its own list of conditions. These conditions apply to all children.
  33  */
  34 class KDE_EXPORT ActionDataGroup
  35     : public ActionDataBase
  36     {
  37     public:
  38
  39         enum system_group_t {
  40             SYSTEM_NONE,             //!< TODO
  41             SYSTEM_MENUENTRIES,      //!< Shortcuts for menu entries.
  42             SYSTEM_ROOT,             //!< TODO
  43             /* last one*/ SYSTEM_MAX //!< End of enum marker
  44             }; // don't remove entries
  45
  46         /**
  47          * Create a \c ActionDataGroup object.
  48          *
  49          * \param parent_P  A ActionDataGroup or 0. If provided this action is
  50          *        registered with the group.
  51          * \param name_P    Name for the object.
  52          * \param comment_P Comment for the object.
  53          * \param condition_P Conditions for the object or 0
  54          * \param system_group_t Group type
  55          * \param enabled_P Is the action enabled?
  56          */
  57         ActionDataGroup(
  58             ActionDataGroup* parent_P,
  59             const QString& name_P,
  60             const QString& comment_P,
  61             Condition_list* conditions_P = NULL,
  62             system_group_t system_group_P = SYSTEM_NONE,
  63             bool enabled_P = false );
  64
  65         ActionDataGroup( KConfigGroup& cfg_P, ActionDataGroup* parent_P );
  66         virtual ~ActionDataGroup();
  67         virtual void update_triggers();
  68         virtual void cfg_write( KConfigGroup& cfg_P ) const;
  69
  70         /**
  71          * What kind of actions are allowed for this group?
  72          */
  73         Action::ActionTypes allowedActionTypes() const;
  74
  75         /**
  76          * What kind of trigger are allowed for this group?
  77          */
  78         Trigger::TriggerTypes allowedTriggerTypes() const;
  79
  80         /**
  81          * Get a shallow copy of the list of children.
  82          */
  83         const QList<ActionDataBase*> children() const;
  84
  85         /**
  86          * Number of childrens.
  87          */
  88         int size() const;
  89
  90         /**
  91          * @reimp
  92          */
  93         void aboutToBeErased();
  94
  95         /**
  96          * Is this a system group?
  97          *
  98          * @{
  99          */
 100         bool is_system_group() const;
 101         system_group_t system_group() const;
 102         //@}
 103
 104         // CHECKME : Why this?
 105         using ActionDataBase::set_conditions; // make public
 106
 107     protected:
 108
 109         friend class ActionDataBase;
 110
 111         //! Add a child to this collection
 112         void add_child( ActionDataBase* child_P );
 113
 114         //! Remove a child from this collection
 115         void remove_child( ActionDataBase* child_P );
 116
 117         //! The children
 118         QList< ActionDataBase* > _list;
 119
 120         //! System group type
 121         system_group_t _system_group; // e.g. menuedit entries, can't be deleted or renamed
 122
 123     };
 124
 125
 126
 127 } // namespace KHotKeys
 128
 129 #endif