berryIEditorRegistry.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 MITKIEDITORREGISTRY_H_
#define MITKIEDITORREGISTRY_H_


#include "berryIEditorDescriptor.h"
#include "berryIFileEditorMapping.h"

namespace berry {

struct BERRY_UI_QT IEditorRegistry {

    static const int PROP_CONTENTS; // = 0x01;

    static const QString SYSTEM_EXTERNAL_EDITOR_ID; // = "org.blueberry.ui.systemExternalEditor";

    static const QString SYSTEM_INPLACE_EDITOR_ID; // = "org.blueberry.ui.systemInPlaceEditor";

    /*
     * Adds a listener for changes to properties of this registry.
     * Has no effect if an identical listener is already registered.
     * <p>
     * The properties ids are as follows:
     * <ul>
     *   <li><code>PROP_CONTENTS</code>: Triggered when the file editor mappings in
     *       the editor registry change.</li>
     * </ul>
     * </p>
     *
     * @param listener a property listener
     */
    // virtual void AddPropertyListener(IPropertyListener listener) = 0;

    virtual ~IEditorRegistry();

    virtual IEditorDescriptor::Pointer FindEditor(const QString& editorId) = 0;

    virtual IEditorDescriptor::Pointer GetDefaultEditor() = 0;

    virtual IEditorDescriptor::Pointer GetDefaultEditor(const QString& fileName) = 0;

    /*
     * Returns the default editor for a given file name and with the given content type.
     * <p>
     * The default editor is determined by taking the file extension for the
     * file and obtaining the default editor for that extension.
     * </p>
     *
     * @param fileName the file name in the system
     * @param contentType the content type or <code>null</code> for the unknown content type
     * @return the descriptor of the default editor, or <code>null</code> if not
     *   found
     * @since 3.1
     */
    //virtual IEditorDescriptor::Pointer GetDefaultEditor(const QString& fileName, IContentType contentType) = 0;

  virtual QList<IEditorDescriptor::Pointer> GetEditors(const QString& fileName) = 0;

  /*
   * Returns the list of file editors registered to work against the file with
   * the given file name and with the given content type.
   * <p>
   * Note: Use <code>getDefaultEditor(String)</code> if you only the need
   * the default editor rather than all candidate editors.
   * </p>
   *
   * @param fileName
   *            the file name in the system
   * @param contentType
   *            the content type or <code>null</code> for the unknown
   *            content type
   * @return a list of editor descriptors
   * @since 3.1
   */
    //virtual QList<IEditorDescriptor::Pointer> GetEditors(const QString& fileName, IContentType contentType) = 0;

    virtual QList<IFileEditorMapping::Pointer> GetFileEditorMappings() = 0;

  /*
   * Returns the image descriptor associated with a given file. This image is
   * usually displayed next to the given file. This method assumes an unknown
   * content type for the given file.
   * <p>
   * The image is determined by taking the file extension of the file and
   * obtaining the image for the default editor associated with that
   * extension. A default image is returned if no default editor is available.
   * </p>
   *
   * @param filename
   *            the file name in the system
   * @return the descriptor of the image to display next to the file
   */
   // virtual ImageDescriptor* GetImageDescriptor(const QString& filename) = 0;

  /*
   * Returns the image descriptor associated with a given file. This image is
   * usually displayed next to the given file.
   * <p>
   * The image is determined by taking the file extension of the file and
   * obtaining the image for the default editor associated with that
   * extension. A default image is returned if no default editor is available.
   * </p>
   *
   * @param filename
   *            the file name in the system
   * @param contentType
   *            the content type of the file or <code>null</code> for the
   *            unknown content type
   * @return the descriptor of the image to display next to the file
   * @since 3.1
   */
   // virtual ImageDescriptor* GetImageDescriptor(const std::tring& filename, IContentType contentType) = 0;

    /*
     * Removes the given property listener from this registry.
     * Has no affect if an identical listener is not registered.
     *
     * @param listener a property listener
     */
   // virtual void RemovePropertyListener(IPropertyListener listener) = 0;

    virtual void SetDefaultEditor(const QString& fileNameOrExtension, const QString& editorId) = 0;

    virtual bool IsSystemInPlaceEditorAvailable(const QString& filename) = 0;

    virtual bool IsSystemExternalEditorAvailable(const QString& filename) = 0;

    /*
     * Returns the image descriptor associated with the system editor that
     * would be used to edit this file externally.
     *
     * @param filename the file name
     * @return the descriptor of the external editor image, or <code>null</code>
     * if none
     * @since 3.0
     */
   // virtual ImageDescriptor GetSystemExternalEditorImageDescriptor(const QString& filename) = 0;
};

}

#endif /*MITKIEDITORREGISTRY_H_*/