Cutelyst  2.13.0
Public Member Functions | Properties | List of all members
Cutelyst::Pagination Class Reference
Inheritance diagram for Cutelyst::Pagination:
Inheritance graph

Public Member Functions

 Pagination (int numberOfItems, int itemsPerPage, int currentPage, int pageLinks=10)
int currentPage () const
bool enableFirst () const
bool enableLast () const
int lastPage () const
int limit () const
int numberOfItems () const
int offset () const
QVector< int > pages () const


int currentPage
bool enableFirst
bool enableLast
int lastPage
int limit
int numberOfItems
int offset
QVector< int > pages

Detailed Description

Definition at line 26 of file pagination.h.

Constructor & Destructor Documentation

◆ Pagination()

Pagination::Pagination ( int  numberOfItems,
int  itemsPerPage,
int  currentPage,
int  pageLinks = 10 

Contructs a pagination object

numberOfItemsshould be set to the total of items to be displayed
itemsPerPagethe desired number of items per page
currentPagethe current 1 indexed page (first page is 1) usually from the query url
pageLinksthe number of page links that should be generated, for example 3 -> 11, 12, 13

Definition at line 26 of file pagination.cpp.

Member Function Documentation

◆ currentPage()

int Cutelyst::Pagination::currentPage ( ) const

Returns the current page number

◆ enableFirst()

bool Cutelyst::Pagination::enableFirst ( ) const

Returns true if the first page link should be enabled

◆ enableLast()

bool Cutelyst::Pagination::enableLast ( ) const

Returns true if the last page link should be enabled

◆ lastPage()

int Cutelyst::Pagination::lastPage ( ) const

Returns the number of the last page

◆ limit()

int Cutelyst::Pagination::limit ( ) const

Returns the number os items per page

◆ numberOfItems()

int Cutelyst::Pagination::numberOfItems ( ) const

Returns the total number of items

◆ offset()

int Cutelyst::Pagination::offset ( ) const

Returns the current page offset for use in SQL

◆ pages()

QVector<int> Cutelyst::Pagination::pages ( ) const

Returns the list of pages, with each page number as the integer