Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreAnnotator.h
Go to the documentation of this file.
1
7#ifndef __HDI_CORE_ANNOTATOR__
8#define __HDI_CORE_ANNOTATOR__
9
10#if defined(HDI_CORE_AIP_MODE)
11
12#include "hdicoreTypes.h"
13
14namespace hdi
15{
16 namespace aip
17 {
18 class Annotator;
19 }
20
21 namespace core
22 {
23 class Callback;
24
29 {
30 public:
35 {
36 DrawBeforeAllOthers = 1 << 0,
37 DrawOnInactiveDocuments = 1 << 1,
38 DontDrawOnInactiveViews = 1 << 2
39 };
40
53
61 Annotator(const Annotator& a_);
62
71 Annotator(const std::string& name_, const Callback& responder_);
72
78 virtual ~Annotator();
79
89 virtual Annotator& operator=(const Annotator& rhs_);
90
99 virtual bool operator==(const Annotator& rhs_) const;
100
109 virtual bool operator!=(const Annotator& rhs_) const;
110
118 virtual bool isEmpty() const;
119
133 virtual void destroy();
134
146 virtual AIAnnotatorHandle aiAnnotatorHandle() const;
147
155 virtual std::string name() const;
156
164 virtual bool active() const;
165
175 virtual void setActive(const bool active_);
176
182 virtual void activate();
183
189 virtual void deactivate();
190
198 virtual Options options() const;
199
207 virtual void setOptions(const Options flags_);
208
216 virtual Callback* const callback() const;
217
225 virtual void setCallback(const Callback& cb_);
226
227
228 private:
229 friend aip::Annotator* __accessImpl(const Annotator&);
230
234 void* __data;
235
241 void* __impl() const;
242 };
243
244 typedef std::unique_ptr<Annotator> AnnotatorUP;
245 typedef std::shared_ptr<Annotator> AnnotatorSP;
246 typedef std::weak_ptr<Annotator> AnnotatorWP;
247
248 extern aip::Annotator* __accessImpl(const Annotator&);
249 }
250}
251
255);
256
260);
261
262#endif
263// HDI_CORE_AIP_MODE
264
265#endif
266// __HDI_CORE_ANNOTATOR__
Deals with annotator registration and drawing callbacks.
Definition: hdicoreAnnotator.h:29
virtual void destroy()
Destroys the annotator, converting the target object to an empty Annotator object (see the default co...
virtual void setCallback(const Callback &cb_)
Sets the callback for the annotator.
virtual bool operator!=(const Annotator &rhs_) const
Tests whether a given Annotator object is not the same as another.
virtual void setOptions(const Options flags_)
Sets the options for the target annotator.
virtual void activate()
Activates (enables) the annotator.
virtual Options options() const
Gets the options that have been applied to the target annotator.
virtual bool operator==(const Annotator &rhs_) const
Tests whether a given Annotator object is the same as another.
virtual void setActive(const bool active_)
Sets whether the annotator is active.
virtual Callback *const callback() const
Gets the registered drawing callback for the annotator.
Annotator(const Annotator &a_)
Constructs a new Annotator object from an existing Annotator object (copy constructor)
virtual AIAnnotatorHandle aiAnnotatorHandle() const
Gets the annotator handle around which the target object is wrapped.
virtual std::string name() const
Gets the annotator's unique name.
virtual Annotator & operator=(const Annotator &rhs_)
Assigns one Annotator object to another.
virtual bool active() const
Gets whether the annotator is active.
virtual ~Annotator()
Annotator destructor; deactivates the annotator and deletes the registered callback.
virtual void deactivate()
Deactivates (disables) the annotator.
Annotator()
Constructs an empty Annotator object.
virtual bool isEmpty() const
Gets whether the target Annotator object is empty (constructed with the default ctor)
Annotator(const std::string &name_, const Callback &responder_)
Constructs an Annotator object, with a unique name and callback.
Options
Options for how an annotator should behave.
Definition: hdicoreAnnotator.h:35
Base class for templated __Callback class.
Definition: hdicoreCallback.h:68
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.