#include <ISectionCmdData.h>
|
| enum | { kDefaultIID = IID_ISECTIONCMDDATA } |
| |
Data interface for the NewSectionCmd (kNewSectionCmdBoss) and ModifySectionSettingsCmd (kModifySectionSettingsCmdBoss) Also used as data interface for the SetSectionPaginationOptions (kSetSectionPaginationOptionsBoss).
- See Also
- ISection.h
| virtual void ISectionCmdData::CopyFrom | ( | ISection * | section | ) | |
| pure virtual |
Set the data from an existing section. Can be useful for copying one section into another, or to set all the data fields for the kModifySectionSettingsCmdBoss at once.
| virtual bool16 ISectionCmdData::GetContinueFromPrevSection | ( | | ) | |
| pure virtual |
Does this section continue numbering from the previous section?
- Returns
- bool16 kTrue if section continues numbering from previous section, kFalse otherwise.
| virtual const PMString& ISectionCmdData::GetMarker | ( | | ) | |
| pure virtual |
Get the name of the section marker, can be used on the page as a special character, kTextChar_SectionName.
- Returns
- const PMString& the marker
| virtual const PMString& ISectionCmdData::GetName | ( | | ) | |
| pure virtual |
Get the name of the section (the prefix).
- Returns
- const PMString& the prefix name
| virtual const PMString& ISectionCmdData::GetNamedLayout | ( | | ) | |
| pure virtual |
Get the name of the named layout.
- Returns
- const PMString& the layout name
| virtual const bool16& ISectionCmdData::GetNotifyFlag | ( | | ) | |
| pure virtual |
Get function for notification flag for kSetModifySectionSettingsCmdBoss.
- Returns
- const bool16& kTrue to notify, kFalse to skip notification.
| virtual int32 ISectionCmdData::GetOffsetFromPrevSection | ( | | ) | |
| pure virtual |
Return the offset value for numbering from previous section. Used when GetContinueFromPrevSection is kTrue.
- Returns
- int32
| virtual const bool16& ISectionCmdData::GetPageNumberIncludeSectionPrefix | ( | | ) | |
| pure virtual |
Do page number characters in this section include the prefix string. Used for page number characters that are present into a document story.
- Returns
- const bool16& kTrue if prefix is prepending to page number, kFalse otherwise.
- See Also
- ITextEditSuite::kThisPage
| virtual UID ISectionCmdData::GetPaginationMaster | ( | | ) | |
| pure virtual |
Return the master from the command to use when pages are added when doing HTML5 pagination.
- Returns
- UID, either a UID of a specific master spread, or kInvalidUID when masters are being automatically applied.
- See Also
- kSetSectionPaginationOptionsCmdBoss
Return the pagination option for adding and removing pages from the command–used when doing HTML5 pagination.
- Returns
- PaginationOption, one of the values from this enum
- See Also
- ISection.h for enum values
- kSetSectionPaginationOptionsCmdBoss
| virtual const UIDRef& ISectionCmdData::GetSectionList | ( | | ) | |
| pure virtual |
Get function to return the section list.
- Returns
- const UIDRef& a reference to the section list.
| virtual int32 ISectionCmdData::GetStartPageNumber | ( | | ) | |
| pure virtual |
Get the starting page number of the section. Ranges from kMinPageNumber to kMaxPageNumber.
- Returns
- int32
| virtual UID ISectionCmdData::GetStartPageUID | ( | | ) | |
| pure virtual |
Get function for the starting page of a section (UID of kPageBoss).
- Returns
- UID the UID for the starting page of the section.
| virtual void ISectionCmdData::GetStyleInfo | ( | ClassID * | styleProviderClassID | ) | |
| pure virtual |
Return the ClassID for the page numbering style. kInvalidClass means to use kArabicPageNumberingStyleServiceBoss.
- Parameters
| styleProviderClassID* | IN/OUT will be filled in by the ClassID of the page numbering style. |
- See Also
- kService_PageNumberingStyles
| virtual void ISectionCmdData::Set | ( | const UIDRef & | sectionList, | | | UID | startPageUID = kInvalidUID, | | | int32 | startPageNumber = 1, | | | const PMString * | name = nil, | | | const PMString * | marker = nil, | | | ClassID | styleProviderClassID = kInvalidClass, | | | bool16 | bContinueFromPrevSection = kTrue, | | | int32 | offsetFromPrevSection = 0 | | ) | | |
| pure virtual |
Set up the values for creating a new section via the kNewSectionCmdBoss.
- Parameters
| sectionList | a reference to the section list to create a new section or modify. The ISectionList interface is on the kDocBoss. |
| startPageUID | which page should the section start on, or which section to modify. kInvalidUID is the value for the default section associated with the first page of every document. |
| startPageNumber | the starting page number for the section |
| name | pointer to PMString, name/prefix of section. Used for page number specification. Must be unique (or empty). |
| marker,pointer | to PMString, text for section marker. Used when a section marker is inserted on page. |
| styleProviderClassID,the | ClassID for the page numbering style. kInvalidClass means to use kArabicPageNumberingStyleServiceBoss. |
| bContinueFromPrevSection,bool16 | kTrue if section continues numbering from previous section, kFalse otherwise. |
| offsetFromPrevSection,int32 | offset value for numbering from previous section. Used when GetContinueFromPrevSection is kTrue. |
| virtual void ISectionCmdData::SetNamedLayout | ( | const PMString * | pNamedLayout | ) | |
| pure virtual |
Set the name of the named layout.
- Parameters
| pNamedLayout | pointer to PMString, page layout name. Used for alternate/named layouts. Must be unique (or empty). |
| virtual void ISectionCmdData::SetNotifyFlag | ( | const bool16 & | notify = kTrue | ) | |
| pure virtual |
In general, INTERNAL USE only. Set a flag for kModifySectionSettingsCmdBoss to notify or not.
- Parameters
| kTrue | to notify, kFalse to skip notification. |
| virtual void ISectionCmdData::SetPageNumberIncludeSectionPrefix | ( | const bool16 & | includeSectionPrefix | ) | |
| pure virtual |
Set whether this function includes prefix in page number strings.
- Parameters
| includeSectionPrefix,kTrue | to include prefix, kFalse to just use the page number. |
| virtual void ISectionCmdData::SetPaginationMaster | ( | UID | masterUID | ) | |
| pure virtual |
Set the master page for the command to use when pages are added when doing HTML5 pagination.
- Parameters
| UID,the | UID of a specific master spread, or kInvalidUID to automatically apply a master page. |
- See Also
- kSetSectionPaginationOptionsCmdBoss
Set the pagination option for the command for how pages are added and removed when doing HTML5 pagination.
- Parameters
| PaginationOption,one | of the values from this enum |
- See Also
- ISection.h for enum values
- kSetSectionPaginationOptionsCmdBoss
| virtual void ISectionCmdData::SetStartPageUID | ( | const UID | startPageUID | ) | |
| pure virtual |
Set the starting page for the section.
- Parameters
| startPageUID | the starting page UID for the section. |
Public Member Functions inherited from IPMUnknown
1.8.3.1 
