TxtList class Reference Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members

TxtList Class Reference

#include <OTXTLIST.H>

List of all members.

Public Types

enum { HISTORY_SIZE = 20 }

Public Methods

TxtList ()

void init (int, int, int, int, char *)

void init_pict (int, int, int, int, char *)

void init_list (int, int, int, int)

void deinit ()

void disp (int, int=0)

int detect ()

int detect_text ()

void add_history (int)

void back_history ()

Public Attributes

ResTxt res_txt

ResourceIdx res_pict

char init_flag

char init_pict_flag

char init_list_flag

short text_x1

short text_y1

short text_x2

short text_y2

short pict_x1

short pict_y1

short pict_x2

short pict_y2

short list_x1

short list_y1

short list_x2

short list_y2

short scroll_x1

short scroll_y1

short scroll_x2

short scroll_y2

short topic_id

short top_line

char can_back

short history_array [HISTORY_SIZE]

short history_pos

char double_clicked

Detailed Description

Class for maintaining a history of ResTxt to provide "back" functionality.

Definition at line 23 of file OTXTLIST.H.

Member Enumeration Documentation

anonymous enum

Enumeration values:

HISTORY_SIZE

Definition at line 42 of file OTXTLIST.H.

Constructor & Destructor Documentation

TxtList::TxtList ( )

Definition at line 34 of file Otxtlist.cpp.
References can_back, history_array, history_pos, HISTORY_SIZE, init_flag, init_list_flag, init_pict_flag, and top_line.

Member Function Documentation

void TxtList::add_history ( int topicId )

Add a topic id. to the topic history
Definition at line 223 of file Otxtlist.cpp.
Referenced by HelpIf::help_topic_detect().

void TxtList::back_history ( )

Backward to previous topic in the history
Definition at line 254 of file Otxtlist.cpp.
Referenced by HelpIf::help_desc_detect().

void TxtList::deinit ( )

Definition at line 77 of file Otxtlist.cpp.
References NULL.

int TxtList::detect ( void )

Return : <int> 1 - detected 0 - not detected
Definition at line 298 of file Otxtlist.cpp.
References VBrowse98::double_click.
Referenced by HelpIf::help_desc_detect(), and HelpIf::help_topic_detect().

int TxtList::detect_text ( )

Return : <int> 1 - detected 0 - not detected
Definition at line 333 of file Otxtlist.cpp.
References err_when, INFO_UPDATE, NULL, VBrowse98::refresh(), HyperField::text_len, HyperField::text_ptr, TxtIndex::TITLE_LEN, HyperField::x1, HyperField::x2, HyperField::y1, and HyperField::y2.

void TxtList::disp ( int refreshFlag,

int topicId = 0

)

<int> refreshFlag = INFO_REPAINT or INFO_UPDATE [int] topicId = the id. of the topic requested to display (default : current topic id.)
Definition at line 129 of file Otxtlist.cpp.
References INFO_REPAINT.

void TxtList::init ( int x1,

int y1,

int x2,

int y2,

char * resTxtName

)

The text list is optional, if it hasn't initialized, it won't be displayed.
<int> x1, y1, x2, y2 = the position of the text list <char*> resTxtName = name of the text resource file
Definition at line 54 of file Otxtlist.cpp.
References SCROLL_BAR_WIDTH.

void TxtList::init_list ( int x1,

int y1,

int x2,

int y2

)

<int> x1, y1, x2, y2 = the position of the topic list list
Definition at line 111 of file Otxtlist.cpp.

void TxtList::init_pict ( int x1,

int y1,

int x2,

int y2,

char * resPictName

)

<int> x1, y1, x2, y2 = the position of the text list <char*> resPictName = name of the picture resource file attached to the text
Definition at line 94 of file Otxtlist.cpp.

Member Data Documentation

char TxtList::can_back

Definition at line 40 of file OTXTLIST.H.
Referenced by HelpIf::help_desc_detect(), and TxtList().

char TxtList::double_clicked

Definition at line 47 of file OTXTLIST.H.
Referenced by HelpIf::help_topic_detect().

short TxtList::history_array[HISTORY_SIZE]

Definition at line 44 of file OTXTLIST.H.
Referenced by TxtList().

short TxtList::history_pos

Definition at line 45 of file OTXTLIST.H.
Referenced by TxtList().

char TxtList::init_flag

Definition at line 28 of file OTXTLIST.H.
Referenced by TxtList().

char TxtList::init_list_flag

Definition at line 30 of file OTXTLIST.H.
Referenced by TxtList().

char TxtList::init_pict_flag

Definition at line 29 of file OTXTLIST.H.
Referenced by TxtList().

short TxtList::list_x1

Definition at line 34 of file OTXTLIST.H.

short TxtList::list_x2

Definition at line 34 of file OTXTLIST.H.

short TxtList::list_y1

Definition at line 34 of file OTXTLIST.H.

short TxtList::list_y2

Definition at line 34 of file OTXTLIST.H.

short TxtList::pict_x1

Definition at line 33 of file OTXTLIST.H.

short TxtList::pict_x2

Definition at line 33 of file OTXTLIST.H.

short TxtList::pict_y1

Definition at line 33 of file OTXTLIST.H.

short TxtList::pict_y2

Definition at line 33 of file OTXTLIST.H.

ResourceIdx TxtList::res_pict

Definition at line 26 of file OTXTLIST.H.

ResTxt TxtList::res_txt

Definition at line 25 of file OTXTLIST.H.

short TxtList::scroll_x1

Definition at line 35 of file OTXTLIST.H.

short TxtList::scroll_x2

Definition at line 35 of file OTXTLIST.H.

short TxtList::scroll_y1

Definition at line 35 of file OTXTLIST.H.

short TxtList::scroll_y2

Definition at line 35 of file OTXTLIST.H.

short TxtList::text_x1

Definition at line 32 of file OTXTLIST.H.

short TxtList::text_x2

Definition at line 32 of file OTXTLIST.H.

short TxtList::text_y1

Definition at line 32 of file OTXTLIST.H.

short TxtList::text_y2

Definition at line 32 of file OTXTLIST.H.

short TxtList::top_line

Definition at line 38 of file OTXTLIST.H.
Referenced by HelpIf::help_desc_detect(), and TxtList().

short TxtList::topic_id

Definition at line 37 of file OTXTLIST.H.
Referenced by HelpIf::help_topic_detect().

The documentation for this class was generated from the following files:

Generated on Fri Aug 23 01:39:41 2002 for VirtualU by

1.2.17