berryEditorPart.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 BERRYEDITORPART_H_
#define BERRYEDITORPART_H_

#include <org_blueberry_ui_qt_Export.h>
#include "berryIEditorPart.h"
#include "berryIEditorInput.h"
#include "berryIEditorSite.h"
#include "berryWorkbenchPart.h"

namespace berry {

class BERRY_UI_QT EditorPart : public WorkbenchPart , public virtual IEditorPart {

  Q_OBJECT
  Q_INTERFACES(berry::IEditorPart)

public:
  berryObjectMacro(EditorPart, WorkbenchPart, IEditorPart)

private:

    IEditorInput::Pointer editorInput;


protected:

    EditorPart();

    virtual void SetInput(IEditorInput::Pointer input) ;

    virtual void SetInputWithNotify(IEditorInput::Pointer input);

    /* (non-Javadoc)
     * @see org.blueberry.ui.part.WorkbenchPart#setContentDescription(java.lang.String)
     */
    virtual void SetContentDescription(const QString& description) override;

    /* (non-Javadoc)
     * @see org.blueberry.ui.part.WorkbenchPart#setPartName(java.lang.String)
     */
    virtual void SetPartName(const QString& partName) override;

    void CheckSite(IWorkbenchPartSite::Pointer site) override;

public:

    /* (non-Javadoc)
     * Saves the contents of this editor.
     * <p>
     * Subclasses must override this method to implement the open-save-close lifecycle
     * for an editor.  For greater details, see <code>IEditorPart</code>
     * </p>
     *
     * @see IEditorPart
     */
  virtual void DoSave(/*IProgressMonitor monitor*/) override = 0;

    /* (non-Javadoc)
     * Saves the contents of this editor to another object.
     * <p>
     * Subclasses must override this method to implement the open-save-close lifecycle
     * for an editor.  For greater details, see <code>IEditorPart</code>
     * </p>
     *
     * @see IEditorPart
     */
  virtual void DoSaveAs() override = 0;

    /* (non-Javadoc)
     * Method declared on IEditorPart.
     */
  IEditorInput::Pointer GetEditorInput() const override;

    /* (non-Javadoc)
     * Method declared on IEditorPart.
     */
  IEditorSite::Pointer GetEditorSite() const override;

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

    /* (non-Javadoc)
     * Initializes the editor part with a site and input.
     * <p>
     * Subclasses of <code>EditorPart</code> must implement this method.  Within
     * the implementation subclasses should verify that the input type is acceptable
     * and then save the site and input.  Here is sample code:
     * </p>
     * <pre>
     *    if (!(input instanceof IFileEditorInput))
     *      throw new PartInitException("Invalid Input: Must be IFileEditorInput");
     *    setSite(site);
     *    setInput(input);
     * </pre>
     */
  virtual void Init(IEditorSite::Pointer site, IEditorInput::Pointer input) override = 0;


    /* (non-Javadoc)
     * Returns whether the contents of this editor have changed since the last save
     * operation.
     * <p>
     * Subclasses must override this method to implement the open-save-close lifecycle
     * for an editor.  For greater details, see <code>IEditorPart</code>
     * </p>
     *
     * @see IEditorPart
     */
  virtual bool IsDirty() const override = 0;

    /* (non-Javadoc)
     * Returns whether the "save as" operation is supported by this editor.
     * <p>
     * Subclasses must override this method to implement the open-save-close lifecycle
     * for an editor.  For greater details, see <code>IEditorPart</code>
     * </p>
     *
     * @see IEditorPart
     */
  virtual bool IsSaveAsAllowed() const override = 0;

    /* (non-Javadoc)
     * Returns whether the contents of this editor should be saved when the editor
     * is closed.
     * <p>
     * This method returns <code>true</code> if and only if the editor is dirty
     * (<code>isDirty</code>).
     * </p>
     */
  virtual bool IsSaveOnCloseNeeded() const override;

};

}

#endif /*BERRYEDITORPART_H_*/