PageLabel.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFPageLabel
#define PDFTRON_H_CPPPDFPageLabel
 
#include <C/PDF/TRN_PageLabel.h>
#include <SDF/SDFDoc.h>
 
namespace pdftron { 
    namespace PDF {

class PageLabel : private TRN_PageLabel
{
public:
 
    // The numbering style to be used for the numeric portion of page label.
    enum Style 
    {
        e_decimal,              
        e_roman_uppercase,      
        e_roman_lowercase,      
        e_alphabetic_uppercase, 
        e_alphabetic_lowercase, 
        e_none                  
    };

    static PageLabel Create(SDF::SDFDoc& doc, Style style, const UString& prefix = "", int start_at = 1);

    PageLabel(SDF::Obj l=0, int first_page=-1, int last_page=-1);

    PageLabel (const PageLabel& d);

    PageLabel& operator=(const PageLabel& d);

    bool operator==(const PageLabel& d);
     
    bool IsValid() const;

    UString GetLabelTitle(int page_num);

    void SetStyle(Style style);

    Style GetStyle() const;
 
    UString GetPrefix() const;
 
    void SetPrefix(const UString& prefix);
    
    int GetStart() const;

    void SetStart(int start_at);

    int GetFirstPageNum();
    
    int GetLastPageNum();

    SDF::Obj GetSDFObj () const;
 
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    PageLabel(const TRN_PageLabel&);
#endif
// @endcond
};
 
 
 
#include <Impl/PageLabel.inl>
 
    };  // namespace PDF
};  // namespace pdftron
 
#endif // PDFTRON_H_CPPPDFPageLabel