Medical Imaging Interaction Toolkit  2025.12.02
Medical Imaging Interaction Toolkit
mitkEventConfig.h
Go to the documentation of this file.
1 /*============================================================================
2 
3 The Medical Imaging Interaction Toolkit (MITK)
4 
5 Copyright (c) German Cancer Research Center (DKFZ)
6 All rights reserved.
7 
8 Use of this source code is governed by a 3-clause BSD license that can be
9 found in the LICENSE file.
10 
11 ============================================================================*/
12 
13 #ifndef mitkEventConfig_h
14 #define mitkEventConfig_h
15 
16 #include <MitkCoreExports.h>
17 
18 #include "mitkPropertyList.h"
19 #include "usSharedData.h"
20 
21 #include "itkSmartPointer.h"
22 
23 namespace us
24 {
25  class Module;
26 }
27 
28 namespace mitk
29 {
30  class InteractionEvent;
31  struct EventConfigPrivate;
32 
45  {
46  public:
48 
55  EventConfig(const EventConfig &other);
56 
67  EventConfig(const std::string &filename, const us::Module *module = nullptr);
68 
78  EventConfig(std::istream &inputStream);
79 
117  EventConfig(const std::vector<PropertyList::Pointer> &configDescription);
118 
120 
122 
127  bool IsValid() const;
128 
142  bool AddConfig(const std::string &filename, const us::Module *module = nullptr);
143 
156  bool AddConfig(const EventConfig &config);
157 
161  void ClearConfig();
162 
167  PropertyList::Pointer GetAttributes() const;
168 
181  std::string GetMappedEvent(const EventType &interactionEvent) const;
182 
183  private:
185  };
186 
187 } // namespace mitk
188 
189 #endif
#define MITKCORE_EXPORT
Configuration Object for Statemachines.
EventConfig(std::istream &inputStream)
Construct an EventConfig object based on a XML configuration file.
bool AddConfig(const EventConfig &config)
This method extends this configuration. The configuration from the EventConfig object is loaded and o...
bool IsValid() const
Checks whether this EventConfig object is valid.
EventConfig(const std::vector< PropertyList::Pointer > &configDescription)
Construct an EventConfig object based on a vector of mitk::PropertyLists.
EventConfig & operator=(const EventConfig &other)
std::string GetMappedEvent(const EventType &interactionEvent) const
EventConfig()
Constructs an invalid EventConfig object.
EventConfig(const std::string &filename, const us::Module *module=nullptr)
Construct an EventConfig object based on a XML configuration file.
itk::SmartPointer< InteractionEvent > EventType
void ClearConfig()
Reset this EventConfig object, rendering it invalid.
bool AddConfig(const std::string &filename, const us::Module *module=nullptr)
This method extends this configuration.
EventConfig(const EventConfig &other)
PropertyList::Pointer GetAttributes() const
Find image slices visible on a given plane.