InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
SnpSortTable::TblSortRowData Class Reference

Public Types

typedef object_type data_type
 

Public Member Functions

 TblSortRowData (void)
 
 TblSortRowData (K2Vector< WideString > &rowData, int32 keyIndex)
 
 TblSortRowData (const TblSortRowData &rhs)
 
 TblSortRowData (int32 reserveSize)
 
virtual ~TblSortRowData (void)
 
bool operator< (const TblSortRowData &rhs) const
 
TblSortRowDataoperator= (const TblSortRowData &rhs)
 
void SetAll (K2Vector< WideString > &rowData, int32 keyIndex)
 
const K2Vector< WideString > & GetRowData (void)
 
void Set (const WideString &data, int32 index)
 
void SetKey (int32 keyIndex)
 
WideString GetKeyData (void) const
 
int32 RowSize (void) const
 

Detailed Description

Data class that encapsulates a table row.

Constructor & Destructor Documentation

SnpSortTable::TblSortRowData::TblSortRowData (void )

Default constructor

SnpSortTable::TblSortRowData::TblSortRowData (K2Vector< WideString > & rowData,
int32 keyIndex 
)

Constructor

Parameters
[in]rowDataList of WideString objects for the row.
[in]keyIndexIndex of the item designated as the sort key.
SnpSortTable::TblSortRowData::TblSortRowData (const TblSortRowDatarhs)

Copy-constructor

Parameters
[in]rhsAnother TblSortRowData class.
SnpSortTable::TblSortRowData::TblSortRowData (int32 reserveSize)

Constructor when we have no data but want to reserve storage

Parameters
[in]reserveSizeReserves enough storage space for this number of items.
SnpSortTable::TblSortRowData::~TblSortRowData (void )
virtual

Destructor

Member Function Documentation

WideString SnpSortTable::TblSortRowData::GetKeyData (void ) const

Returns the WideString data corresponding to the sort key.

Returns
Returns WideString data of key.
const K2Vector< WideString > & SnpSortTable::TblSortRowData::GetRowData (void )

Returns the row data

Returns
K2Vector of WideString objects, containing row data.
bool SnpSortTable::TblSortRowData::operator< (const TblSortRowDatarhs) const

Operator less-than.

Parameters
[in]rhsRight-hand side argument to the less-than operator.
Returns
true if predicate is true, false otherwise.
SnpSortTable::TblSortRowData & SnpSortTable::TblSortRowData::operator= (const TblSortRowDatarhs)

Operator assignment

Parameters
[in]rhsRight-hand side argument to the assignment operator.
Returns
Reference to this object.
int32 SnpSortTable::TblSortRowData::RowSize (void ) const

Returns the size of the row.

Returns
Returns number of items in the row.
void SnpSortTable::TblSortRowData::Set (const WideStringdata,
int32 index 
)

Sets a specific data item in the row data.

Parameters
[in]dataThe data to set.
[in]indexThe index to set.
void SnpSortTable::TblSortRowData::SetAll (K2Vector< WideString > & rowData,
int32 keyIndex 
)

Sets all row data.

Parameters
[in]rowDataList of WideString objects for the row.
[in]keyIndexIndex of the item designated as the sort key.
void SnpSortTable::TblSortRowData::SetKey (int32 keyIndex)

Sets the index for the sort key.

Parameters
[in]keyIndexThe sort key index to set.