All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pdftron::Layout::PageNumber Class Reference

#include <ContentTree.h>

+ Inheritance diagram for pdftron::Layout::PageNumber:

Public Types

enum  NumberType { e_current_page = 1, e_total_pages = 2 }
 
enum  NumberFormat {
  e_lower_roman = 2, e_upper_roman = 3, e_lower_letter = 4, e_upper_letter = 5,
  e_ordinal = 6, e_ordinal_text = 7, e_chinese_counting = 8, e_chinese_counting_thousand = 9,
  e_cardinal_text = 10, e_decimal_zero = 11, e_decimal_double_zero = 12, e_decimal_triple_zero = 13,
  e_decimal_quadruple_zero = 14, e_arabic_alpha = 15, e_arabic_abjad = 16, e_decimal_enclosed_circle_limit_10 = 17,
  e_decimal_enclosed_circle_limit_20 = 18, e_decimal_with_fullstop_limit_20 = 19, e_decimal_parenthesized_limit_20 = 20, e_decimal_full_width = 21,
  e_taiwanese_counting = 22, e_taiwanese_digital = 23, e_taiwanese_counting_thousand = 24, e_japanese_counting = 25,
  e_japanese_legal = 26, e_japanese_digital_ten_thousand = 27, e_korean_digital = 28, e_korean_counting = 29,
  e_korean_legal = 30, e_korean_digital_2 = 31, e_thai_letters = 32, e_thai_numbers = 33,
  e_thai_counting = 34, e_vietnamese_counting = 35, e_russian_lower = 36, e_russian_upper = 37,
  e_hebrew_1 = 38, e_hebrew_2 = 39, e_hindi_vowels = 40, e_hindi_consonants = 41,
  e_hindi_numbers = 42, e_hindi_counting = 43, e_ideograph_legal_traditional = 44, e_ideograph_traditional = 45,
  e_ideograph_zodiac = 46, e_ideograph_digital = 47, e_ideograph_zodiac_traditional = 48, e_chinese_legal_simplified = 49
}
 

Public Member Functions

NumberType GetNumberType ()
 
void SetNumberType (NumberType type)
 
NumberFormat GetNumberFormat ()
 
void SetNumberFormat (NumberFormat format)
 
- Public Member Functions inherited from pdftron::Layout::ContentElement
 ~ContentElement ()
 
void Destroy ()
 
ElementRef< List > AsList () const
 
ElementRef< ListItem > AsListItem () const
 
ElementRef< ContentNode > AsContentNode () const
 
ElementRef< TextRun > AsTextRun () const
 
ElementRef< PageNumber > AsPageNumber () const
 
ElementRef< Shape > AsShape () const
 
ElementRef< Float > AsFloat () const
 
ElementRef< Chart > AsChart () const
 
ElementRef< Paragraph > AsParagraph () const
 
ElementRef< Table > AsTable () const
 
ElementRef< TableRow > AsTableRow () const
 
ElementRef< TableCell > AsTableCell () const
 
TextStyledElement GetTextStyledElement ()
 

Friends

class Paragraph
 
class ElementRef< PageNumber >
 

Additional Inherited Members

- Public Attributes inherited from pdftron::Layout::ContentElement
TRN_ContentElement m_impl
 
- Protected Member Functions inherited from pdftron::Layout::ContentElement
 ContentElement (TRN_ContentElement impl)
 

Detailed Description

A class representing a dynamic page number element.

Definition at line 767 of file ContentTree.h.

Member Enumeration Documentation

Enumerator
e_lower_roman 
e_upper_roman 
e_lower_letter 
e_upper_letter 
e_ordinal 
e_ordinal_text 
e_chinese_counting 
e_chinese_counting_thousand 
e_cardinal_text 
e_decimal_zero 
e_decimal_double_zero 
e_decimal_triple_zero 
e_decimal_quadruple_zero 
e_arabic_alpha 
e_arabic_abjad 
e_decimal_enclosed_circle_limit_10 
e_decimal_enclosed_circle_limit_20 
e_decimal_with_fullstop_limit_20 
e_decimal_parenthesized_limit_20 
e_decimal_full_width 
e_taiwanese_counting 
e_taiwanese_digital 
e_taiwanese_counting_thousand 
e_japanese_counting 
e_japanese_legal 
e_japanese_digital_ten_thousand 
e_korean_digital 
e_korean_counting 
e_korean_legal 
e_korean_digital_2 
e_thai_letters 
e_thai_numbers 
e_thai_counting 
e_vietnamese_counting 
e_russian_lower 
e_russian_upper 
e_hebrew_1 
e_hebrew_2 
e_hindi_vowels 
e_hindi_consonants 
e_hindi_numbers 
e_hindi_counting 
e_ideograph_legal_traditional 
e_ideograph_traditional 
e_ideograph_zodiac 
e_ideograph_digital 
e_ideograph_zodiac_traditional 
e_chinese_legal_simplified 

Definition at line 781 of file ContentTree.h.

Enumerator
e_current_page 
e_total_pages 

Definition at line 775 of file ContentTree.h.

Member Function Documentation

NumberFormat pdftron::Layout::PageNumber::GetNumberFormat ( )
NumberType pdftron::Layout::PageNumber::GetNumberType ( )
void pdftron::Layout::PageNumber::SetNumberFormat ( NumberFormat  format)
void pdftron::Layout::PageNumber::SetNumberType ( NumberType  type)

Friends And Related Function Documentation

friend class ElementRef< PageNumber >
friend

Definition at line 770 of file ContentTree.h.

friend class Paragraph
friend

Definition at line 769 of file ContentTree.h.


The documentation for this class was generated from the following file: