An action class that specifies adding watermark.
More...
#include <src/api/mip/upe/add_watermark_action.h>
|
virtual const std::string & | GetFontColor () const =0 |
| Get the font color used to display the watermark.
|
|
virtual const std::string & | GetFontName () const =0 |
| Get the font name used to display the watermark.
|
|
virtual int | GetFontSize () const =0 |
| Get the font size used to display the watermark.
|
|
virtual WatermarkLayout | GetLayout () const =0 |
| An API used to get the water mark layout.
|
|
virtual const std::string & | GetText () const =0 |
| Get the text that is meant to go into the watermark.
|
|
virtual ActionType | GetType () const =0 |
| Get the type of Action.
|
|
virtual const std::string & | GetUIElementName ()=0 |
| An API used to mark the watermark element.
|
|
An action class that specifies adding watermark.
Definition at line 46 of file add_watermark_action.h.
◆ GetFontColor()
virtual const std::string & AddWatermarkAction::GetFontColor |
( |
| ) |
const |
|
pure virtual |
Get the font color used to display the watermark.
- Returns
- font color as a string (for example, "#000000").
◆ GetFontName()
virtual const std::string & AddWatermarkAction::GetFontName |
( |
| ) |
const |
|
pure virtual |
Get the font name used to display the watermark.
- Returns
- Font name. Default value is Calibri if nothing is set by the policy.
◆ GetFontSize()
virtual int AddWatermarkAction::GetFontSize |
( |
| ) |
const |
|
pure virtual |
Get the font size used to display the watermark.
- Returns
- font size as an integer.
◆ GetLayout()
An API used to get the water mark layout.
- Returns
- WatermarkLayout the watermarking layout in th form of an enum HORIZONTAL|DIAGONAL. ,
◆ GetText()
virtual const std::string & AddWatermarkAction::GetText |
( |
| ) |
const |
|
pure virtual |
Get the text that is meant to go into the watermark.
- 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 & AddWatermarkAction::GetUIElementName |
( |
| ) |
|
|
pure virtual |
An API used to mark the watermark element.
- Returns
- the name that should be used for the UI element that holds the watermark. The same name will be returned in RemoveWatermarkingAction in case the watermark needs to be removed.
The documentation for this class was generated from the following file: