Mako 8.2.0 API
MakoCore SDK API Documentation
Loading...
Searching...
No Matches
pagelabels.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2022-2025 Global Graphics Software Ltd. All rights reserved.
3 */
4
5#ifndef JAWSMAKO_PAGELABELS_H
6#define JAWSMAKO_PAGELABELS_H
7
8#include <jawsmako/types.h>
9
10namespace JawsMako
11{
12 using namespace EDL;
13
19 class IPageLabel : public IRCObject
20 {
21 public:
22 virtual ~IPageLabel() {}
23
29 static JAWSMAKO_API IPageLabelPtr create(const IJawsMakoPtr &jawsMako);
30
43
50 virtual eLabelStyle getStyle() = 0;
51
56 virtual void setStyle(eLabelStyle style) = 0;
57
64 virtual U8String getPrefix() = 0;
65
70 virtual void setPrefix(const U8String &prefix) = 0;
71
78 virtual uint32 getNumber() = 0;
79
84 virtual void setNumber(uint32 number) = 0;
85
90 virtual IPageLabelPtr clone() = 0;
91 };
92}
93#endif /* JAWSMAKO_PAGELABELS_H */
Base class Interface for all Reference Counted objects.
Definition ircobject.h:35
Interface class representing a PDF page label.
Definition pagelabels.h:20
virtual ~IPageLabel()
Definition pagelabels.h:22
static JAWSMAKO_API IPageLabelPtr create(const IJawsMakoPtr &jawsMako)
Create an IPageLabel.
virtual eLabelStyle getStyle()=0
Get the page label numbering style. Returns the numbering style to be used for the numeric portion of...
virtual uint32 getNumber()=0
Get the page label number. Returns the value of the numeric portion to be used for the page label....
virtual void setStyle(eLabelStyle style)=0
Set the page label numbering style.
virtual void setPrefix(const U8String &prefix)=0
Set the page label prefix.
virtual IPageLabelPtr clone()=0
Clone the page label.
virtual void setNumber(uint32 number)=0
Set the page label number.
eLabelStyle
Page label numbering styles.
Definition pagelabels.h:35
@ eLetterLowercase
Lowercase letters.
Definition pagelabels.h:41
@ eRomanUppercase
Uppercase Roman Numerals.
Definition pagelabels.h:38
@ eNone
No style.
Definition pagelabels.h:36
@ eRomanLowercase
Lowercase Roman Numerals.
Definition pagelabels.h:39
@ eLetterUppercase
Uppercase letters.
Definition pagelabels.h:40
@ eDecimal
Decimal Arabic Numerals.
Definition pagelabels.h:37
virtual U8String getPrefix()=0
Get the page label prefix. Returns the prefix to be used for the page label. The default is an empty ...
unsigned int uint32
Definition edltypes.h:34
EDLSysString U8String
A UTF-8 String.
Definition types.h:144
Definition apexcustompostprocess.h:17
#define JAWSMAKO_API
Definition types.h:29