Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
hdicoreaiPreferences.h
Go to the documentation of this file.
1 
7 #ifndef __HDI_CORE_AI_PREFERENCES__
8 #define __HDI_CORE_AI_PREFERENCES__
9 
10 #include <string>
11 
12 namespace hdi
13 {
14  namespace core
15  {
16  class Illustrator;
17  class Point;
18  class Rect;
19 
20  namespace ai
21  {
27  {
28  public:
40  bool getBoolPref(const std::string& prefix_, const std::string& suffix_, bool& b__);
41 
53  bool setBoolPref(const std::string& prefix_, const std::string& suffix_, const bool b_);
54 
66  bool getIntPref(const std::string& prefix_, const std::string& suffix_, int32_t& n__);
67 
79  bool setIntPref(const std::string& prefix_, const std::string& suffix_, const int32_t n_);
80 
92  bool getFloatPref(const std::string& prefix_, const std::string& suffix_, double& n__);
93 
105  bool setFloatPref(const std::string& prefix_, const std::string& suffix_, const double n_);
106 
118  bool getPointPref(const std::string& prefix_, const std::string& suffix_, Point& p__);
119 
131  bool setPointPref(const std::string& prefix_, const std::string& suffix_, const Point& p_);
132 
144  bool getRectPref(const std::string& prefix_, const std::string& suffix_, Rect& r__);
145 
157  bool setRectPref(const std::string& prefix_, const std::string& suffix_, const Rect& r_);
158 
170  bool getStringPref(const std::string& prefix_, const std::string& suffix_, std::string& str__);
171 
183  bool setStringPref(const std::string& prefix_, const std::string& suffix_, const std::string& str_);
184 
197  bool removePref(const std::string& prefix_, const std::string& suffix_);
198 
199 
200  private:
201  // Only Illustrator can construct a Preferences object
202  friend class core::Illustrator;
203 
209  Preferences();
210 
216  ~Preferences();
217  };
218  }
219  }
220 }
221 
222 #endif
bool getFloatPref(const std::string &prefix_, const std::string &suffix_, double &n__)
Gets a floating-point pref from the Illustrator prefs data tree.
Describes a point in the 2-dimensional (x,y) coordinate system, typically in an Illustrator document ...
Definition: hdicorePoint.h:26
bool setBoolPref(const std::string &prefix_, const std::string &suffix_, const bool b_)
Sets a bool pref in the Illustrator prefs data tree.
bool setStringPref(const std::string &prefix_, const std::string &suffix_, const std::string &str_)
Sets a string pref in the Illustrator prefs data tree.
bool setRectPref(const std::string &prefix_, const std::string &suffix_, const Rect &r_)
Sets a rectangle pref in the Illustrator prefs data tree.
bool setFloatPref(const std::string &prefix_, const std::string &suffix_, const double n_)
Sets a floating-point pref in the Illustrator prefs data tree.
bool setIntPref(const std::string &prefix_, const std::string &suffix_, const int32_t n_)
Sets an integer pref in the Illustrator prefs data tree.
bool getPointPref(const std::string &prefix_, const std::string &suffix_, Point &p__)
Gets a point pref from the Illustrator prefs data tree.
Allows access to and manipulation of Illustrator app preferences; can be used to store plugin prefere...
Definition: hdicoreaiPreferences.h:26
Contains Point and Size objects to describe a rectangle that exists at a specific point of given dime...
Definition: hdicoreRect.h:26
bool removePref(const std::string &prefix_, const std::string &suffix_)
Removes a preference from the Illustrator prefs data tree.
bool getIntPref(const std::string &prefix_, const std::string &suffix_, int32_t &n__)
Gets an integer pref from the Illustrator prefs data tree.
bool getStringPref(const std::string &prefix_, const std::string &suffix_, std::string &str__)
Gets a string pref from the Illustrator prefs data tree.
Definition: hdicoreaiArray.h:12
bool getRectPref(const std::string &prefix_, const std::string &suffix_, Rect &r__)
Gets a rectangle pref from the Illustrator prefs data tree.
bool getBoolPref(const std::string &prefix_, const std::string &suffix_, bool &b__)
Gets a bool pref from the Illustrator prefs data tree.
Allows access to a wide variety of Illustrator app-related runtime attributes, documents, fonts, etc.
Definition: hdicoreIllustrator.h:48
bool setPointPref(const std::string &prefix_, const std::string &suffix_, const Point &p_)
Sets a point pref in the Illustrator prefs data tree.