NotebookEntryHeader

Since: BlackBerry 10.2.0

#include <bb/pim/notebook/NotebookEntryHeader>

To link against this class, add the following line to your .pro file: LIBS += -lbbpim

The NotebookEntryHeader class represents a header to be shown in a list of NotebookEntry.

Each NotebookEntryHeader contains a title and a count. The title should be shown in the header of a ListView. The count represents the number of Notebook Entries that should be shown in the section under the header.

The headers can be retrieved using NotebookService::notebookEntryHeaders()

See also:

NotebookService


Overview

Public Functions Index

NotebookEntryHeader ()
NotebookEntryHeader (const NotebookEntryHeader &other)
~NotebookEntryHeader ()
intcount () const
boolisEmpty () const
boolisValid () const
booloperator!= (const NotebookEntryHeader &other) const
NotebookEntryHeader &operator= (const NotebookEntryHeader &other)
booloperator== (const NotebookEntryHeader &other) const
voidsetCount (int count)
voidsetTitle (const QString &title)
QStringtitle () const

Public Functions

NotebookEntryHeader ()

Constructs a new NotebookEntryHeader with default values.

Since:

BlackBerry 10.2.0

NotebookEntryHeader (

Copy constructor.

This function constructs a NotebookEntryHeader containing exactly the same values as the provided NotebookEntryHeader.

Parameters
other

The NotebookEntryHeader to be copied.

Since:

BlackBerry 10.2.0

~NotebookEntryHeader ()

Destructor.

Since:

BlackBerry 10.2.0

int count ()

Retrieves the count of this NotebookEntryHeader.

Return:

The count of this NotebookEntryHeader.

Since:

BlackBerry 10.2.0

bool isEmpty ()

Determines whether or not this NotebookEntryHeader is empty.

A NotebookEntryHeader is considered empty if its title is empty.

Return:

true if this NotebookEntryHeader object's title is empty, false otherwise.

Since:

BlackBerry 10.2.0

bool isValid ()

Determines whether or not this NotebookEntryHeader is valid.

A default-constructed NotebookEntryHeader is considered invalid until its title value is set.

Return:

true if this NotebookEntryHeader is valid, false otherwise.

Since:

BlackBerry 10.2.0

bool operator!= (

Inequality operator.

This operator indicates whether the provided NotebookEntryHeader contains a different title or count than this NotebookEntryHeader.

Parameters
other

The NotebookEntryHeader to compare to this one for inequality of title or count.

Return:

true if the provided NotebookEntryHeader has a different title or count than this one, false otherwise.

Since:

BlackBerry 10.2.0

NotebookEntryHeader & operator= (

Assignment operator.

Copies all values from the provided NotebookEntryHeader into this NotebookEntryHeader.

Parameters
other

The NotebookEntryHeader from which to copy all values.

Return:

A reference to this NotebookEntryHeader.

Since:

BlackBerry 10.2.0

bool operator== (

Equality operator.

This operator indicates whether the provided NotebookEntryHeader contains the same title and count as this NotebookEntryHeader.

Parameters
other

The NotebookEntryHeader to compare to this one for equality of title and count.

Return:

true if the provided NotebookEntryHeader has the same title and count as this one, false otherwise.

Since:

BlackBerry 10.2.0

void setCount (
  • intcount)

Sets the count for this NotebookEntryHeader.

Parameters
count

The new count for this NotebookEntryHeader.

Since:

BlackBerry 10.2.0

void setTitle (

Sets the title for this NotebookEntryHeader.

Parameters
title

The new title for this NotebookEntryHeader.

Since:

BlackBerry 10.2.0

QString title ()

Retrieves the title of this NotebookEntryHeader.

Return:

The title of this NotebookEntryHeader.

Since:

BlackBerry 10.2.0

Last modified: 2014-03-13

comments powered by Disqus