cxStateService.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.
                 
Copyright (c) SINTEF Department of Medical Technology.
All rights reserved.
                 
CustusX is released under a BSD 3-Clause license.
                 
See Lisence.txt (https://github.com/SINTEFMedtek/CustusX/blob/master/License.txt) for details.
=========================================================================*/

#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 WorkflowStateMachinePtr getWorkflow() = 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_ */