standardactionmanager.h

/*
    Copyright (c) 2008 Volker Krause <vkrause@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.
*/

#ifndef AKONADI_STANDARDACTIONMANAGER_H
#define AKONADI_STANDARDACTIONMANAGER_H

#include "akonadi_export.h"

#include <QtCore/QObject>

#include <akonadi/collection.h>
#include <akonadi/item.h>

class KAction;
class KActionCollection;
class KLocalizedString;
class QItemSelectionModel;
class QWidget;
class QMenu;

namespace Akonadi {

class FavoriteCollectionsModel;

class AKONADI_EXPORT StandardActionManager : public QObject
{
  Q_OBJECT
  public:
    enum Type {
      CreateCollection,          
      CopyCollections,           
      DeleteCollections,         
      SynchronizeCollections,    
      CollectionProperties,      
      CopyItems,                 
      Paste,                     
      DeleteItems,               
      ManageLocalSubscriptions,  
      AddToFavoriteCollections,  
      RemoveFromFavoriteCollections,  
      RenameFavoriteCollection,  
      CopyCollectionToMenu,      
      CopyItemToMenu,            
      MoveItemToMenu,            
      MoveCollectionToMenu,      
      CutItems,                  
      CutCollections,            
      CreateResource,            
      DeleteResources,           
      ResourceProperties,        
      SynchronizeResources,      
      ToggleWorkOffline,         
      CopyCollectionToDialog,    
      MoveCollectionToDialog,    
      CopyItemToDialog,          
      MoveItemToDialog,          
      SynchronizeCollectionsRecursive,    
      MoveCollectionsToTrash,    
      MoveItemsToTrash,          
      RestoreCollectionsFromTrash,
      RestoreItemsFromTrash,     
      MoveToTrashRestoreCollection,  
      MoveToTrashRestoreCollectionAlternative,   
      MoveToTrashRestoreItem,    
      MoveToTrashRestoreItemAlternative,   
      SynchronizeFavoriteCollections,   
      LastType                   
    };

    enum TextContext {
      DialogTitle,                
      DialogText,                 
      MessageBoxTitle,            
      MessageBoxText,             
      MessageBoxAlternativeText,  
      ErrorMessageTitle,          
      ErrorMessageText            
    };

    explicit StandardActionManager( KActionCollection *actionCollection, QWidget *parent = 0 );

    ~StandardActionManager();

    void setCollectionSelectionModel( QItemSelectionModel *selectionModel );

    void setItemSelectionModel( QItemSelectionModel* selectionModel );

    void setFavoriteCollectionsModel( FavoriteCollectionsModel *favoritesModel );

    void setFavoriteSelectionModel( QItemSelectionModel *selectionModel );

    KAction* createAction( Type type );

    void createAllActions();

    KAction* action( Type type ) const;

    void setActionText( Type type, const KLocalizedString &text );

    void interceptAction( Type type, bool intercept = true );

    Akonadi::Collection::List selectedCollections() const;

    Akonadi::Item::List selectedItems() const;

    void setContextText( Type type, TextContext context, const QString &text );

    void setContextText( Type type, TextContext context, const KLocalizedString &text );

    void setMimeTypeFilter( const QStringList &mimeTypes );

    void setCapabilityFilter( const QStringList &capabilities );

    void setCollectionPropertiesPageNames( const QStringList &names );

    void createActionFolderMenu(QMenu *menu, Type type);

  Q_SIGNALS:
    void actionStateUpdated();

  private:
    //@cond PRIVATE
    class Private;
    Private* const d;

    Q_PRIVATE_SLOT( d, void updateActions() )
#ifndef QT_NO_CLIPBOARD
    Q_PRIVATE_SLOT( d, void clipboardChanged(QClipboard::Mode) )
#endif
    Q_PRIVATE_SLOT( d, void collectionSelectionChanged() )
    Q_PRIVATE_SLOT( d, void favoriteSelectionChanged() )

