berryWorkbenchPart.h

Go to the documentation of this file.

/*===================================================================

BlueBerry Platform

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

===================================================================*/

#ifndef __BERRY_WORKBENCH_PART_H__
#define __BERRY_WORKBENCH_PART_H__

#include "berryIWorkbenchPart.h"
#include "berryIWorkbenchPartSite.h"

#include <berryIConfigurationElement.h>
#include <berryIExecutableExtension.h>

#include <QIcon>

namespace berry {


class BERRY_UI_QT WorkbenchPart : public QObject,
    public virtual IWorkbenchPart, public IExecutableExtension
{
  Q_OBJECT
  Q_INTERFACES(berry::IExecutableExtension);

public:
  berryObjectMacro(WorkbenchPart, QObject, IWorkbenchPart, IExecutableExtension)

  ~WorkbenchPart();

private:
  QString m_Title;
  QIcon m_TitleImage;
  QString m_ToolTip;

  IConfigurationElement::Pointer m_ConfigElement;
  IWorkbenchPartSite::Pointer m_PartSite;
  QString m_PartName;
  QString m_ContentDescription;

  QHash<QString, QString> partProperties;
  IPropertyChangeListener::Events partChangeEvents;

  void InternalSetContentDescription(const QString& description);
  void InternalSetPartName(const QString& partName);

protected:
  WorkbenchPart();

  IConfigurationElement::Pointer GetConfigurationElement() const
  {
    return m_ConfigElement;
  }

//  protected Image getDefaultImage() {
//    return PlatformUI.getWorkbench().getSharedImages().getImage(
//                ISharedImages.IMG_DEF_VIEW);
//  }

  void SetSite(IWorkbenchPartSite::Pointer site);

  virtual void CheckSite(IWorkbenchPartSite::Pointer site);

  virtual void SetTitleImage(const QIcon& titleImage);

  virtual void SetTitleToolTip(const QString& toolTip);

  virtual void SetPartName(const QString& partName);

  virtual void SetContentDescription(const QString& description);

  void FirePropertyChanged(const QString& key,
      const QString& oldValue, const QString& newValue);

  void FirePropertyChange(int propertyId);

public:

  /* (non-Javadoc)
   * Method declared on IWorkbenchPart.
   */
  void AddPropertyListener(IPropertyChangeListener* l) override;

  void RemovePropertyListener(IPropertyChangeListener* l) override;

  void SetPartProperty(const QString& key, const QString& value) override;

  /* (non-Javadoc)
   * @see org.blueberry.ui.IWorkbenchPart3#getPartProperty(java.lang.String)
   */
  QString GetPartProperty(const QString& key) const override;

  /* (non-Javadoc)
   * @see org.blueberry.ui.IWorkbenchPart3#getPartProperties()
   */
  const QHash<QString, QString>& GetPartProperties() const override;

  void SetInitializationData(const IConfigurationElement::Pointer& cfig,
                             const QString& propertyName, const Object::Pointer& data) override;

  /*
   * Creates the controls for this workbench part.
   * <p>
   * Subclasses must implement this method.  For a detailed description of the
   * requirements see <code>IWorkbenchPart</code>
   * </p>
   *
   * @param parent the parent control
   * @see IWorkbenchPart
   */
  virtual void CreatePartControl(QWidget* parent) override = 0;

  /* (non-Javadoc)
     * Asks this part to take focus within the workbench.
     * <p>
     * Subclasses must implement this method.  For a detailed description of the
     * requirements see <code>IWorkbenchPart</code>
     * </p>
     *
     * @see IWorkbenchPart
     */
  virtual void SetFocus() override = 0;

  /*
   * Method declared on IWorkbenchPart.
   */
  IWorkbenchPartSite::Pointer GetSite() const override;

  QString GetPartName() const override;

  QString GetContentDescription() const override;


  /* (non-Javadoc)
   * Method declared on IWorkbenchPart.
   */
  QIcon GetTitleImage() const override;

  /* (non-Javadoc)
   * Gets the title tool tip text of this part.
   *
   * @return the tool tip text
   */
  QString GetTitleToolTip() const override;

};

} // namespace berry

#endif // __BERRY_WORKBENCH_PART_H__