Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreaiPreferences.h
Go to the documentation of this file.
1
7#ifndef __HDI_CORE_AI_PREFERENCES__
8#define __HDI_CORE_AI_PREFERENCES__
9
10#if defined(HDI_CORE_AIP_MODE)
11
12#include <string>
13
14namespace hdi
15{
16 namespace core
17 {
18 class Illustrator;
19 class Point;
20 class Rect;
21
22 namespace ai
23 {
28 class Preferences
29 {
30 public:
42 bool getBoolPref(const std::string& prefix_, const std::string& suffix_, bool& b__) const;
43
55 bool setBoolPref(const std::string& prefix_, const std::string& suffix_, const bool b_);
56
68 bool getIntPref(const std::string& prefix_, const std::string& suffix_, int32_t& n__) const;
69
81 bool setIntPref(const std::string& prefix_, const std::string& suffix_, const int32_t n_);
82
94 bool getFloatPref(const std::string& prefix_, const std::string& suffix_, double& n__) const;
95
107 bool setFloatPref(const std::string& prefix_, const std::string& suffix_, const double n_);
108
120 bool getPointPref(const std::string& prefix_, const std::string& suffix_, Point& p__) const;
121
133 bool setPointPref(const std::string& prefix_, const std::string& suffix_, const Point& p_);
134
146 bool getRectPref(const std::string& prefix_, const std::string& suffix_, Rect& r__) const;
147
159 bool setRectPref(const std::string& prefix_, const std::string& suffix_, const Rect& r_);
160
172 bool getStringPref(const std::string& prefix_, const std::string& suffix_, std::string& str__) const;
173
185 bool setStringPref(const std::string& prefix_, const std::string& suffix_, const std::string& str_);
186
196 bool prefExists(const std::string& prefix_, const std::string& suffix_) const;
197
210 bool removePref(const std::string& prefix_, const std::string& suffix_);
211
212
213 private:
214 // Only Illustrator can construct a Preferences object
215 friend class core::Illustrator;
216
222 Preferences();
223
229 ~Preferences();
230 };
231 }
232 }
233}
234
235#endif
236// HDI_CORE_AIP_MODE
237
238#endif
239// __HDI_CORE_AI_PREFERENCES__
hdi::core::Illustrator
Allows access to a wide variety of Illustrator app-related runtime attributes, documents,...
Definition: hdicoreIllustrator.h:47
hdi::core::Point
Describes a point in the 2-dimensional (x,y) coordinate system, typically in an Illustrator document ...
Definition: hdicorePoint.h:38
hdi::core::Rect
Contains Point and Size objects to describe a rectangle that exists at a specific point of given dime...
Definition: hdicoreRect.h:34
hdi::core::ai::Preferences
Allows access to and manipulation of Illustrator app preferences; can be used to store plugin prefere...
Definition: hdicoreaiPreferences.h:29
hdi::core::ai::Preferences::setPointPref
bool setPointPref(const std::string &prefix_, const std::string &suffix_, const Point &p_)
Sets a point pref in the Illustrator prefs data tree.
hdi::core::ai::Preferences::getRectPref
bool getRectPref(const std::string &prefix_, const std::string &suffix_, Rect &r__) const
Gets a rectangle pref from the Illustrator prefs data tree.
hdi::core::ai::Preferences::setBoolPref
bool setBoolPref(const std::string &prefix_, const std::string &suffix_, const bool b_)
Sets a bool pref in the Illustrator prefs data tree.
hdi::core::ai::Preferences::setIntPref
bool setIntPref(const std::string &prefix_, const std::string &suffix_, const int32_t n_)
Sets an integer pref in the Illustrator prefs data tree.
hdi::core::ai::Preferences::getBoolPref
bool getBoolPref(const std::string &prefix_, const std::string &suffix_, bool &b__) const
Gets a bool pref from the Illustrator prefs data tree.
hdi::core::ai::Preferences::setStringPref
bool setStringPref(const std::string &prefix_, const std::string &suffix_, const std::string &str_)
Sets a string pref in the Illustrator prefs data tree.
hdi::core::ai::Preferences::prefExists
bool prefExists(const std::string &prefix_, const std::string &suffix_) const
Check if a preference from the Illustrator prefs data exists.
hdi::core::ai::Preferences::setRectPref
bool setRectPref(const std::string &prefix_, const std::string &suffix_, const Rect &r_)
Sets a rectangle pref in the Illustrator prefs data tree.
hdi::core::ai::Preferences::getFloatPref
bool getFloatPref(const std::string &prefix_, const std::string &suffix_, double &n__) const
Gets a floating-point pref from the Illustrator prefs data tree.
hdi::core::ai::Preferences::getStringPref
bool getStringPref(const std::string &prefix_, const std::string &suffix_, std::string &str__) const
Gets a string pref from the Illustrator prefs data tree.
hdi::core::ai::Preferences::setFloatPref
bool setFloatPref(const std::string &prefix_, const std::string &suffix_, const double n_)
Sets a floating-point pref in the Illustrator prefs data tree.
hdi::core::ai::Preferences::removePref
bool removePref(const std::string &prefix_, const std::string &suffix_)
Removes a preference from the Illustrator prefs data tree.
hdi::core::ai::Preferences::getIntPref
bool getIntPref(const std::string &prefix_, const std::string &suffix_, int32_t &n__) const
Gets an integer pref from the Illustrator prefs data tree.
hdi::core::ai::Preferences::getPointPref
bool getPointPref(const std::string &prefix_, const std::string &suffix_, Point &p__) const
Gets a point pref from the Illustrator prefs data tree.
Generated by doxygen 1.9.6