    Q_PRIVATE_SLOT( d, void slotCreateCollection() )
    Q_PRIVATE_SLOT( d, void slotCopyCollections() )
    Q_PRIVATE_SLOT( d, void slotCutCollections() )
    Q_PRIVATE_SLOT( d, void slotDeleteCollection() )
    Q_PRIVATE_SLOT( d, void slotMoveCollectionToTrash() )
    Q_PRIVATE_SLOT( d, void slotMoveItemToTrash() )
    Q_PRIVATE_SLOT( d, void slotRestoreCollectionFromTrash() )
    Q_PRIVATE_SLOT( d, void slotRestoreItemFromTrash() )
    Q_PRIVATE_SLOT( d, void slotTrashRestoreCollection() )
    Q_PRIVATE_SLOT( d, void slotTrashRestoreItem() )
    Q_PRIVATE_SLOT( d, void slotSynchronizeCollection() )
    Q_PRIVATE_SLOT( d, void slotSynchronizeCollectionRecursive() )
    Q_PRIVATE_SLOT( d, void slotSynchronizeFavoriteCollections() )
    Q_PRIVATE_SLOT( d, void slotCollectionProperties() )
    Q_PRIVATE_SLOT( d, void slotCopyItems() )
    Q_PRIVATE_SLOT( d, void slotCutItems() )
    Q_PRIVATE_SLOT( d, void slotPaste() )
    Q_PRIVATE_SLOT( d, void slotDeleteItems() )
    Q_PRIVATE_SLOT( d, void slotDeleteItemsDeferred(const Akonadi::Item::List &) )
    Q_PRIVATE_SLOT( d, void slotLocalSubscription() )
    Q_PRIVATE_SLOT( d, void slotAddToFavorites() )
    Q_PRIVATE_SLOT( d, void slotRemoveFromFavorites() )
    Q_PRIVATE_SLOT( d, void slotRenameFavorite() )
    Q_PRIVATE_SLOT( d, void slotCopyCollectionTo() )
    Q_PRIVATE_SLOT( d, void slotMoveCollectionTo() )
    Q_PRIVATE_SLOT( d, void slotCopyItemTo() )
    Q_PRIVATE_SLOT( d, void slotMoveItemTo() )
    Q_PRIVATE_SLOT( d, void slotCopyCollectionTo(QAction*) )
    Q_PRIVATE_SLOT( d, void slotMoveCollectionTo(QAction*) )
    Q_PRIVATE_SLOT( d, void slotCopyItemTo(QAction*) )
    Q_PRIVATE_SLOT( d, void slotMoveItemTo(QAction*) )
    Q_PRIVATE_SLOT( d, void slotCreateResource() )
    Q_PRIVATE_SLOT( d, void slotDeleteResource() )
    Q_PRIVATE_SLOT( d, void slotResourceProperties() )
    Q_PRIVATE_SLOT( d, void slotSynchronizeResource() )
    Q_PRIVATE_SLOT( d, void slotToggleWorkOffline(bool) )

    Q_PRIVATE_SLOT( d, void collectionCreationResult(KJob*) )
    Q_PRIVATE_SLOT( d, void collectionDeletionResult(KJob*) )
    Q_PRIVATE_SLOT( d, void moveCollectionToTrashResult(KJob*) )
    Q_PRIVATE_SLOT( d, void moveItemToTrashResult(KJob*) )
    Q_PRIVATE_SLOT( d, void itemDeletionResult(KJob*) )
    Q_PRIVATE_SLOT( d, void resourceCreationResult(KJob*) )
    Q_PRIVATE_SLOT( d, void pasteResult(KJob*) )

    Q_PRIVATE_SLOT( d, void enableAction(int, bool) )
    Q_PRIVATE_SLOT( d, void updatePluralLabel(int, int) )
    Q_PRIVATE_SLOT( d, void updateAlternatingAction(int) )
    Q_PRIVATE_SLOT( d, bool isFavoriteCollection(const Akonadi::Collection&) )

    Q_PRIVATE_SLOT( d, void aboutToShowMenu() )
    //@endcond
};

}

#endif