ooodev.adapter.text.page_cursor_partial module

class ooodev.adapter.text.page_cursor_partial.PageCursorPartial(component, interface=com.sun.star.text.XPageCursor)

Bases: object

Partial class for XPageCursor.

Parameters:

• component (XPageCursor) –

• interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.text.XPageCursor)

Constructor

Parameters:

• component (XPageCursor) – UNO Component that implements com.sun.star.text.XPageCursor interface.

• interface (UnoInterface, optional) – The interface to be validated. Defaults to XPageCursor.

Return type:

None

get_page()

Returns the current page number.

Return type:

int

jump_to_end_of_page()

Jumps to the end of the current page.

Returns:

True if the jump was successful, False otherwise.

Return type:

bool

jump_to_first_page()

Jumps to the first page.

Returns:

True if the jump was successful, False otherwise.

Return type:

bool

jump_to_last_page()

Jumps to the last page.

Return type:

None

jump_to_next_page()

Jumps to the next page.

Returns:

True if the jump was successful, False otherwise.

Return type:

bool

jump_to_page_(number)

Jumps to the page with the given number.

Parameters:

number (int) – Page number to jump to.

Returns:

True if the jump was successful, False otherwise.

Return type:

bool

jump_to_previous_page()

Jumps to the previous page.

Returns:

True if the jump was successful, False otherwise.

Return type:

bool

jump_to_start_of_page()

Jumps to the start of the current page.

Returns:

True if the jump was successful, False otherwise.

Return type:

bool