TK_Enumerated

class TK_Enumerated

TK_Enumerated provides support for writing/reading opcode objects which represent a simple choice from an enumerated set (TKO_Enumerations). This currently includes the opcodes: TKE_Face_Pattern, TKE_Window_Pattern, TKE_Text_Alignment, TKE_Window_Frame, TKE_Handedness

Inherits from: BBaseOpcodeHandler

Methods

TK_Enumerated::TK_Enumerated(unsigned char opcode)

constructor

TK_Status TK_Enumerated::Read(BStreamFileToolkit &tk)

virtual

Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available GetData() methods.

Parameters

tk: A reference to the BStreamFileToolkit object.

Returns

The result of the function call.
TK_Status TK_Enumerated::Write(BStreamFileToolkit &tk)

virtual

Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available PutData() methods, and first write out the opcode associated with the group of binary data followed by the data itself.

Parameters

tk: A reference to the BStreamFileToolkit object.

Returns

The result of the function call.
TK_Status TK_Enumerated::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

const virtual

Copies the opcode handler

Parameters

tk: A reference to the BStreamFileToolkit object.

handler: A pointer to the opcode handler object. Passed by reference.

Returns

The result of the function call.
TK_Status TK_Enumerated::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Enumerated::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Enumerated::SetIndex(int i)

Sets the index value

int TK_Enumerated::GetIndex() const

const

Returns the index value

Variables

char TK_Enumerated::m_index

protected

char

internal use