Hot Door CORE 0.8.4
Adobe® Illustrator® Plug-in Library
Loading...
Searching...
No Matches
hdicoreTextParaFeatures.h
Go to the documentation of this file.
1
6
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
68
77 virtual bool operator==(const TextParaFeatures& rhs_) const;
78
87 virtual bool operator!=(const TextParaFeatures& rhs_) const;
88
100 virtual std::unique_ptr<ATE::IParaFeatures> ateParaFeatures() const;
101
109 virtual bool isEmpty() const;
110
118 virtual std::unique_ptr<TextParaFeatures> duplicate() const;
119
128 virtual bool justification(ParagraphJustification& just__) const;
129
138 virtual bool firstLineIndent(double& indent__) const;
139
148 virtual bool startIndent(double& indent__) const;
149
158 virtual bool endIndent(double& indent__) const;
159
168 virtual bool spaceBefore(double& space__) const;
169
178 virtual bool spaceAfter(double& space__) const;
179
189 virtual bool autoHyphenate(bool& hyphen__) const;
190
199 virtual bool hyphenatedWordSize(int32_t& size__) const;
200
209 virtual bool preHyphenSize(int32_t& size__) const;
210
219 virtual bool postHyphenSize(int32_t& size__) const;
220
229 virtual bool consecutiveHyphenLimit(int32_t& limit__) const;
230
239 virtual bool hyphenationZone(double& zone__) const;
240
250 virtual bool hyphenateCapitalized(bool& cap__) const;
251
260 virtual bool hyphenationPreference(double& pref__) const;
261
270 virtual bool desiredWordSpacing(double& space__) const;
271
280 virtual bool minWordSpacing(double& space__) const;
281
290 virtual bool maxWordSpacing(double& space__) const;
291
300 virtual bool desiredLetterSpacing(double& space__) const;
301
310 virtual bool minLetterSpacing(double& space__) const;
311
320 virtual bool maxLetterSpacing(double& space__) const;
321
330 virtual bool desiredGlyphScaling(double& scale__) const;
331
340 virtual bool minGlyphScaling(double& scale__) const;
341
350 virtual bool maxGlyphScaling(double& scale__) const;
351
361
371 virtual bool autoLeadingPercentage(double& perc__) const;
372
381 virtual bool leadingType(LeadingType& type__) const;
382
391 virtual bool tabStops(TextTabStopSet& stops__) const;
392
401 virtual bool defaultTabWidth(double& width__) const;
402
411 virtual bool everyLineComposer(bool& comp__) const;
412
421 virtual bool defaultCharFeatures(TextCharFeatures& feat__) const;
422
431 virtual bool composerEngine(ComposerEngine& engine__) const;
432
440 virtual void setJustification(const ParagraphJustification just_);
441
449 virtual void setFirstLineIndent(const double indent_);
450
458 virtual void setStartIndent(const double indent_);
459
467 virtual void setEndIndent(const double indent_);
468
476 virtual void setSpaceBefore(const double space_);
477
485 virtual void setSpaceAfter(const double space_);
486
494 virtual void setAutoHyphenate(const bool hyphen_);
495
503 virtual void setHyphenatedWordSize(const int32_t size_);
504
512 virtual void setPreHyphenSize(const int32_t size_);
513
521 virtual void setPostHyphenSize(const int32_t size_);
522
530 virtual void setConsecutiveHyphenLimit(const int32_t limit_);
531
539 virtual void setHyphenationZone(const double zone_);
540
548 virtual void setHyphenateCapitalized(const bool cap_);
549
557 virtual void setHyphenationPreference(const double pref_);
558
566 virtual void setDesiredWordSpacing(const double space_);
567
575 virtual void setMinWordSpacing(const double space_);
576
584 virtual void setMaxWordSpacing(const double space_);
585
593 virtual void setDesiredLetterSpacing(const double space_);
594
602 virtual void setMinLetterSpacing(const double space_);
603
611 virtual void setMaxLetterSpacing(const double space_);
612
620 virtual void setDesiredGlyphScaling(const double scale_);
621
629 virtual void setMinGlyphScaling(const double scale_);
630
638 virtual void setMaxGlyphScaling(const double scale_);
639
648
656 virtual void setAutoLeadingPercentage(const double perc_);
657
665 virtual void setLeadingType(const LeadingType type_);
666
674 virtual void setTabStops(const TextTabStopSet& stops_);
675
683 virtual void setDefaultTabWidth(const double width_);
684
692 virtual void setEveryLineComposer(const bool comp_);
693
701 virtual void setDefaultCharFeatures(const TextCharFeatures& feat_);
702
710 virtual void setComposerEngine(const ComposerEngine engine_);
711
717 virtual void clearJustification();
718
724 virtual void clearFirstLineIndent();
725
731 virtual void clearStartIndent();
732
738 virtual void clearEndIndent();
739
745 virtual void clearSpaceBefore();
746
752 virtual void clearSpaceAfter();
753
759 virtual void clearAutoHyphenate();
760
767
773 virtual void clearPreHyphenSize();
774
780 virtual void clearPostHyphenSize();
781
788
794 virtual void clearHyphenationZone();
795
802
809
815 virtual void clearWordSpacing();
816
822 virtual void clearLetterSpacing();
823
829 virtual void clearGlyphScaling();
830
837
844
850 virtual void clearLeadingType();
851
857 virtual void clearTabStops();
858
865
872
878 virtual void clearComposerEngine();
879
880
881 private:
882 friend aip::TextParaFeatures* __accessImpl(const TextParaFeatures&);
883 friend TextParaFeatures __accessCtor(const aip::TextParaFeatures&);
884
888 aip::TextParaFeatures* __impl;
889
895 TextParaFeatures(const aip::TextParaFeatures&);
896 };
897
898 typedef std::unique_ptr<TextParaFeatures> TextParaFeaturesUP;
899 typedef std::shared_ptr<TextParaFeatures> TextParaFeaturesSP;
900 typedef std::weak_ptr<TextParaFeatures> TextParaFeaturesWP;
901
902 extern aip::TextParaFeatures* __accessImpl(const TextParaFeatures&);
903 extern TextParaFeatures __accessCtor(const aip::TextParaFeatures&);
904 }
905}
906
907#endif
908// HDI_CORE_AIP_MODE
909
910#endif
911// __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.
Encapsulates tab stop set functionality from the Illustrator SDK.
Definition hdicoreTextTabStopSet.h:29
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