Fraxinus  17.12-rc3
An IGT application
cxStateService.h
Go to the documentation of this file.
1 /*=========================================================================
2 This file is part of CustusX, an Image Guided Therapy Application.
3 
4 Copyright (c) 2008-2014, SINTEF Department of Medical Technology
5 All rights reserved.
6 
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9 
10 1. Redistributions of source code must retain the above copyright notice,
11  this list of conditions and the following disclaimer.
12 
13 2. Redistributions in binary form must reproduce the above copyright notice,
14  this list of conditions and the following disclaimer in the documentation
15  and/or other materials provided with the distribution.
16 
17 3. Neither the name of the copyright holder nor the names of its contributors
18  may be used to endorse or promote products derived from this software
19  without specific prior written permission.
20 
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 =========================================================================*/
32 
33 #ifndef CXSTATESERVICE_H_
34 #define CXSTATESERVICE_H_
35 
36 #include "cxResourceExport.h"
37 
38 #include "cxForwardDeclarations.h"
39 #include <QObject>
40 #include "cxSettings.h"
41 class QActionGroup;
42 class ctkPluginContext;
43 
44 #define StateService_iid "cx::StateService"
45 
46 namespace cx
47 {
48 
64 struct cxResource_EXPORT Desktop
65 {
66  Desktop();
67  Desktop(QString layout, QByteArray mainwindowstate);
68  void addPreset(QString name, int pos, bool tabbed=true);
69 
70  QString mLayoutUid;
72  QByteArray mMainWindowState;
73 
74  struct Preset
75  {
76  QString name; // name of widget without postfix (i.e. Workflow instead of WorkflowToolbar)
77  int position; // corresponding to values in Qt::DockWidgetArea and Qt::ToolBarArea
78  bool tabbed;
79  };
80  std::vector<Preset> mPresets; // used on top of the MainWindowState: gives programmatic control over positioning
81 };
82 
123 class cxResource_EXPORT StateService: public QObject
124 {
125 Q_OBJECT
126 
127 public:
128  virtual ~StateService() {}
129 
130  virtual QString getVersionName() = 0;
131  virtual QString getApplicationStateName() const = 0;
132  virtual QStringList getAllApplicationStateNames() const = 0;
133 
134  virtual QActionGroup* getWorkflowActions() = 0;
135  virtual void setWorkFlowState(QString uid) = 0;
136 
137  virtual Desktop getActiveDesktop() = 0;
138  virtual void saveDesktop(Desktop desktop) = 0;
139  virtual void resetDesktop() = 0;
140 
141  virtual bool isNull() = 0;
142  static StateServicePtr getNullObject();
143 
144 protected:
145  void fillDefaultSettings();
146  template<class T>
147  void fillDefault(QString name, T value)
148  {
149  settings()->fillDefault(name, value);
150  }
151 
152 signals:
153  void workflowStateChanged();
154  void workflowStateAboutToChange();
155  void applicationStateChanged();
156 };
157 
161 }
162 Q_DECLARE_INTERFACE(cx::StateService, StateService_iid)
163 
164 #endif /* CXSTATESERVICE_H_ */
std::vector< Preset > mPresets
boost::shared_ptr< class StateService > StateServicePtr
#define StateService_iid
Workflow states for CustusX.
QByteArray mMainWindowState
void fillDefault(QString name, T value)
Settings * settings()
Shortcut for accessing the settings instance.
Definition: cxSettings.cpp:42
Data class for CustusX desktop.
QString mLayoutUid
virtual ~StateService()
QString mSecondaryLayoutUid
void fillDefault(QString name, T value)
Definition: cxSettings.h:81
Namespace for all CustusX production code.