Fulledit(3)                                                        Fulledit(3)



NNAAMMEE
       Fulledit -

SSYYNNOOPPSSIISS
       Inherits TTeexxttddrraaww.


   PPuubblliicc MMeetthhooddss
       void ddoo__rreeffrreesshh ()
       void ddrraaww__iinnffoo__bbaarr ()
       void rreessoollvvee__vveerrttiiccaall__ssccrroollll ()
       void ccrreeaattee ()
       void iinniitt__rreettuurrnn (object ob, string func)
       string * qquueerryy__tteerrmmbbuuff ()
       void eexxiitt__eeddiittoorr ()
       int ccuurrrr__lliinnee ()
       void ccaattcchh__tteellll (string data)
       void eeddiittoorr__mmeessssaaggee (string str)
       rreessoollvvee__ssiiddeewwaayyss__ssccrroollll ()
       void ttyyppee__cchhaarr (string c)
       void ddoo__bbaacckkssppaaccee ()
       void ddoo__eenntteerr ()
       void ddrraaww__tteexxtt ()
       void ddrraaww__lliinnee ()
       void ssttaarrtt__eeddiitt (string fname)
       varargs void iinnppuutt__bbooxx (string prompt, string finish_to, int box_width,
           string initial_text)
       void mmaaiinnmmeennuu (string str)
       void kkeeyypprreessss (string c)

   PPuubblliicc AAttttrriibbuutteess
       string ffiilleennaammee
       int tteerrmm__hheeiigghhtt
       string ttiittllee__ccoolloorr
       string tteexxtt__ccoolloorr
       string aannss__cceeooll
       int rreeffrreesshh__ssccrroollll
       int rreeffrreesshh__lliinnee
       int rreeffrreesshh__ssttaattuuss
       int rreeaadd__oonnllyy
       int ffiillee__mmooddiiffiieedd
       int ccuurrssoorrxx
       int ccuurrssoorryy
       int ssttrriinngg__ffoorrmmaatt
       string kkeeyybbuuff
       int wwiiddtthh
       int hheeiigghhtt
       int lliinneennuumm
       int ttoottaall__lliinneess
       int bboottttoomm__lliinnee
       string * tteerrmmbbuuff
       object ccaalllleerr
       string rreettuurrnn__ffuunncc
       int ttaabb__ssiizzee
       string llaasstt__sseeaarrcchh

DDEETTAAIILLEEDD DDEESSCCRRIIPPTTIIOONN
       Hello, and welcome to my second attempt at a full screen text editor.
       I'll explain it more if I get anywhere.

       Definition at line 10 of file fulledit.c.

