foxit::addon::accessibility::ReadingOrderOptions Class Reference

Inherits Object.

Public Types
enum	ReadingOrderShowType { e_ReadingOrderShowTypeOrder = 0, e_ReadingOrderShowTypeStruct = 1, e_ReadingOrderShowTypeNone = 2 }
	Enumeration for reading order show type. More...

Public Member Functions
	ReadingOrderOptions ()
	Constructor.
	ReadingOrderOptions (const ReadingOrderOptions &other)
	Constructor, with another reading order options object. More...
	ReadingOrderOptions (ReadingOrderShowType reading_order_show_type, bool is_show_table_figure, bool is_display_like_element, bool is_show_table_cells)
	Constructor.
ReadingOrderOptions &	operator= (const ReadingOrderOptions &other)
	Assign operator. More...
void	Set (ReadingOrderShowType reading_order_show_type, bool is_show_table_figure, bool is_display_like_element, bool is_show_table_cells)
	Set value. More...

Public Attributes
bool	is_display_like_element
	Whether to display like elements in a single box.
bool	is_show_table_cells
	Whether to show table cells.
bool	is_show_table_figure
	Whether to show table and figure.
ReadingOrderShowType	reading_order_show_type
	The type of reading order. Please refer to values starting from ReadingOrderOptions::e_ReadingOrderShowTypeOrder and this should be one of these values.

Detailed Description

This class represents data used for reading order options.

Member Enumeration Documentation

ReadingOrderShowType

enum foxit::addon::accessibility::ReadingOrderOptions::ReadingOrderShowType

Enumeration for reading order show type.

Values of this enumeration should be used alone.

Enumerator
e_ReadingOrderShowTypeOrder	Show type: order.
e_ReadingOrderShowTypeStruct	Show type: struct.
e_ReadingOrderShowTypeNone	Show type: none.

Constructor & Destructor Documentation

ReadingOrderOptions()

foxit::addon::accessibility::ReadingOrderOptions::ReadingOrderOptions ( const ReadingOrderOptions &  other )

inline

Constructor, with another reading order options object.

Parameters

[in]

other

Another reading order options object.

Member Function Documentation

operator=()

ReadingOrderOptions& foxit::addon::accessibility::ReadingOrderOptions::operator= ( const ReadingOrderOptions &  other )

inline

Assign operator.

Parameters

[in]

other

Another reading order options object, whose value would be assigned to current object.

Returns

Reference to current object itself.

Set()

void foxit::addon::accessibility::ReadingOrderOptions::Set ( ReadingOrderShowType  reading_order_show_type, bool  is_show_table_figure, bool  is_display_like_element, bool  is_show_table_cells  )

inline

Set value.

Parameters

[in]	reading_order_show_type	The reading order show type. Please refer to values starting from ReadingOrderOptions::e_ReadingOrderShowTypeOrder and this should be one of these values.
[in]	is_show_table_figure	Whether to show table and figure.
[in]	is_display_like_element	Whether to display like elements in a single box.
[in]	is_show_table_cells	Whether to show table cells.

Returns

None.