|
Foxit PDF SDK
|
Inherits Object.
Public Member Functions | |
| HeaderFooter () | |
| Constructor. | |
| HeaderFooter (const common::Font &font, float text_size, RGB text_color, const PageNumberRange &page_range, RectF page_margin, bool has_text_shrinked, bool has_fixedsize_for_print, int start_page_number, const HeaderFooterContent &content, bool is_to_embed_font, bool is_underline) | |
| Constructor, with parameters. More... | |
| HeaderFooter (const HeaderFooter &other) | |
| Constructor, with another header-footer object. More... | |
| HeaderFooter & | operator= (const HeaderFooter &other) |
| Assign operator. More... | |
| void | Set (const common::Font &font, float text_size, RGB text_color, const PageNumberRange &page_range, RectF page_margin, bool has_text_shrinked, bool has_fixedsize_for_print, int start_page_number, const HeaderFooterContent &content, bool is_to_embed_font, bool is_underline) |
| Set value. More... | |
Public Attributes | |
| HeaderFooterContent | content |
| Header-footer content. | |
| common::Font | font |
| A valid font object which is expected to be used for header-footer content. More... | |
| bool | has_fixedsize_for_print |
| A boolean value that decides whether to use fixed size for print or not. | |
| bool | has_text_shrinked |
| A boolean value that decides whether to shrink text or not. | |
| bool | is_replace_font |
| (Reserved) A boolean value that decides whether to replace font or not. Currently Foxit PDF SDK will use this as true all the time. | |
| bool | is_to_embed_font |
| A boolean value that decides whether to embed font or not. | |
| bool | is_underline |
| A boolean value that decides whether to underline text or not. | |
| RectF | page_margin |
| Page margin which specifies the location for header-footer content. Foxit PDF SDK will use a maring defined as (72.0, 36.0, 72.0, 36.0) as default if no margin value is set by user. More... | |
| PageNumberRange | page_range |
| A page number range object which specifies pages where current header-footer is used. More... | |
| int | start_page_number |
| A virtual page number used for the first page specified in parameter page_range. This can be any number, even different from the actual page number of the specified page. More... | |
| RGB | text_color |
| Text color used for header-footer content. | |
| float | text_size |
| Text size of header-footer content. | |
This class represents properties and data for a header-footer.
|
inlineexplicit |
Constructor, with parameters.
| [in] | font | A valid font object used for header-footer content. Please refer to comment of font of current object. |
| [in] | text_size | Text size of header-footer content. |
| [in] | text_color | Text color used for header-footer content. |
| [in] | page_range | A page number range object which specifies pages where current header-footer is used. Please refer to comment of page_range of current object. |
| [in] | page_margin | Page margin which specifies the location for header-footer content. Please refer to comment of page_margin of current object. |
| [in] | has_text_shrinked | A boolean value that decides whether to shrink text or not. |
| [in] | has_fixedsize_for_print | A boolean value that decides whether to use fixed size for print or not. |
| [in] | start_page_number | A virtual page number used for the first page specified in parameter page_range. This can be any number, even different from the actual page number of the specified page. If this value is less than 1, Foxit PDF SDK will use 1 for this value when current header-footer object is used in a PDF document. |
| [in] | content | Header-footer content. |
| [in] | is_to_embed_font | A boolean value that decides whether to embed font or not. |
| [in] | is_underline | A boolean value that decides whether to underline text or not. |
|
inline |
Constructor, with another header-footer object.
| [in] | other | Another header-footer object. |
|
inline |
Assign operator.
| [in] | other | Another header-footer object, whose value would be assigned to current object. |
|
inline |
Set value.
| [in] | font | A valid font object which is expected to be used for header-footer content. Please refer to comment of font of current object. |
| [in] | text_size | Text size of header-footer content. |
| [in] | text_color | Text color used for header-footer content. |
| [in] | page_range | A page number range object which specifies pages where current header-footer is used. Please refer to comment of page_range of current object. |
| [in] | page_margin | Page margin which specifies the location for header-footer content. Please refer to comment of page_margin of current object. |
| [in] | has_text_shrinked | A boolean value that decides whether to shrink text or not. |
| [in] | has_fixedsize_for_print | A boolean value that decides whether to use fixed size for print or not. |
| [in] | start_page_number | A virtual page number used for the first page specified in parameter page_range. This can be any number, even different from the actual page number of the specified page. If this value is less than 1, Foxit PDF SDK will use 1 for this value when current header-footer object is used in a PDF document. |
| [in] | content | Header-footer content. |
| [in] | is_to_embed_font | A boolean value that decides whether to embed font or not. |
| [in] | is_underline | A boolean value that decides whether to underline text or not. |
| common::Font foxit::pdf::HeaderFooter::font |
A valid font object which is expected to be used for header-footer content.
| RectF foxit::pdf::HeaderFooter::page_margin |
Page margin which specifies the location for header-footer content. Foxit PDF SDK will use a maring defined as (72.0, 36.0, 72.0, 36.0) as default if no margin value is set by user.
| PageNumberRange foxit::pdf::HeaderFooter::page_range |
A page number range object which specifies pages where current header-footer is used.
All the values represented in this range should start from 1 and no more than page count of the PDF document, in which current header-footer object is used.
| int foxit::pdf::HeaderFooter::start_page_number |
A virtual page number used for the first page specified in parameter page_range. This can be any number, even different from the actual page number of the specified page.