text::PaginationTask Class Reference

Pagination task definition for text plugin. The pagination task is responsible for calculating start position and end position for a specified page, and calculating total pages. More...

#include <text_tasks.h>

Inheritance diagram for text::PaginationTask:

[legend]

Collaboration diagram for text::PaginationTask:

[legend]

Public Member Functions
	PaginationTask (TextView *view, const Position &_start, bool _is_child)
	Constructors and destructors.
virtual	~PaginationTask ()
virtual void	execute ()
	Execute task with task context.
Data Fields
utils::Signal< const Position & >	abort_signal
	Abort signal.

---

Detailed Description

Pagination task definition for text plugin. The pagination task is responsible for calculating start position and end position for a specified page, and calculating total pages.

Definition at line 78 of file text_tasks.h.

---

Constructor & Destructor Documentation

text::PaginationTask::PaginationTask	(	TextView *	view,
		const Position &	_start,
		bool	_is_child
	)

Constructors and destructors.

Definition at line 64 of file text_tasks.cpp.

: text_view(view), start_pos(_start), is_child(_is_child)
{
}

text::PaginationTask::~PaginationTask

(

)

[virtual]

Definition at line 69 of file text_tasks.cpp.

{
}

---

Member Function Documentation

void text::PaginationTask::execute

(

)

[virtual]

Execute task with task context.

Implements common::Task.

Definition at line 73 of file text_tasks.cpp.

References abort_signal, utils::Signal< A1, A2, A3, A4, A5 >::broadcast(), text::TextView::get_current_page_index(), text::TextView::get_page_count(), common::Task::is_aborted(), LOGPRINTF, text::TextView::paginate(), text::TextView::pagination_end_signal, text::TextView::pagination_start_signal, and total_pages.

{
    if (!is_child)
    {
        // Tell listener that pagination starts.
        LOGPRINTF("About to send pagination start signal.");
        text_view->pagination_start_signal.broadcast(1);
    }

    bool pagination_done = false;
    while (!is_aborted())
    {
        if (text_view->paginate(start_pos))
        {
            // Pagination is complete.
            pagination_done = true;
            break;
        }
    }

    if (pagination_done)
    {
        // Tell listener that pagination is done.
        unsigned int total_pages = text_view->get_page_count();
        unsigned int current_page = text_view->get_current_page_index();
        LOGPRINTF("About to send pagination done signal.");
        text_view->pagination_end_signal.broadcast(current_page, total_pages);
    }
    else
    {
        // We are aborted.
        LOGPRINTF("Pagination aborted...");
        abort_signal.broadcast(start_pos);
    }
}

Here is the call graph for this function:

---

Field Documentation

utils::Signal<const Position&> text::PaginationTask::abort_signal

Abort signal.

Definition at line 87 of file text_tasks.h.

Referenced by execute(), and text::TextController::paginate().

---

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

• text_tasks.h
• text_tasks.cpp