libkdepim/ksubscription.h

   1 /*
   2   This file is part of libkdepim.
   3
   4   Copyright (C) 2002 Carsten Burghardt <burghardt@kde.org>
   5
   6   This library is free software; you can redistribute it and/or
   7   modify it under the terms of the GNU Library General Public
   8   License version 2 as published by the Free Software Foundation.
   9
  10   This library is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13   Library General Public License for more details.
  14
  15   You should have received a copy of the GNU Library General Public License
  16   along with this library; see the file COPYING.LIB.  If not, write to
  17   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18   Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22   @file
  23   This file defines a generic subscription widget and some support classes.
  24 */
  25
  26 #ifndef KDEPIM_KSUBSCRIPTION_H
  27 #define KDEPIM_KSUBSCRIPTION_H
  28
  29 #include "kdepim_export.h"
  30
  31 #include <KDialog>
  32
  33 #include <QCheckBox>
  34 #include <QTreeWidget>
  35
  36 class KLineEdit;
  37 class QGridLayout;
  38 class QLabel;
  39 class QTreeWidget;
  40
  41 namespace KPIM {
  42
  43 class KAccount;
  44 class KSubscription;
  45
  46 //==========================================================================
  47
  48 class KDEPIM_EXPORT KGroupInfo
  49 {
  50   public:
  51     enum Status {
  52       unknown,
  53       readOnly,
  54       postingAllowed,
  55       moderated
  56     };
  57
  58     explicit KGroupInfo( const QString &name,
  59                          const QString &description = QString(),
  60                          bool newGroup = false, bool subscribed = false,
  61                          Status status = unknown,
  62                          const QString &path = QString() );
  63
  64     QString name, description;
  65     bool newGroup, subscribed;
  66     Status status;
  67     QString path;
  68
  69     bool operator== ( const KGroupInfo &gi2 );
  70     bool operator< ( const KGroupInfo &gi2 );
  71
  72 };
  73
  74 //==========================================================================
  75
  76 /** A class representing a single group item (what's that?) */
  77 class KDEPIM_EXPORT GroupItem : public QObject, public QTreeWidgetItem
  78 {
  79   Q_OBJECT
  80
  81   public:
  82     GroupItem( QTreeWidget *v, const KGroupInfo &gi, KSubscription *browser,
  83                bool isCheckItem = false );
  84     GroupItem( QTreeWidgetItem *i, const KGroupInfo &gi, KSubscription *browser,
  85                bool isCheckItem = false );
  86
  87     /**
  88      * Get/Set the KGroupInfo
  89      */
  90     KGroupInfo info() { return mInfo; }
  91     void setInfo( KGroupInfo info );
  92
  93     /**
  94      * Get/Set the original parent
  95      */
  96     QTreeWidgetItem *originalParent() { return mOriginalParent; }
  97     void setOriginalParent( QTreeWidgetItem *parent ) { mOriginalParent = parent; }
  98
  99     /**
 100      * Get/Set the last open state
 101      */
 102     bool lastOpenState() { return mLastOpenState; }
 103     void setLastOpenState( bool last ) { mLastOpenState = last; }
 104
 105     /**
 106      * Sets the description from the KGroupInfo
 107      * Reimplement this for special cases
 108      */
 109     virtual void setDescription();
 110
 111     /**
 112      * Get if this is a checkable item
 113      */
 114     bool isCheckItem() const { return mIsCheckItem; }
 115
 116     /**
 117      * Get/Set if state changes should be ignored
 118      */
 119     bool ignoreStateChange() { return mIgnoreStateChange; }
 120     void setIgnoreStateChange( bool ignore ) { mIgnoreStateChange = ignore; }
 121
 122     /**
 123      * Sets the subscribed property (only while items are loaded)
 124      */
 125     void setOn( bool on );
 126     bool isOn() const;
 127
 128     /**
 129      * Reimplemented
 130      * Sets items invisible or disabled or even moves them
 131      */
 132     void setVisible( bool b );
 133
 134   protected Q_SLOTS:
 135
 136      /**
 137      * Calls KSubscription::changeItemState if mIgnoreStateChange == false
 138      */
 139     void stateChange( QTreeWidgetItem* item );
 140
 141   protected:
 142
 143     static const int customType = 15689;
 144     KGroupInfo mInfo;
 145     KSubscription *mBrowser;
 146     QTreeWidgetItem *mOriginalParent;
 147     // remember last open state
 148     bool mLastOpenState;
 149     bool mLastCheckState;
 150     // is this a checkable item
 151     bool mIsCheckItem;
 152     // ignore state changes
 153     bool mIgnoreStateChange;
 154 };
 155
 156 //==========================================================================
 157
 158 /**
 159  * This class provides a generic subscription widget
 160  * The dialog itself has a main listview that holds all items and two listviews that
 161  * show all changes. The user can change the state of the items via checkable items.
 162  * When you construct a new instance you need to provide an account and a caption
 163  * After inserting your items (checkable or not) you need to call slotLoadingComplete()
 164  * You should at least connect slots to the signals okClicked() (to save your changes)
 165  * and user1Clicked() (to reload the list)
 166  * You can hide unwanted checkboxes via the respective hide<checkboxname> methods
 167  *
 168  */
 169 class KDEPIM_EXPORT KSubscription : public KDialog
 170 {
 171   Q_OBJECT
 172
 173   public:
 174     /**
 175      * The direction of the buttons
 176      */
 177     enum Direction {
 178       Left,
 179       Right
 180     };
 181
 182     KSubscription( QWidget *parent, const QString &caption, KAccount *acct,
 183                    KDialog::ButtonCodes buttons = 0,
 184                    const QString &user1 = QString(),
 185                    bool descriptionColumn = true );
 186
 187     ~KSubscription();
 188
 189     /**
 190      * Get/Set the account
 191      */
 192     KAccount *account() { return mAcct; }
 193     void setAccount( KAccount *acct ) { mAcct = acct; }
 194
 195     /**
 196      * Access to the treewidget that holds the GroupItems
 197      */
 198     QTreeWidget *folderTree() { return groupView; }
 199
 200     /**
 201      * Access to the searchfield
 202      */
 203     KLineEdit *searchField() { return filterEdit; }
 204
 205     /**
 206      * The item that should be selected on startup
 207      */
 208     void setStartItem( const KGroupInfo &info );
 209
 210     /**
 211      * Removes the item from the listview
 212      */
 213     void removeListItem( QTreeWidget *view, const KGroupInfo &gi );
 214
 215     /**
 216      * Gets the item from the listview
 217      * Returns 0 if the item can't be found
 218      */
 219     QTreeWidgetItem *getListItem( QTreeWidget *view, const KGroupInfo &gi );
 220
 221     /**
 222      * Is the item in the given listview
 223      */
 224     bool itemInListView( QTreeWidget *view, const KGroupInfo &gi );
 225
 226     /**
 227      * Makes all changes after an item is toggled
 228      * called by the item's stateChange-method
 229      */
 230     void changeItemState( GroupItem *item, bool on );
 231
 232     /**
 233      * Get/Set the direction of button1
 234      */
 235     Direction directionButton1() { return mDirButton1; }
 236     void setDirectionButton1( Direction dir );
 237
 238     /**
 239      * Get/Set the direction of button2
 240      */
 241     Direction directionButton2() { return mDirButton2; }
 242     void setDirectionButton2( Direction dir );
 243
 244     /**
 245      * Returns true if items are being constructed
 246      * Call 'slotLoadingComplete' to switch this
 247      */
 248     bool isLoading() { return mLoading; }
 249
 250     /**
 251      * Hide 'Disable tree view' checkbox
 252      */
 253     void hideTreeCheckbox() { noTreeCB->hide(); }
 254
 255     /**
 256      * Hide 'New Only' checkbox
 257      */
 258     void hideNewOnlyCheckbox() { newCB->hide(); }
 259
 260     /**
 261      * Update the item-states (visible, enabled) when a filter
 262      * criteria changed
 263      */
 264     void filterChanged( QTreeWidgetItem *item = 0,
 265                         const QString &text = QString() );
 266
 267     /**
 268      * The amount of items that are visible and enabled
 269      */
 270     int activeItemCount();
 271
 272     /**
 273      * Moves all items from toplevel back to their original position
 274      */
 275     void restoreOriginalParent();
 276
 277     /**
 278      * Saves the open states
 279      */
 280     void saveOpenStates();
 281
 282     /**
 283      * Restores the saved open state
 284      */
 285     void restoreOpenStates();
 286
 287   public Q_SLOTS:
 288     /**
 289      * Call this slot when you have created all items
 290      */
 291     void slotLoadingComplete();
 292
 293     /**
 294      * Changes the current state of the buttons
 295      */
 296     void slotChangeButtonState( QTreeWidgetItem * );
 297
 298     /**
 299      * Buttons are clicked
 300      */
 301     void slotButton1();
 302     void slotButton2();
 303
 304     /**
 305      * Updates the status-label
 306      */
 307     void slotUpdateStatusLabel();
 308
 309     /**
 310      * The reload-button is pressed
 311      */
 312     void slotLoadFolders();
 313
 314   protected Q_SLOTS:
 315     /**
 316      * Slot for the checkboxes
 317      */
 318     void slotCBToggled();
 319
 320     /**
 321      * Filter text changed
 322      */
 323     void slotFilterTextChanged( const QString &text );
 324
 325   Q_SIGNALS:
 326     /**
 327      * Emitted when the amount of items in the
 328      * groupView changes (e.g. on filtering)
 329      */
 330     void listChanged();
 331
 332   protected:
 333     // current account
 334     KAccount *mAcct;
 335
 336     // widgets
 337     QWidget *page;
 338     QTreeWidget *groupView;
 339     QTreeWidget *subView, *unsubView;
 340     KLineEdit *filterEdit;
 341     QCheckBox *noTreeCB, *subCB, *newCB;
 342     QPushButton  *arrowBtn1, *arrowBtn2;
 343     QIcon pmRight, pmLeft;
 344     QGridLayout *listL;
 345     QLabel *leftLabel, *rightLabel;
 346
 347     // false if all items are loaded
 348     bool mLoading;
 349
 350     // directions
 351     Direction mDirButton1;
 352     Direction mDirButton2;
 353
 354     // remember last searchtext
 355     QString mLastText;
 356 };
 357
 358 }
 359
 360 #endif