Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
hdicoreTextParaFeatures.h
Go to the documentation of this file.
1 
7 #ifndef __HDI_CORE_TEXT_PARA_FEATURES__
8 #define __HDI_CORE_TEXT_PARA_FEATURES__
9 
10 #include "hdicoreTypes.h"
11 
12 namespace hdi
13 {
14  namespace plugin
15  {
16  class TextParaFeatures;
17  }
18 
19  namespace core
20  {
21  class TextCharFeatures;
22  class TextTabStopSet;
23 
28  {
29  public:
40 
49 
55  virtual ~TextParaFeatures();
56 
62  virtual TextParaFeatures& operator=(const TextParaFeatures& rhs_);
63 
72  virtual bool operator==(const TextParaFeatures& rhs_) const;
73 
82  virtual bool operator!=(const TextParaFeatures& rhs_) const;
83 
95  virtual std::auto_ptr<ATE::IParaFeatures> ateParaFeatures() const;
96 
104  virtual bool isEmpty() const;
105 
113  virtual std::auto_ptr<TextParaFeatures> duplicate() const;
114 
123  virtual bool justification(ParagraphJustification& just__) const;
124 
133  virtual bool firstLineIndent(double& indent__) const;
134 
143  virtual bool startIndent(double& indent__) const;
144 
153  virtual bool endIndent(double& indent__) const;
154 
163  virtual bool spaceBefore(double& space__) const;
164 
173  virtual bool spaceAfter(double& space__) const;
174 
184  virtual bool autoHyphenate(bool& hyphen__) const;
185 
194  virtual bool hyphenatedWordSize(int32_t& size__) const;
195 
204  virtual bool preHyphenSize(int32_t& size__) const;
205 
214  virtual bool postHyphenSize(int32_t& size__) const;
215 
224  virtual bool consecutiveHyphenLimit(int32_t& limit__) const;
225 
234  virtual bool hyphenationZone(double& zone__) const;
235 
245  virtual bool hyphenateCapitalized(bool& cap__) const;
246 
255  virtual bool hyphenationPreference(double& pref__) const;
256 
265  virtual bool desiredWordSpacing(double& space__) const;
266 
275  virtual bool minWordSpacing(double& space__) const;
276 
285  virtual bool maxWordSpacing(double& space__) const;
286 
295  virtual bool desiredLetterSpacing(double& space__) const;
296 
305  virtual bool minLetterSpacing(double& space__) const;
306 
315  virtual bool maxLetterSpacing(double& space__) const;
316 
325  virtual bool desiredGlyphScaling(double& scale__) const;
326 
335  virtual bool minGlyphScaling(double& scale__) const;
336 
345  virtual bool maxGlyphScaling(double& scale__) const;
346 
355  virtual bool singleWordJustification(ParagraphJustification& just__) const;
356 
366  virtual bool autoLeadingPercentage(double& perc__) const;
367 
376  virtual bool leadingType(LeadingType& type__) const;
377 
386  virtual bool tabStops(TextTabStopSet& stops__) const;
387 
396  virtual bool defaultTabWidth(double& width__) const;
397 
406  virtual bool everyLineComposer(bool& comp__) const;
407 
416  virtual bool defaultCharFeatures(TextCharFeatures& feat__) const;
417 
426  virtual bool composerEngine(ComposerEngine& engine__) const;
427 
435  virtual void setJustification(const ParagraphJustification just_);
436 
444  virtual void setFirstLineIndent(const double indent_);
445 
453  virtual void setStartIndent(const double indent_);
454 
462  virtual void setEndIndent(const double indent_);
463 
471  virtual void setSpaceBefore(const double space_);
472 
480  virtual void setSpaceAfter(const double space_);
481 
489  virtual void setAutoHyphenate(const bool hyphen_);
490 
498  virtual void setHyphenatedWordSize(const int32_t size_);
499 
507  virtual void setPreHyphenSize(const int32_t size_);
508 
516  virtual void setPostHyphenSize(const int32_t size_);
517 
525  virtual void setConsecutiveHyphenLimit(const int32_t limit_);
526 
534  virtual void setHyphenationZone(const double zone_);
535 
543  virtual void setHyphenateCapitalized(const bool cap_);
544 
552  virtual void setHyphenationPreference(const double pref_);
553 
561  virtual void setDesiredWordSpacing(const double space_);
562 
570  virtual void setMinWordSpacing(const double space_);
571 
579  virtual void setMaxWordSpacing(const double space_);
580 
588  virtual void setDesiredLetterSpacing(const double space_);
589 
597  virtual void setMinLetterSpacing(const double space_);
598 
606  virtual void setMaxLetterSpacing(const double space_);
607 
615  virtual void setDesiredGlyphScaling(const double scale_);
616 
624  virtual void setMinGlyphScaling(const double scale_);
625 
633  virtual void setMaxGlyphScaling(const double scale_);
634 
642  virtual void setSingleWordJustification(const ParagraphJustification just_);
643 
651  virtual void setAutoLeadingPercentage(const double perc_);
652 
660  virtual void setLeadingType(const LeadingType type_);
661 
669  virtual void setTabStops(const TextTabStopSet& stops_);
670 
678  virtual void setDefaultTabWidth(const double width_);
679 
687  virtual void setEveryLineComposer(const bool comp_);
688 
696  virtual void setDefaultCharFeatures(const TextCharFeatures& feat_);
697 
705  virtual void setComposerEngine(const ComposerEngine engine_);
706 
712  virtual void clearJustification();
713 
719  virtual void clearFirstLineIndent();
720 
726  virtual void clearStartIndent();
727 
733  virtual void clearEndIndent();
734 
740  virtual void clearSpaceBefore();
741 
747  virtual void clearSpaceAfter();
748 
754  virtual void clearAutoHyphenate();
755 
761  virtual void clearHyphenatedWordSize();
762 
768  virtual void clearPreHyphenSize();
769 
775  virtual void clearPostHyphenSize();
776 
782  virtual void clearConsecutiveHyphenLimit();
783 
789  virtual void clearHyphenationZone();
790 
796  virtual void clearHyphenateCapitalized();
797 
803  virtual void clearHyphenationPreference();
804 
810  virtual void clearWordSpacing();
811 
817  virtual void clearLetterSpacing();
818 
824  virtual void clearGlyphScaling();
825 
831  virtual void clearSingleWordJustification();
832 
838  virtual void clearAutoLeadingPercentage();
839 
845  virtual void clearLeadingType();
846 
852  virtual void clearTabStops();
853 
859  virtual void clearEveryLineComposer();
860 
866  virtual void clearDefaultCharFeatures();
867 
873  virtual void clearComposerEngine();
874 
875 
876  private:
877  friend plugin::TextParaFeatures* __accessImpl(const TextParaFeatures&);
878  friend TextParaFeatures __accessCtor(const plugin::TextParaFeatures&);
879 
883  plugin::TextParaFeatures* __impl;
884 
890  TextParaFeatures(const plugin::TextParaFeatures&);
891  };
892 
893  typedef std::auto_ptr<TextParaFeatures> TextParaFeaturesAP;
894 
895  extern plugin::TextParaFeatures* __accessImpl(const TextParaFeatures&);
896  extern TextParaFeatures __accessCtor(const plugin::TextParaFeatures&);
897  }
898 }
899 
900 #endif
901 // __HDI_CORE_TEXT_PARA_FEATURES__
virtual void setStartIndent(const double indent_)
Sets the local start indent attribute of this paragraph.
virtual bool desiredWordSpacing(double &space__) const
Retrieves the desired word spacing attribute of this paragraph.
virtual void clearFirstLineIndent()
Removes the local first-line indent attribute value of this paragraph.
virtual void setJustification(const ParagraphJustification just_)
Sets the local justification attribute of this paragraph.
virtual ~TextParaFeatures()
Destructs a TextParaFeatures object.
virtual bool startIndent(double &indent__) const
Retrieves the paragraph start indent attribute of this paragraph.
virtual bool hyphenatedWordSize(int32_t &size__) const
Retrieves the hyphenation word size attribute of this paragraph.
virtual bool desiredGlyphScaling(double &scale__) const
Retrieves the desired glyph scaling attribute of this paragraph.
virtual bool spaceAfter(double &space__) const
Retrieves the line space after attribute of this paragraph.
virtual bool minLetterSpacing(double &space__) const
Retrieves the minimum letter spacing attribute of this paragraph.
virtual void clearWordSpacing()
Removes all of the local word spacing attribute values of this paragraph.
virtual void clearPostHyphenSize()
Removes the local post-hyphen size attribute value of this paragraph.
Definition: hdicoreTextTabStopSet.h:23
virtual void setMinLetterSpacing(const double space_)
Sets the local minimum letter spacing attribute of this paragraph.
virtual void clearHyphenatedWordSize()
Removes the local hyphenation word size attribute value of this paragraph.
virtual void setDesiredLetterSpacing(const double space_)
Sets the local desired letter spacing attribute of this paragraph.
virtual bool firstLineIndent(double &indent__) const
Retrieves the first-line indent attribute of this paragraph.
virtual void setSingleWordJustification(const ParagraphJustification just_)
Sets the local single-word justification attribute of this paragraph.
virtual bool tabStops(TextTabStopSet &stops__) const
Retrieves the tab stops attribute of this paragraph.
virtual void clearPreHyphenSize()
Removes the local pre-hyphen size attribute value of this paragraph.
virtual TextParaFeatures & operator=(const TextParaFeatures &rhs_)
Overloaded assignment operator for TextParaFeatures objects.
virtual bool hyphenationZone(double &zone__) const
Retrieves the hyphenation zone attribute of this paragraph.
virtual bool minGlyphScaling(double &scale__) const
Retrieves the minimum glyph scaling attribute of this paragraph.
virtual void setDefaultTabWidth(const double width_)
Sets the local default tab width attribute of this paragraph.
Allows for easy manipulation of Illustrator text character features.
Definition: hdicoreTextCharFeatures.h:31
virtual void clearSingleWordJustification()
Removes the local single-word justification attribute value of this paragraph.
virtual void setSpaceAfter(const double space_)
Sets the local line space after attribute of this paragraph.
virtual bool leadingType(LeadingType &type__) const
Retrieves the leading type attribute of this paragraph.
virtual void clearTabStops()
Removes the local tab stops attribute value of this paragraph.
virtual void clearEndIndent()
Removes the local end indent attribute value of this paragraph.
virtual bool justification(ParagraphJustification &just__) const
Retrieves the justification attribute of this paragraph.
virtual void setHyphenationPreference(const double pref_)
Sets the local hyphenation preference attribute of this paragraph.
virtual bool autoLeadingPercentage(double &perc__) const
Retrieves the automatic leading percentage attribute of this paragraph.
virtual void setPostHyphenSize(const int32_t size_)
Sets the local post-hyphen size attribute of this paragraph.
virtual void clearJustification()
Removes the local justification attribute value of this paragraph.
virtual void clearConsecutiveHyphenLimit()
Removes the local consecutive hyphen limit attribute value of this paragraph.
virtual void setEveryLineComposer(const bool comp_)
Sets the local every-line composer attribute of this paragraph.
virtual void clearDefaultCharFeatures()
Removes the local default character features attribute value of this paragraph.
virtual bool postHyphenSize(int32_t &size__) const
Retrieves the post-hyphen size attribute of this paragraph.
virtual bool endIndent(double &indent__) const
Retrieves the paragraph end indent attribute of this paragraph.
virtual void setConsecutiveHyphenLimit(const int32_t limit_)
Sets the local consecutive hyphen limit attribute of this paragraph.
virtual void setDesiredWordSpacing(const double space_)
Sets the local desired word spacing attribute of this paragraph.
virtual bool autoHyphenate(bool &hyphen__) const
Retrieves the automatic hyphenation attribute of this paragraph.
virtual std::auto_ptr< TextParaFeatures > duplicate() const
Duplicates the target object.
virtual bool maxLetterSpacing(double &space__) const
Retrieves the maximum letter spacing attribute of this paragraph.
virtual void clearEveryLineComposer()
Removes the local every-line composer attribute value of this paragraph.
virtual void clearSpaceAfter()
Removes the local line space after attribute value of this paragraph.
virtual void clearAutoHyphenate()
Removes the local automatic hyphenation attribute value of this paragraph.
virtual void clearComposerEngine()
Removes the composer engine attribute value of this paragraph.
virtual bool composerEngine(ComposerEngine &engine__) const
Retrieves the composer engine attribute of this paragraph.
virtual void setDefaultCharFeatures(const TextCharFeatures &feat_)
Sets the local default character features attribute of this paragraph.
virtual void setMaxWordSpacing(const double space_)
Sets the local maximum word spacing attribute of this paragraph.
virtual void setMaxLetterSpacing(const double space_)
Sets the local maximum letter spacing attribute of this paragraph.
virtual void setHyphenationZone(const double zone_)
Sets the local hyphenation zone attribute of this paragraph.
virtual void clearHyphenationPreference()
Removes the local hyphenation preference attribute value of this paragraph.
virtual void setMinWordSpacing(const double space_)
Sets the local minimum word spacing attribute of this paragraph.
virtual bool maxWordSpacing(double &space__) const
Retrieves the maximum word spacing attribute of this paragraph.
virtual void clearStartIndent()
Removes the local start indent attribute value of this paragraph.
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.
virtual void setSpaceBefore(const double space_)
Sets the local line space before attribute of this paragraph.
virtual bool desiredLetterSpacing(double &space__) const
Retrieves the desired letter spacing attribute of this paragraph.
virtual void setDesiredGlyphScaling(const double scale_)
Sets the local desired glyph scaling attribute of this paragraph.
virtual void setComposerEngine(const ComposerEngine engine_)
Sets the composer engine attribute of this paragraph.
virtual bool operator!=(const TextParaFeatures &rhs_) const
Tests whether a given TextParaFeatures object is not the same as another.
Allows for easy manipulation of Illustrator text paragraph features.
Definition: hdicoreTextParaFeatures.h:27
virtual bool isEmpty() const
Gets whether the target TextParaFeatures object is empty.
virtual bool preHyphenSize(int32_t &size__) const
Retrieves the pre-hyphen size attribute of this paragraph.
virtual void clearLeadingType()
Removes the local leading type attribute value of this paragraph.
virtual bool operator==(const TextParaFeatures &rhs_) const
Tests whether a given TextParaFeatures object is the same as another.
virtual void setHyphenatedWordSize(const int32_t size_)
Sets the local hyphenated word size attribute of this paragraph.
virtual void setFirstLineIndent(const double indent_)
Sets the local first-line indent attribute of this paragraph.
virtual bool consecutiveHyphenLimit(int32_t &limit__) const
Retrieves the consecutive hyphen limit attribute of this paragraph.
Definition: hdicoreaiArray.h:12
virtual void setAutoLeadingPercentage(const double perc_)
Sets the local automatic leading percentage attribute of this paragraph.
virtual bool maxGlyphScaling(double &scale__) const
Retrieves the maximum glyph scaling attribute of this paragraph.
virtual void setTabStops(const TextTabStopSet &stops_)
Sets the local tab stops attribute of this paragraph.
virtual bool hyphenationPreference(double &pref__) const
Retrieves the hyphenation preference attribute of this paragraph.
virtual bool defaultTabWidth(double &width__) const
Retrieves the default tab width attribute of this paragraph.
TextParaFeatures()
Creates a new TextParaFeatures object.
virtual bool everyLineComposer(bool &comp__) const
Retrieves the every-line composer attribute of this paragraph.
virtual void setAutoHyphenate(const bool hyphen_)
Sets the local automatic hyphenation attribute of this paragraph.
virtual void clearLetterSpacing()
Removes all of the local letter spacing attribute values of this paragraph.
virtual void setHyphenateCapitalized(const bool cap_)
Sets the local hyphenation capitalized attribute of this paragraph.
virtual void clearSpaceBefore()
Removes the local line space before attribute value of this paragraph.
virtual bool spaceBefore(double &space__) const
Retrieves the line space before attribute of this paragraph.
virtual void clearGlyphScaling()
Removes all of the local glyph scaling attribute values of this paragraph.
virtual void clearHyphenateCapitalized()
Removes the local hyphenate capitalized attribute value of this paragraph.
virtual void setEndIndent(const double indent_)
Sets the local end indent attribute of this paragraph.
virtual bool singleWordJustification(ParagraphJustification &just__) const
Retrieves the single-word justification attribute of this paragraph.
virtual void setLeadingType(const LeadingType type_)
Sets the local leading type attribute of this paragraph.
virtual void setMaxGlyphScaling(const double scale_)
Sets the local maximum glyph scaling attribute of this paragraph.
virtual void clearAutoLeadingPercentage()
Removes the local automatic leading percentage attribute value of this paragraph. ...
virtual void setPreHyphenSize(const int32_t size_)
Sets the local pre-hyphen size attribute of this paragraph.
virtual void setMinGlyphScaling(const double scale_)
Sets the local minimum glyph scaling attribute of this paragraph.
virtual bool minWordSpacing(double &space__) const
Retrieves the minimum word spacing attribute of this paragraph.
virtual bool hyphenateCapitalized(bool &cap__) const
Retrieves the hyphenation capitalization attribute of this paragraph.
virtual std::auto_ptr< ATE::IParaFeatures > ateParaFeatures() const
Gets the ATE paragraph features ref around which the target object is wrapped.
virtual bool defaultCharFeatures(TextCharFeatures &feat__) const
Retrieves the default character features attribute of this paragraph.
virtual void clearHyphenationZone()
Removes the local hyphenation zone attribute value of this paragraph.