MMEEMMBBEERR FFUUNNCCTTIIOONN DDOOCCUUMMEENNTTAATTIIOONN
   vvooiidd ccaattcchh__tteellll ((ssttrriinngg ddaattaa))
       Used to catch incoming messages. These will be printed in the small
       'terminal area' below the status line. This is so that incoming
       messages don't clobber the file you're editing.

       Definition at line 116 of file fulledit.c.

       References Textdraw::add_text(), bottom_line,
       Textdraw::draw_terminal(), height, refresh_status, term_height,
       termbuf, and width.

       Referenced by editor_message().

   vvooiidd ccrreeaattee (())
       Initialization code.

       Definition at line 65 of file fulledit.c.

       References bottom_line, height, keybuf, tab_size, term_height, termbuf,
       and width.

   iinntt ccuurrrr__lliinnee (())
       Returns index of currently edited line.

       Definition at line 108 of file fulledit.c.

       References cursory, and linenum.

       Referenced by keypress().

   vvooiidd ddoo__bbaacckkssppaaccee (())
       Called whenever the 'backspace' key is pressed.

       Definition at line 191 of file fulledit.c.

       References cursorx, cursory, file_modified, linenum, refresh_line,
       refresh_scroll, resolve_sideways_scroll(), resolve_vertical_scroll(),
       text_color, and total_lines.

       Referenced by keypress().

   vvooiidd ddoo__eenntteerr (())
       Called whenever 'Enter' is pushed.

       Definition at line 228 of file fulledit.c.

       References cursorx, cursory, file_modified, linenum, refresh_scroll,
       resolve_sideways_scroll(), resolve_vertical_scroll(), and total_lines.

       Referenced by keypress().

   vvooiidd ddoo__rreeffrreesshh (())
       Refreshes the editor. Only stuff that's changed (as marked by a refresh
       flag) is modified.

       Referenced by keypress().

   vvooiidd ddrraaww__iinnffoo__bbaarr (())
       Redraws the information bar at the bottom of the screen.

       Referenced by mainmenu().

   vvooiidd ddrraaww__lliinnee (())
       Redraws a single line of the editing field.

       Definition at line 283 of file fulledit.c.

       References ans_ceol, cursory, Textdraw::gotoxy(), linenum,
       refresh_line, text_color, total_lines, and width.

   vvooiidd ddrraaww__tteexxtt (())
       Draws the editing field (the text edited).

       Definition at line 268 of file fulledit.c.

       References ans_ceol, bottom_line, Textdraw::gotoxy(), linenum,
       refresh_scroll, text_color, total_lines, and width.

   vvooiidd eeddiittoorr__mmeessssaaggee ((ssttrriinngg ssttrr))
       Used for printing out informational messages. A n is implied.

       \

       Definition at line 126 of file fulledit.c.

       References catch_tell().

       Referenced by mainmenu().

   vvooiidd eexxiitt__eeddiittoorr (())
       Exits this editor by dropping the interface & destructing. If a return
       value was desired, it will be passed back before the call to destruct
       is made.

       Definition at line 98 of file fulledit.c.

       References caller, Textdraw::gotoxy(), return_func, and termbuf.

       Referenced by mainmenu().

   vvooiidd iinniitt__rreettuurrnn ((oobbjjeecctt oobb,, ssttrriinngg ffuunncc))
       Called by the sefun string_edit in order to initialize the returning of
       a string to an object. Passing this function invalid values will cause
       an error later on.

       Definition at line 84 of file fulledit.c.

       References caller, and return_func.

   vvaarraarrggss vvooiidd iinnppuutt__bbooxx ((ssttrriinngg pprroommpptt,, ssttrriinngg ffiinniisshh__ttoo,, iinntt bbooxx__wwiiddtthh,,
       ssttrriinngg iinniittiiaall__tteexxtt))
       Inputs a string in a mini-editor

       PPaarraammeetteerrss::

       _p_r_o_m_p_t The prompt to write at the top of the input box.

       _f_i_n_i_s_h___t_o
              The function to call when input has finished. The input will be
              passed to the function as a string.

       _b_o_x___w_i_d_t_h
              The width of the input box in characters. Use the global
              variable width.

       _i_n_i_t_i_a_l___t_e_x_t
              (Optional) The text initially in the edit box, which may be
              edited.

       Definition at line 483 of file fulledit.c.

       References Textdraw::drawbox(), Textdraw::gotoxy(), height,
       Textdraw::line_input(), and width.

       Referenced by keypress(), and mainmenu().

   vvooiidd kkeeyypprreessss ((ssttrriinngg cc))
       Takes input one character at a time and generates events from it. This
       is the interface handler for the editor.

       Definition at line 622 of file fulledit.c.

       References bottom_line, curr_line(), cursorx, cursory, do_backspace(),
       do_enter(), do_refresh(), input_box(), keybuf, last_search, linenum,
       mainmenu(), refresh_scroll, resolve_sideways_scroll(),
       resolve_vertical_scroll(), tab_size, total_lines, type_char(), and
       width.

   vvooiidd mmaaiinnmmeennuu ((ssttrriinngg ssttrr))
       IInntteerrffaaccee handler for the main menu.

       Definition at line 567 of file fulledit.c.

       References draw_info_bar(), Textdraw::drawbox(), editor_message(),
       exit_editor(), filename, Textdraw::gotoxy(), input_box(), and width.

       Referenced by keypress().

   ssttrriinngg** qquueerryy__tteerrmmbbuuff (())
       Used for debug.

       Definition at line 90 of file fulledit.c.

       References termbuf.

   rreessoollvvee__ssiiddeewwaayyss__ssccrroollll (())
       Internal function to scroll screen sideways if necessary.

       Definition at line 131 of file fulledit.c.

       References cursorx, refresh_scroll, and width.

       Referenced by do_backspace(), do_enter(), keypress(), and type_char().

   vvooiidd rreessoollvvee__vveerrttiiccaall__ssccrroollll (())
       Internal function to scroll screen vertically if necessary.

       Referenced by do_backspace(), do_enter(), and keypress().

   vvooiidd ssttaarrtt__eeddiitt ((ssttrriinngg ffnnaammee))
       Start editing!

       Definition at line 450 of file fulledit.c.

       References ans_ceol, bottom_line, cursorx, cursory, Textdraw::gotoxy(),
       height, keybuf, linenum, term_height, termbuf, text_color, title_color,
       and width.

   vvooiidd ttyyppee__cchhaarr ((ssttrriinngg cc))
       Called to 'type' a character into the editor. Modifies buffer, etc.

       Definition at line 165 of file fulledit.c.

       References cursorx, cursory, file_modified, linenum, refresh_line, and
       resolve_sideways_scroll().

       Referenced by keypress().

MMEEMMBBEERR DDAATTAA DDOOCCUUMMEENNTTAATTIIOONN
   ssttrriinngg aannss__cceeooll
       Lookup the ANSI code (if any) and save it; avoids some ANSI parsing
       overhead from the MUD.

       Definition at line 34 of file fulledit.c.

       Referenced by draw_line(), draw_text(), and start_edit().

   iinntt bboottttoomm__lliinnee
       Terminal settings.

       Definition at line 53 of file fulledit.c.

       Referenced by catch_tell(), create(), draw_text(), keypress(), and
       start_edit().

   oobbjjeecctt ccaalllleerr
       Name of the object who requested editing service.

       Definition at line 58 of file fulledit.c.

       Referenced by exit_editor(), and init_return().

   iinntt ccuurrssoorrxx
       Used for storing cursor position.

       Definition at line 45 of file fulledit.c.

       Referenced by do_backspace(), do_enter(), keypress(),
       resolve_sideways_scroll(), start_edit(), and type_char().

   iinntt ccuurrssoorryy
       Used for storing cursor position.

       Definition at line 45 of file fulledit.c.

       Referenced by curr_line(), do_backspace(), do_enter(), draw_line(),
       keypress(), start_edit(), and type_char().

   iinntt ffiillee__mmooddiiffiieedd
       Has the file been modified?

       Definition at line 42 of file fulledit.c.

       Referenced by do_backspace(), do_enter(), and type_char().

   ssttrriinngg ffiilleennaammee
       Name of the file/variable being edited.

       Definition at line 29 of file fulledit.c.

       Referenced by mainmenu().

   iinntt hheeiigghhtt
       Terminal settings.

       Definition at line 53 of file fulledit.c.

       Referenced by catch_tell(), create(), input_box(), and start_edit().

   ssttrriinngg kkeeyybbuuff
       Text edited in an object.

       Definition at line 51 of file fulledit.c.

       Referenced by create(), keypress(), and start_edit().

   ssttrriinngg llaasstt__sseeaarrcchh
       The last string searched for, used for 'search for next...'.

       Definition at line 507 of file fulledit.c.

       Referenced by keypress().

   iinntt lliinneennuumm
       Terminal settings.

       Definition at line 53 of file fulledit.c.

       Referenced by curr_line(), do_backspace(), do_enter(), draw_line(),
       draw_text(), keypress(), start_edit(), and type_char().

   iinntt rreeaadd__oonnllyy
       Is the file read-only?

       Definition at line 40 of file fulledit.c.

   iinntt rreeffrreesshh__lliinnee
       Refresh flags; indicates what needs refreshing.

       Definition at line 37 of file fulledit.c.

       Referenced by do_backspace(), draw_line(), and type_char().

   iinntt rreeffrreesshh__ssccrroollll
       Refresh flags; indicates what needs refreshing.

       Definition at line 37 of file fulledit.c.

       Referenced by do_backspace(), do_enter(), draw_text(), keypress(), and
       resolve_sideways_scroll().

   iinntt rreeffrreesshh__ssttaattuuss
       Refresh flags; indicates what needs refreshing.

       Definition at line 37 of file fulledit.c.

       Referenced by catch_tell().

   ssttrriinngg rreettuurrnn__ffuunncc
       Name of the function to be called when finished.

       Definition at line 59 of file fulledit.c.

       Referenced by exit_editor(), and init_return().

   iinntt ssttrriinngg__ffoorrmmaatt
       Remember if the variable type queried was a string or not.

       Definition at line 48 of file fulledit.c.

   iinntt ttaabb__ssiizzee
       Number of spaces per tab.

       Definition at line 62 of file fulledit.c.

       Referenced by create(), and keypress().

   iinntt tteerrmm__hheeiigghhtt
       Height of the user's terminal window.

       Definition at line 32 of file fulledit.c.

       Referenced by catch_tell(), create(), and start_edit().

   ssttrriinngg** tteerrmmbbuuff
       Buffer for received messages at bottom;.

       Definition at line 56 of file fulledit.c.

       Referenced by catch_tell(), create(), exit_editor(), query_termbuf(),
       and start_edit().

   ssttrriinngg tteexxtt__ccoolloorr
       Lookup the ANSI code (if any) and save it; avoids some ANSI parsing
       overhead from the MUD.

       Definition at line 34 of file fulledit.c.

       Referenced by do_backspace(), draw_line(), draw_text(), and
       start_edit().

   ssttrriinngg ttiittllee__ccoolloorr
       Lookup the ANSI code (if any) and save it; avoids some ANSI parsing
       overhead from the MUD.

       Definition at line 34 of file fulledit.c.

       Referenced by start_edit().

   iinntt ttoottaall__lliinneess
       Terminal settings.

       Definition at line 53 of file fulledit.c.

       Referenced by do_backspace(), do_enter(), draw_line(), draw_text(), and
       keypress().

   iinntt wwiiddtthh
       Terminal settings.

       Definition at line 53 of file fulledit.c.

       Referenced by catch_tell(), create(), draw_line(), draw_text(),
       input_box(), keypress(), mainmenu(), resolve_sideways_scroll(), and
       start_edit().


AAUUTTHHOORR
       Generated automatically by Doxygen for Walraven from the source code.



Walraven                          8 Jan 2004                       Fulledit(3)
