A sort property name and order type. More...

#include <SortProperty.h>

Public Types
enum	SortOrder { DESC , ASC }
	Sort order type: asc or desc. More...

Public Member Functions
Initializer Methods
Methods related to instantiation and destruction.
	SortProperty ()
	It initializes a new SortProperty.

	~SortProperty ()
	Destructor.

Accessor methods
Methods used to get or set properties.
PropertyName *	m_property
	Mandatory.

SortOrder	m_sortOrder
	Optional.

void	setPropertyName (PropertyName *p)
	It sets the property name.

const PropertyName *	getPropertyName () const
	It returns the property name.

void	setSortOrder (SortOrder direction)
	It sets the sort order.

SortOrder	getSortOrder () const
	It return the associated sort order.

Detailed Description

A sort property name and order type.

The order default will be ascendent if none is informed.

See also: SortBy, PropertyName

Definition at line 48 of file SortProperty.h.

Member Enumeration Documentation

◆ SortOrder

enum te::fe::SortProperty::SortOrder

Sort order type: asc or desc.

Enumerator
DESC	Descendent order type.
ASC	Ascendent order type.

Definition at line 57 of file SortProperty.h.

Constructor & Destructor Documentation

◆ SortProperty()

te::fe::SortProperty::SortProperty ( )

It initializes a new SortProperty.

◆ ~SortProperty()

te::fe::SortProperty::~SortProperty ( )

Destructor.

Member Function Documentation

◆ getPropertyName()

const PropertyName * te::fe::SortProperty::getPropertyName ( ) const

It returns the property name.

Returns: The property name.

◆ getSortOrder()

SortOrder te::fe::SortProperty::getSortOrder ( ) const

It return the associated sort order.

Returns: The associated sort order.

◆ setPropertyName()

void te::fe::SortProperty::setPropertyName ( PropertyName * p )

It sets the property name.

Parameters

p	The property name. The SortProperty will take the ownership of the property name.

Note: The previous property is discarted.

◆ setSortOrder()

void te::fe::SortProperty::setSortOrder ( SortOrder direction )

It sets the sort order.

Parameters

direction Sort order direction (ASC or DESC).

Member Data Documentation

◆ m_property

PropertyName* te::fe::SortProperty::m_property

private

Mandatory.

Definition at line 115 of file SortProperty.h.

◆ m_sortOrder

SortOrder te::fe::SortProperty::m_sortOrder