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

Text-List
[Graphic User Interface]


Detailed Description

text list (graphic browser).

display-list hierarchy:
dl (main display list)

space organization :
dl global textlist Z := [0..100]

Each sub-list as a transformation setted properly. This mean than each sub-list (bdl,cdl,idl,udl) as a useable Z space range [0..100]

Author:
benjamin gerard


Files

file  textlist.lua
 Manage and display a list of text.


Data Structures

struct  flentry
 Entry displayed in textlist. More...

struct  textlist
 textlist object definition. More...


Textlist draw methods.

 textlist_draw (var fl)
 Draw textlist.

 textlist_draw_background (var fl, var dl)
 Draw background box.

 textlist_draw_cursor (var fl, var dl)
 Draw textlist cursor.

 textlist_draw_list (var fl, var dl)
 Draw entries.


Functions

 textlist_create (var flparm, var owner)
 Create a textlist object.

 textlist_set_box (var fl, var x, var y, var w, var h, var z)
 Change textlist position and size.

 textlist_set_pos (var fl, var x, var y, var z)
 Change textlist position.

 textlist_set_color (var fl, var a, var r, var g, var b)
 Set textlist color.

 textlist_open (var fl)
 Open textlist (fade in).

 textlist_close (var fl)
 Close textlist (fade out).

 textlist_fade (var fl, var to, var speed)
 textlist_center (var fl, var x, var y, var w, var h, var z)
 Center a textlist in a box.

 textlist_confirm (var fl)
 Default confirm callback function.

 textlist_shutdown (var fl)
 Textlist shutdown.

 textlist_measure (var fl)
 Measure dimension of the whole textlist and set dirinfo.

 textlist_measure_text (var fl, var entry)
 Measure an entry.

 textlist_draw_entry (var fl, var dl, var idx, var x, var y, var z)
 Draw given textlist entry in given diplay list.

 textlist_insert_entry (var fl, var entry, var pos, var no_redraw)
 Insert an entry.

 textlist_remove_entry (var fl, var pos)
 textlist_reset (var fl)
 Reset textlist.

 textlist_change_dir (var fl, var dir, var pos)
 Change the textlist content.

 textlist_move_cursor (var fl, var mov)
 Move textlist cursor.

 textlist_get_entry (var fl)
 Get a copy of the current entry.

 textlist_get_pos (var fl, var pos)
 textlist_get_text (var fl, var pos)
 textlist_get_path (var fl, var entry)
 textlist_fullpath (var fl, var entry)
 Get entry fullpath.

 textlist_locate_entry_expr (var fl, var regexpr)
 Locate an entry which name matches a regular expression.

 textlist_locate_entry (var fl, var name)
 Locate an entry from its name.

 textlist_screen_coor (var fl, var pos)
 Get screen TOP/LEFT coordinates of an entry.

 textlist_update (var fl, var frametime)
 Update function.

 textlist_create_app (var fl, var owner)
 Create a textlist application from a textlist object.

 textlist_app_update (var app, var frametime)
 Default textlist update handler.

 textlist_app_handle (var app, var evt)
 Default textlist application event handler.

 textlist_create_gui (var fl, var owner)
 textlist_gui_handle (var app, var evt)
 textlist GUI application event handler.

 gui_textlist (var owner, var flparm)
 Create textlist gui application.


Function Documentation

textlist_create var  flparm,
var  owner
 

Create a textlist object.

Parameters:
flparm Optionnal creation structure, with optionnal fields. Most fields are the same than fllist ones.
owner Owner application
Exceptions are:

  • pos : { x, y, z }. Each component is optionnal. Default {100,100,100}
  • box : { min_width, max_width, min_heigth, max_height } display box min/max Default={0,0,400, size for 8 entries)

Returns:
textlist object
Return values:
nil error

textlist_set_box var  fl,
var  x,
var  y,
var  w,
var  h,
var  z
 

Change textlist position and size.

Parameters:
fl textlist.
x New horizontal position of textlist or nil.
y New vertical position of textlist or nil.
w New width of textlist box or nil.
h New height of textlist box or nil.
z New depth of textlist box or nil.

textlist_set_pos var  fl,
var  x,
var  y,
var  z
 

Change textlist position.

Parameters:
fl textlist.
x New horizontal position of textlist or nil.
y New vertical position of textlist or nil.
z New depth of textlist box or nil.
See also:
textlist_set_box()

textlist_set_color var  fl,
var  a,
var  r,
var  g,
var  b
 

Set textlist color.

Parameters:
fl textlist.
a New alpha component or nil
r New red component or nil
g New green component or nil
b New blue component or nil

textlist_center var  fl,
var  x,
var  y,
var  w,
var  h,
var  z
 

Center a textlist in a box.

Parameters:
fl textlist.
x Horizontal position of the outer box or nil.
y Vertical position of the outer box or nil.
w Width of the outer box or nil.
h Height of the outer box or nil.
z New depth of textlist box or nil.
See also:
textlist_set_pos()

textlist_create_app var  fl,
var  owner
 

Create a textlist application from a textlist object.

Parameters:
fl textlist
owner Parent of the created application
Returns:
application.
Return values:
nil error


dcplaya documentation version 2.0 Generated on November 2004 by doxygen 1.3.6