MyScript Interactive Ink SDK  3.0.1
ContentPackage.h
1 // Copyright @ MyScript. All rights reserved.
2 
3 #pragma once
4 
5 #include <iink/Engine.h>
6 
7 #include <memory>
8 
9 namespace myscript {
10 namespace iink {
11 
12 class ContentPart;
13 class ParameterSet;
14 
21 {
22 public:
23  virtual ~ContentPackage() = default;
24 
29  virtual void save() = 0;
30 
43  virtual void saveToTemp() = 0;
44 
51  virtual void saveAs(const String& fileName) = 0;
52 
58  virtual int getPartCount() const noexcept = 0;
59 
67  virtual std::shared_ptr<ContentPart> getPart(int index) = 0;
68 
76  virtual std::shared_ptr<ContentPart> getPart(const String& id) = 0;
77 
84  virtual int indexOfPart(std::shared_ptr<ContentPart> part) = 0;
85 
93  virtual std::shared_ptr<ContentPart> createPart(const String& type) = 0;
94 
103  virtual void removePart(std::shared_ptr<ContentPart> part) = 0;
104 
114  virtual void movePart(int fromIndex, int toIndex) = 0;
115 
131  virtual std::shared_ptr<ContentPart> clonePart(std::shared_ptr<ContentPart> part) = 0;
132 
141  virtual void extractObject(const String& url, const String& fileName) = 0;
142 
148  virtual std::shared_ptr<ParameterSet> getMetadata() = 0;
149 
155  virtual void setMetadata(std::shared_ptr<ParameterSet> parameters) = 0;
156 
164  virtual String getPath() = 0;
165 };
166 
167 }
168 }
Definition: ContentPackage.h:21
virtual int indexOfPart(std::shared_ptr< ContentPart > part)=0
virtual std::shared_ptr< ParameterSet > getMetadata()=0
virtual std::shared_ptr< ContentPart > createPart(const String &type)=0
virtual std::shared_ptr< ContentPart > getPart(int index)=0
virtual void movePart(int fromIndex, int toIndex)=0
virtual std::shared_ptr< ContentPart > clonePart(std::shared_ptr< ContentPart > part)=0
virtual int getPartCount() const noexcept=0
virtual void saveAs(const String &fileName)=0
virtual void removePart(std::shared_ptr< ContentPart > part)=0
virtual void extractObject(const String &url, const String &fileName)=0
virtual void setMetadata(std::shared_ptr< ParameterSet > parameters)=0
virtual String getPath()=0
virtual ~ContentPackage()=default
Definition: ContentPart.h:24
Definition: ParameterSet.h:16
Definition: String.h:30
Definition: Configuration.h:11