WorkbenchPart.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MIRA_WORKBENCHPART_H_
#define _MIRA_WORKBENCHPART_H_

#include <factory/Factory.h>
#include <rcp/Adaptable.h>
#include <rcp/GuiRCPExports.h>

class QWidget;

namespace mira {


class IPartListener;
class IWorkbenchPart;


class IWorkbenchPartSite
{
public:
    virtual ~IWorkbenchPartSite() {}

    virtual void addPartListener(IPartListener* listener) = 0;
    virtual void removePartListener(IPartListener* listener) = 0;

    virtual IWorkbenchPart* getActiveEditor() = 0;

    virtual std::list<IWorkbenchPart*> getEditors(bool backToFront = false) = 0;
};


class IWorkbenchPart : public Object, public IAdaptable
{
public:
    virtual ~IWorkbenchPart() {}

public:

    virtual void activate() = 0;

    virtual void deactivate() = 0;
};


class MIRA_GUI_RCP_EXPORT WorkbenchPart : public IWorkbenchPart
{
    MIRA_ABSTRACT_OBJECT(WorkbenchPart)
public:

    WorkbenchPart();

    template <typename Reflector>
    void reflect(Reflector& r)
    {
        // nothing to do here
    }

public: // implementation if IWorkbenchPart

    virtual void activate();
    virtual void deactivate();

    bool isActivated() const { return mIsActivated; }

public:

    virtual void init(IWorkbenchPartSite* site) = 0;

public:

    virtual Object* getAdapter(const Class& adapter) { return NULL; }

private:

    bool mIsActivated;
};


}

#endif