An action class that specifies adding content header.
More...
#include <src/api/mip/upe/add_content_header_action.h>
|
virtual ContentMarkAlignment | GetAlignment () const =0 |
| Get the alignment of the header.
|
|
virtual const std::string & | GetFontColor () const =0 |
| Get the font color used to display the content header.
|
|
virtual const std::string & | GetFontName () const =0 |
| Get the font name used to display the content header.
|
|
virtual int | GetFontSize () const =0 |
| Get the font size used to display the content header.
|
|
virtual int | GetMargin () const =0 |
| Get the margin of the header from the bottom.
|
|
virtual const std::string & | GetText () const =0 |
| Get the text that is meant to go into the content header.
|
|
virtual ActionType | GetType () const =0 |
| Get the type of Action.
|
|
virtual const std::string & | GetUIElementName ()=0 |
| An API used to mark the content header element.
|
|
An action class that specifies adding content header.
Definition at line 46 of file add_content_header_action.h.
◆ GetAlignment()
Get the alignment of the header.
- Returns
- The ContentMarkAlignment enumerator: LEFT|RIGHT|CENTER.
- See also
- ContentMarkAlignment
◆ GetFontColor()
virtual const std::string & AddContentHeaderAction::GetFontColor |
( |
| ) |
const |
|
pure virtual |
Get the font color used to display the content header.
- Returns
- font color as a string (for example, #000000").
◆ GetFontName()
virtual const std::string & AddContentHeaderAction::GetFontName |
( |
| ) |
const |
|
pure virtual |
Get the font name used to display the content header.
- Returns
- Font name. Default value is Calibri if nothing is set by the policy.
◆ GetFontSize()
virtual int AddContentHeaderAction::GetFontSize |
( |
| ) |
const |
|
pure virtual |
Get the font size used to display the content header.
- Returns
- font size as an integer.
◆ GetMargin()
virtual int AddContentHeaderAction::GetMargin |
( |
| ) |
const |
|
pure virtual |
Get the margin of the header from the bottom.
- Returns
- the margins from the bottom of the document (for example, 10 mm).
◆ GetText()
virtual const std::string & AddContentHeaderAction::GetText |
( |
| ) |
const |
|
pure virtual |
Get the text that is meant to go into the content header.
- Returns
- content header text.
◆ GetType()
Get the type of Action.
- Returns
- ActionType The type of derived action this base class can be cast to.
◆ GetUIElementName()
virtual const std::string & AddContentHeaderAction::GetUIElementName |
( |
| ) |
|
|
pure virtual |
An API used to mark the content header element.
- Returns
- the name that should be used for the UI element that holds the content header. The same name will be returned in RemoveContentHeaderAction in case the content header needs to be removed.
The documentation for this class was generated from the following file: