Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
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#if defined(HDI_CORE_AIP_MODE)
11
12#include "hdicoreTypes.h"
13
14namespace hdi
15{
16 namespace aip
17 {
18 class TextParaFeatures;
19 }
20
21 namespace core
22 {
23 class TextCharFeatures;
24 class TextTabStopSet;
25
30 {
31 public:
42
51
58
65
74 virtual bool operator==(const TextParaFeatures& rhs_) const;
75
84 virtual bool operator!=(const TextParaFeatures& rhs_) const;
85
97 virtual std::unique_ptr<ATE::IParaFeatures> ateParaFeatures() const;
98
106 virtual bool isEmpty() const;
107
115 virtual std::unique_ptr<TextParaFeatures> duplicate() const;
116
125 virtual bool justification(ParagraphJustification& just__) const;
126
135 virtual bool firstLineIndent(double& indent__) const;
136
145 virtual bool startIndent(double& indent__) const;
146
155 virtual bool endIndent(double& indent__) const;
156
165 virtual bool spaceBefore(double& space__) const;
166
175 virtual bool spaceAfter(double& space__) const;
176
186 virtual bool autoHyphenate(bool& hyphen__) const;
187
196 virtual bool hyphenatedWordSize(int32_t& size__) const;
197
206 virtual bool preHyphenSize(int32_t& size__) const;
207
216 virtual bool postHyphenSize(int32_t& size__) const;
217
226 virtual bool consecutiveHyphenLimit(int32_t& limit__) const;
227
236 virtual bool hyphenationZone(double& zone__) const;
237
247 virtual bool hyphenateCapitalized(bool& cap__) const;
248
257 virtual bool hyphenationPreference(double& pref__) const;
258
267 virtual bool desiredWordSpacing(double& space__) const;
268
277 virtual bool minWordSpacing(double& space__) const;
278
287 virtual bool maxWordSpacing(double& space__) const;
288
297 virtual bool desiredLetterSpacing(double& space__) const;
298
307 virtual bool minLetterSpacing(double& space__) const;
308
317 virtual bool maxLetterSpacing(double& space__) const;
318
327 virtual bool desiredGlyphScaling(double& scale__) const;
328
337 virtual bool minGlyphScaling(double& scale__) const;
338
347 virtual bool maxGlyphScaling(double& scale__) const;
348
358
368 virtual bool autoLeadingPercentage(double& perc__) const;
369
378 virtual bool leadingType(LeadingType& type__) const;
379
388 virtual bool tabStops(TextTabStopSet& stops__) const;
389
398 virtual bool defaultTabWidth(double& width__) const;
399
408 virtual bool everyLineComposer(bool& comp__) const;
409
418 virtual bool defaultCharFeatures(TextCharFeatures& feat__) const;
419
428 virtual bool composerEngine(ComposerEngine& engine__) const;
429
437 virtual void setJustification(const ParagraphJustification just_);
438
446 virtual void setFirstLineIndent(const double indent_);
447
455 virtual void setStartIndent(const double indent_);
456
464 virtual void setEndIndent(const double indent_);
465
473 virtual void setSpaceBefore(const double space_);
474
482 virtual void setSpaceAfter(const double space_);
483
491 virtual void setAutoHyphenate(const bool hyphen_);
492
500 virtual void setHyphenatedWordSize(const int32_t size_);
501
509 virtual void setPreHyphenSize(const int32_t size_);
510
518 virtual void setPostHyphenSize(const int32_t size_);
519
527 virtual void setConsecutiveHyphenLimit(const int32_t limit_);
528
536 virtual void setHyphenationZone(const double zone_);
537
545 virtual void setHyphenateCapitalized(const bool cap_);
546
554 virtual void setHyphenationPreference(const double pref_);
555
563 virtual void setDesiredWordSpacing(const double space_);
564
572 virtual void setMinWordSpacing(const double space_);
573
581 virtual void setMaxWordSpacing(const double space_);
582
590 virtual void setDesiredLetterSpacing(const double space_);
591
599 virtual void setMinLetterSpacing(const double space_);
600
608 virtual void setMaxLetterSpacing(const double space_);
609
617 virtual void setDesiredGlyphScaling(const double scale_);
618
626 virtual void setMinGlyphScaling(const double scale_);
627
635 virtual void setMaxGlyphScaling(const double scale_);
636
645
653 virtual void setAutoLeadingPercentage(const double perc_);
654
662 virtual void setLeadingType(const LeadingType type_);
663
671 virtual void setTabStops(const TextTabStopSet& stops_);
672
680 virtual void setDefaultTabWidth(const double width_);
681
689 virtual void setEveryLineComposer(const bool comp_);
690
698 virtual void setDefaultCharFeatures(const TextCharFeatures& feat_);
699
707 virtual void setComposerEngine(const ComposerEngine engine_);
708
714 virtual void clearJustification();
715
721 virtual void clearFirstLineIndent();
722
728 virtual void clearStartIndent();
729
735 virtual void clearEndIndent();
736
742 virtual void clearSpaceBefore();
743
749 virtual void clearSpaceAfter();
750
756 virtual void clearAutoHyphenate();
757
764
770 virtual void clearPreHyphenSize();
771
777 virtual void clearPostHyphenSize();
778
785
791 virtual void clearHyphenationZone();
792
799
806
812 virtual void clearWordSpacing();
813
819 virtual void clearLetterSpacing();
820
826 virtual void clearGlyphScaling();
827
834
841
847 virtual void clearLeadingType();
848
854 virtual void clearTabStops();
855
862
869
875 virtual void clearComposerEngine();
876
877
878 private:
879 friend aip::TextParaFeatures* __accessImpl(const TextParaFeatures&);
880 friend TextParaFeatures __accessCtor(const aip::TextParaFeatures&);
881
885 aip::TextParaFeatures* __impl;
886
892 TextParaFeatures(const aip::TextParaFeatures&);
893 };
894
895 typedef std::unique_ptr<TextParaFeatures> TextParaFeaturesUP;
896 typedef std::shared_ptr<TextParaFeatures> TextParaFeaturesSP;
897 typedef std::weak_ptr<TextParaFeatures> TextParaFeaturesWP;
898
899 extern aip::TextParaFeatures* __accessImpl(const TextParaFeatures&);
900 extern TextParaFeatures __accessCtor(const aip::TextParaFeatures&);
901 }
902}
903
904#endif
905// HDI_CORE_AIP_MODE
906
907#endif
908// __HDI_CORE_TEXT_PARA_FEATURES__
Allows for easy manipulation of Illustrator text character features.
Definition: hdicoreTextCharFeatures.h:34
Allows for easy manipulation of Illustrator text paragraph features.
Definition: hdicoreTextParaFeatures.h:30
virtual bool tabStops(TextTabStopSet &stops__) const
Retrieves the tab stops attribute of this paragraph.
virtual void clearJustification()
Removes the local justification attribute value of this paragraph.
virtual bool hyphenationZone(double &zone__) const
Retrieves the hyphenation zone attribute of this paragraph.
virtual void clearEveryLineComposer()
Removes the local every-line composer attribute value of this paragraph.
virtual void clearFirstLineIndent()
Removes the local first-line indent attribute value of this paragraph.
virtual void setHyphenatedWordSize(const int32_t size_)
Sets the local hyphenated word size attribute of this paragraph.
virtual bool spaceAfter(double &space__) const
Retrieves the line space after attribute of this paragraph.
virtual bool isEmpty() const
Gets whether the target TextParaFeatures object is empty.
virtual void setHyphenationPreference(const double pref_)
Sets the local hyphenation preference attribute of this paragraph.
virtual void setSpaceAfter(const double space_)
Sets the local line space after attribute of this paragraph.
virtual void setMaxLetterSpacing(const double space_)
Sets the local maximum letter spacing attribute of this paragraph.
virtual ~TextParaFeatures()
Destructs a TextParaFeatures object.
virtual bool maxWordSpacing(double &space__) const
Retrieves the maximum word spacing attribute of this paragraph.
virtual void setStartIndent(const double indent_)
Sets the local start indent attribute of this paragraph.
virtual void setJustification(const ParagraphJustification just_)
Sets the local justification attribute of this paragraph.
virtual void setPreHyphenSize(const int32_t size_)
Sets the local pre-hyphen size attribute of this paragraph.
virtual bool preHyphenSize(int32_t &size__) const
Retrieves the pre-hyphen size attribute of this paragraph.
virtual void setSpaceBefore(const double space_)
Sets the local line space before attribute of this paragraph.
virtual void clearHyphenatedWordSize()
Removes the local hyphenation word size attribute value of this paragraph.
virtual bool everyLineComposer(bool &comp__) const
Retrieves the every-line composer attribute of this paragraph.
virtual bool minWordSpacing(double &space__) const
Retrieves the minimum word spacing attribute of this paragraph.
virtual void clearPreHyphenSize()
Removes the local pre-hyphen size attribute value of this paragraph.
virtual void setEndIndent(const double indent_)
Sets the local end indent attribute of this paragraph.
virtual bool maxLetterSpacing(double &space__) const
Retrieves the maximum letter spacing attribute of this paragraph.
virtual bool leadingType(LeadingType &type__) const
Retrieves the leading type attribute of this paragraph.
virtual void clearGlyphScaling()
Removes all of the local glyph scaling attribute values of this paragraph.
virtual bool operator!=(const TextParaFeatures &rhs_) const
Tests whether a given TextParaFeatures object is not the same as another.
virtual bool autoHyphenate(bool &hyphen__) const
Retrieves the automatic hyphenation attribute of this paragraph.
virtual void clearAutoHyphenate()
Removes the local automatic hyphenation attribute value of this paragraph.
virtual void setMinLetterSpacing(const double space_)
Sets the local minimum letter spacing attribute of this paragraph.
virtual void clearStartIndent()
Removes the local start indent attribute value of this paragraph.
virtual bool justification(ParagraphJustification &just__) const
Retrieves the justification attribute of this paragraph.
virtual bool firstLineIndent(double &indent__) const
Retrieves the first-line indent attribute of this paragraph.
virtual void setFirstLineIndent(const double indent_)
Sets the local first-line indent attribute of this paragraph.
virtual void setMaxGlyphScaling(const double scale_)
Sets the local maximum glyph scaling attribute of this paragraph.
virtual void clearSingleWordJustification()
Removes the local single-word justification attribute value of this paragraph.
virtual bool postHyphenSize(int32_t &size__) const
Retrieves the post-hyphen size attribute of this paragraph.
virtual void clearPostHyphenSize()
Removes the local post-hyphen size attribute value of this paragraph.
virtual void clearDefaultCharFeatures()
Removes the local default character features attribute value of this paragraph.
virtual void setMaxWordSpacing(const double space_)
Sets the local maximum word spacing attribute of this paragraph.
virtual void clearSpaceAfter()
Removes the local line space after attribute value of this paragraph.
virtual bool desiredWordSpacing(double &space__) const
Retrieves the desired word spacing attribute of this paragraph.
virtual void clearConsecutiveHyphenLimit()
Removes the local consecutive hyphen limit attribute value of this paragraph.
virtual TextParaFeatures & operator=(const TextParaFeatures &rhs_)
Overloaded assignment operator for TextParaFeatures objects.
virtual bool defaultTabWidth(double &width__) const
Retrieves the default tab width attribute of this paragraph.
virtual void clearWordSpacing()
Removes all of the local word spacing attribute values of this paragraph.
virtual bool defaultCharFeatures(TextCharFeatures &feat__) const
Retrieves the default character features attribute of this paragraph.
virtual bool consecutiveHyphenLimit(int32_t &limit__) const
Retrieves the consecutive hyphen limit attribute of this paragraph.
virtual std::unique_ptr< ATE::IParaFeatures > ateParaFeatures() const
Gets the ATE paragraph features ref around which the target object is wrapped.
virtual void clearSpaceBefore()
Removes the local line space before attribute value of this paragraph.
virtual bool hyphenatedWordSize(int32_t &size__) const
Retrieves the hyphenation word size attribute of this paragraph.
virtual void setHyphenationZone(const double zone_)
Sets the local hyphenation zone attribute of this paragraph.
virtual void setMinGlyphScaling(const double scale_)
Sets the local minimum glyph scaling attribute of this paragraph.
virtual void setDesiredGlyphScaling(const double scale_)
Sets the local desired glyph scaling attribute of this paragraph.
virtual void setLeadingType(const LeadingType type_)
Sets the local leading type attribute of this paragraph.
virtual void setAutoLeadingPercentage(const double perc_)
Sets the local automatic leading percentage attribute of this paragraph.
virtual bool spaceBefore(double &space__) const
Retrieves the line space before attribute of this paragraph.
virtual void clearAutoLeadingPercentage()
Removes the local automatic leading percentage attribute value of this paragraph.
virtual void clearLetterSpacing()
Removes all of the local letter spacing attribute values of this paragraph.
virtual void clearHyphenateCapitalized()
Removes the local hyphenate capitalized attribute value of this paragraph.
virtual void setHyphenateCapitalized(const bool cap_)
Sets the local hyphenation capitalized attribute of this paragraph.
virtual void clearLeadingType()
Removes the local leading type attribute value of this paragraph.
virtual bool startIndent(double &indent__) const
Retrieves the paragraph start indent attribute of this paragraph.
virtual void setDesiredWordSpacing(const double space_)
Sets the local desired word spacing attribute of this paragraph.
virtual void clearTabStops()
Removes the local tab stops attribute value of this paragraph.
virtual void setComposerEngine(const ComposerEngine engine_)
Sets the composer engine attribute of this paragraph.
TextParaFeatures()
Creates a new TextParaFeatures object.
virtual bool autoLeadingPercentage(double &perc__) const
Retrieves the automatic leading percentage attribute of this paragraph.
virtual bool hyphenateCapitalized(bool &cap__) const
Retrieves the hyphenation capitalization attribute of this paragraph.
virtual void clearEndIndent()
Removes the local end indent attribute value of this paragraph.
virtual void clearHyphenationZone()
Removes the local hyphenation zone attribute value of this paragraph.
virtual void clearComposerEngine()
Removes the composer engine attribute value of this paragraph.
virtual void setMinWordSpacing(const double space_)
Sets the local minimum word spacing attribute of this paragraph.
virtual std::unique_ptr< TextParaFeatures > duplicate() const
Duplicates the target object.
virtual bool minGlyphScaling(double &scale__) const
Retrieves the minimum glyph scaling attribute of this paragraph.
virtual bool endIndent(double &indent__) const
Retrieves the paragraph end indent attribute of this paragraph.
virtual void setDesiredLetterSpacing(const double space_)
Sets the local desired letter spacing attribute of this paragraph.
virtual bool operator==(const TextParaFeatures &rhs_) const
Tests whether a given TextParaFeatures object is the same as another.
virtual void setPostHyphenSize(const int32_t size_)
Sets the local post-hyphen size attribute of this paragraph.
virtual void setSingleWordJustification(const ParagraphJustification just_)
Sets the local single-word justification attribute of this paragraph.
virtual void setTabStops(const TextTabStopSet &stops_)
Sets the local tab stops attribute of this paragraph.
virtual bool maxGlyphScaling(double &scale__) const
Retrieves the maximum glyph scaling attribute of this paragraph.
virtual bool singleWordJustification(ParagraphJustification &just__) const
Retrieves the single-word justification attribute of this paragraph.
virtual void setConsecutiveHyphenLimit(const int32_t limit_)
Sets the local consecutive hyphen limit attribute of this paragraph.
virtual bool minLetterSpacing(double &space__) const
Retrieves the minimum letter spacing attribute of this paragraph.
virtual void setAutoHyphenate(const bool hyphen_)
Sets the local automatic hyphenation attribute of this paragraph.
virtual bool desiredLetterSpacing(double &space__) const
Retrieves the desired letter spacing attribute of this paragraph.
virtual bool hyphenationPreference(double &pref__) const
Retrieves the hyphenation preference attribute of this paragraph.
virtual void setDefaultCharFeatures(const TextCharFeatures &feat_)
Sets the local default character features attribute of this paragraph.
virtual bool desiredGlyphScaling(double &scale__) const
Retrieves the desired glyph scaling attribute of this paragraph.
virtual bool composerEngine(ComposerEngine &engine__) const
Retrieves the composer engine attribute of this paragraph.
TextParaFeatures(const TextParaFeatures &pf_)
TextParaFeatures copy constructor.
virtual void setDefaultTabWidth(const double width_)
Sets the local default tab width attribute of this paragraph.
virtual void clearHyphenationPreference()
Removes the local hyphenation preference attribute value of this paragraph.
virtual void setEveryLineComposer(const bool comp_)
Sets the local every-line composer attribute of this paragraph.
Definition: hdicoreTextTabStopSet.h:26
Header file for a wide variety of necessary typedefs, enums, and forwards declarations.
ParagraphJustification
Indicates how text should be justified for a text art object.
Definition: hdicoreTypes.h:377
LeadingType
Indicates the leading of some text.
Definition: hdicoreTypes.h:402
ComposerEngine
Indicates the composer engine of some text.
Definition: hdicoreTypes.h:412