PageLabel Class

class PageLabel

Namespace:datalogics_interface

Detailed Description

Describes numbering labels for a range of pages.

PageLabel describes how to construct a label string for a range of pages. It contains information on number style, any prefixes, and a starting position within the document.

Note that a single PageLabel describes the label string for several pages all pages up until the first page covered by the next PageLabel, or the end of the document.

Also note that if a Document has any PageLabels, there must be one that starts at page index 0. This will be automatically created if the user does not supply one.

Referenced by

Document

Uses types

NumberStyle

Constructor & Destructor Documentation

PageLabel(const PageLabel & other)

Parameters

other: const PageLabel &

Copy constructor.

PageLabel(int start_page_index, NumberStyle style)

Parameters

start_page_index: int: Starting page index in the Document for this range
style: NumberStyle: Numbering style for this range

Public constructor

PageLabel(int start_page_index, NumberStyle style, const std::string & prefix, int first_number)

Parameters

start_page_index: int: Starting page index in the Document for this range
style: NumberStyle: Numbering style for this range
prefix: const std::string &: Prefix string for this range
first_number: int: First number appearing on a page in this range

Public constructor

PageLabel(PageLabel && )

Parameters

: PageLabel &&

~PageLabel()

Member Function Documentation

int get_end_page_index()

Returns:

int

The zero-based ending page index for this page label range.

You cannot set the end index for a range; you must change the start index for the following range. A value of -1 means the end index for this PageLabel is unknown (e.g. when the label has not yet been added to a Document).

int get_first_number_in_range()

Returns:

int

The first numeric value used for page labels in this range.

Must be greater than or equal to 1.

NumberStyle get_number_style()

Returns:

NumberStyle

The NumberStyle used for generating page labels in this range.

std::string get_prefix()

Returns:

std::string

The prefix string prepended to page labels in this range.

For example, a prefix of "A-" with decimal numbering starting at 1 would produce labels "A-1", "A-2", "A-3", etc.

int get_start_page_index()

Returns:

int

The zero-based starting page index for this page label range in the Document.

PageLabel & operator=(const PageLabel & other)

Parameters

other: const PageLabel &

Returns:

PageLabel &

Copy assignment.

PageLabel & operator=(PageLabel && )

Parameters

: PageLabel &&

Returns:

PageLabel &

void set_first_number_in_range(int number)

Parameters

number: int

Returns:

void

The first numeric value used for page labels in this range.

void set_number_style(NumberStyle style)

Parameters

style: NumberStyle

Returns:

void

The NumberStyle used for generating page labels in this range.

void set_prefix(const std::string & prefix)

Parameters

prefix: const std::string &

Returns:

void

The prefix string prepended to page labels in this range.

void set_start_page_index(int index)

Parameters

index: int: the zero-based starting page index for this page label range in the Document

Returns:

void

The zero-based starting page index for this page label range in the Document.

std::string to_string()

Returns:

std::string

A string describing this PageLabel.

Returns a string representation of this PageLabel.

The string includes the start page, end page, number style, prefix, and first page number of this label range.