berryContributionManager.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
 
#ifndef BERRYCONTRIBUTIONMANAGER_H
#define BERRYCONTRIBUTIONMANAGER_H
 
#include "berryIContributionManager.h"
 
namespace berry {
 
struct IContributionManagerOverrides;
 
class ContributionManager : public virtual IContributionManager
{
 
protected:
 
  // Internal debug flag.
  // static final boolean DEBUG = false;
 
public:
 
  berryObjectMacro(berry::ContributionManager);
 
  ~ContributionManager() override;
 
  /*
   * Method declared on IContributionManager.
   */
  void Add(QAction* action, const QString& id) override;
 
  /*
   * Method declared on IContributionManager.
   */
  void Add(const SmartPointer<IContributionItem>& item) override;
 
  /*
   * Method declared on IContributionManager.
   */
  void AppendToGroup(const QString& groupName, QAction* action, const QString& id) override;
 
  /*
   * Method declared on IContributionManager.
   */
  void AppendToGroup(const QString& groupName, const SmartPointer<IContributionItem>& item) override;
 
  /*
   * Method declared on IContributionManager.
   */
  SmartPointer<IContributionItem> Find(const QString& id) const override;
 
  /*
   * Method declared on IContributionManager.
   */
  QList<SmartPointer<IContributionItem> > GetItems() const override;
 
  int GetSize();
 
  SmartPointer<IContributionManagerOverrides> GetOverrides() override;
 
  int IndexOf(const QString& id);
 
  void Insert(int index, const SmartPointer<IContributionItem>& item);
 
  /*
   * (non-Javadoc) Method declared on IContributionManager.
   */
  //void InsertAfter(const QString& ID, Action* action);
 
  /*
   * (non-Javadoc) Method declared on IContributionManager.
   */
  void InsertAfter(const QString& ID, const SmartPointer<IContributionItem>& item) override;
 
  /*
   * (non-Javadoc) Method declared on IContributionManager.
   */
  //void InsertBefore(const QString& ID, Action* action);
 
  /*
   * Method declared on IContributionManager.
   */
  void InsertBefore(const QString& ID, const SmartPointer<IContributionItem>& item) override;
 
  /*
   * Method declared on IContributionManager.
   */
  bool IsDirty() const override;
 
  /*
   * Method declared on IContributionManager.
   */
  bool IsEmpty() const override;
 
  /*
   * Method declared on IContributionManager.
   */
  void MarkDirty() override;
 
  /*
   * Method declared on IContributionManager.
   */
  //void PrependToGroup(const QString& groupName, Action* action);
 
  /*
   * Method declared on IContributionManager.
   */
  void PrependToGroup(const QString& groupName, const SmartPointer<IContributionItem>& item) override;
 
  /*
   * Method declared on IContributionManager.
   */
  SmartPointer<IContributionItem> Remove(const QString& ID) override;
 
  /*
   * Method declared on IContributionManager.
   */
  SmartPointer<IContributionItem> Remove(const SmartPointer<IContributionItem> &item) override;
 
  /*
   * (non-Javadoc) Method declared on IContributionManager.
   */
  void RemoveAll() override;
 
  bool ReplaceItem(const QString &identifier,
                   const SmartPointer<IContributionItem>& replacementItem);
 
  void SetOverrides(const SmartPointer<IContributionManagerOverrides>& newOverrides);
 
protected:
 
  ContributionManager();
 
  virtual bool AllowItem(IContributionItem* itemToAdd);
 
  void DumpStatistics();
 
  bool HasDynamicItems() const;
 
  int IndexOf(const SmartPointer<IContributionItem>& item) const;
 
  void ItemAdded(const SmartPointer<IContributionItem>& item);
 
  void ItemRemoved(const SmartPointer<IContributionItem>& item);
 
  void SetDirty(bool dirty);
 
  void InternalSetItems(const QList<SmartPointer<IContributionItem> >& items);
 
private:
 
  QList<SmartPointer<IContributionItem> > contributions;
 
  bool isDirty;
 
  int dynamicItems;
 
  SmartPointer<IContributionManagerOverrides> overrides;
 
  void AddToGroup(const QString& groupName, const SmartPointer<IContributionItem>& item,
                  bool append);
 
};
 
}
 
#endif // BERRYCONTRIBUTIONMANAGER_H