cxStateService.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.

Copyright (c) 2008-2014, SINTEF Department of Medical Technology
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors 
   may be used to endorse or promote products derived from this software 
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/

#ifndef CXSTATESERVICE_H_
#define CXSTATESERVICE_H_

#include "cxResourceExport.h"

#include "cxForwardDeclarations.h"
#include <QObject>
#include "cxSettings.h"
class QActionGroup;
class ctkPluginContext;

#define StateService_iid "cx::StateService"

namespace cx
{

struct cxResource_EXPORT Desktop
{
        Desktop();
        Desktop(QString layout, QByteArray mainwindowstate);
        void addPreset(QString name, int pos, bool tabbed=true);

        QString mLayoutUid;
        QString mSecondaryLayoutUid;
        QByteArray mMainWindowState;

        struct Preset
        {
                QString name; // name of widget without postfix (i.e. Workflow instead of WorkflowToolbar)
                int position; // corresponding to values in Qt::DockWidgetArea and Qt::ToolBarArea
                bool tabbed;
        };
        std::vector<Preset> mPresets; // used on top of the MainWindowState: gives programmatic control over positioning
};

class cxResource_EXPORT StateService: public QObject
{
Q_OBJECT

public:
        virtual ~StateService() {}

        virtual QString getVersionName() = 0;
        virtual QString getApplicationStateName() const = 0;
        virtual QStringList getAllApplicationStateNames() const = 0;

        virtual QActionGroup* getWorkflowActions() = 0;
        virtual void setWorkFlowState(QString uid) = 0;

        virtual Desktop getActiveDesktop() = 0;
        virtual void saveDesktop(Desktop desktop) = 0;
        virtual void resetDesktop() = 0;

        virtual bool isNull() = 0;
        static StateServicePtr getNullObject();

protected:
        void fillDefaultSettings();
        template<class T>
        void fillDefault(QString name, T value)
        {
                settings()->fillDefault(name, value);
        }

signals:
        void workflowStateChanged();
        void workflowStateAboutToChange();
        void applicationStateChanged();
};

}
Q_DECLARE_INTERFACE(cx::StateService, StateService_iid)

#endif /* CXSTATESERVICE_H_ */