Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

Text Viewer
[Graphic User Interface]


Detailed Description

text viewer

Author:
benjamin gerard


Functions

 text_viever_tt_build (var text, var mode)
 Create a taggeg text from a string that may be either a file or a text.

 gui_text_viewer (var owner, var texts, var box, var label, var mode, var help)
 Create a text view gui application.

 gui_text_viewer_desactive_tt (var tt)
 Desactive a tagged text.

 gui_text_viewer_set_tt (var dial, var tt, var x, var y)
 Set current displayed tagged text.

 gui_text_viewer_set_scroll (var dial, var x, var y)
 Set current tagged text-scrolling position.

 gui_text_viewer_fadeto (var tt, var alpha, var spd)
 Process tagged text fading.

 gui_text_viewer_scrollto (var x, var xgoal)
 Process tagged text scrolling.

 gui_text_viewer_update (var dial, var frametime)
 Text viewer gui application update.

 gui_text_viewer_move_handle (var dial, var x, var y)
 gui_text_viewer_up (var dial, var evt)
 gui_text_viewer_dw (var dial, var evt)
 gui_text_viewer_lt (var dial, var evt)
 gui_text_viewer_rt (var dial, var evt)
 gui_text_viewer_menucreator (var target)
 gui_file_viewer (var owner, var fname, var box, var label, var mode, var preformatted)
 Create a text-viewer application from a file.


Function Documentation

gui_text_viewer var  owner,
var  texts,
var  box,
var  label,
var  mode,
var  help
 

Create a text view gui application.

Parameters:
owner owner applciation (default is desktop)
texts string or table of string.
box application box
label dialog label (optionnal)
mode label mode.
help optionnal tagged text for help
Returns:
dialog application

gui_text_viewer_set_tt var  dial,
var  tt,
var  x,
var  y
 

Set current displayed tagged text.

Parameters:
dial textviewer dialog
tt tagged-text or anchor string. Anchor string format is [text-name][#anchor-name]. If an anchor is specified, it override x and y parameters.
x x scrolling position
y y scrolling position

gui_text_viewer_set_scroll var  dial,
var  x,
var  y
 

Set current tagged text-scrolling position.

This function ensure that scrolling position is inside taged-text box.

Parameters:
dial text-viewer dialog
x x scrolling position
y y scrolling position

gui_file_viewer var  owner,
var  fname,
var  box,
var  label,
var  mode,
var  preformatted
 

Create a text-viewer application from a file.

Parameters:
owner owner applciation (default is desktop)
fname Filename to view
box application box
label dialog label (optionnal)
mode label mode.
preformatted if defined text is load as preformatted and preformatted is the tab size.
See also:
gui_text_viewer()


dcplaya documentation version 2.0 Generated on November 2004 by doxygen 1.3.6