far.AdvControl

LuaFAR 3

far.AdvControl


Result = far.AdvControl (Command, Param1, Param2)

Parameters:
  Command:  flags
  Param1:   (depends on Command); default=0
  Param2:   (depends on Command); default=0

Returns:
  Result:   (depends on Command)

Details:

ACTL_COMMIT,
ACTL_GETWINDOWCOUNT,
ACTL_PROGRESSNOTIFY,
ACTL_QUIT,
ACTL_REDRAWALL:
    Result:  integer

ACTL_GETFARHWND:
    Result:  light userdata

ACTL_SETCURRENTWINDOW,
ACTL_SYNCHRO:
    Param1:  integer
    Result:  integer

ACTL_WAITKEY:
    Param2:  table tInputRecord, or string (e.g. "CtrlF12"), or nil (for any key)
    Result:  integer

ACTL_GETCOLOR:
    Param1:  integer
    Result:  table tFarColor, or nil

ACTL_GETARRAYCOLOR:
    Result:  table (array of tFarColor tables)

ACTL_GETFARMANAGERVERSION:
    Param1:  boolean (optional)
    Result:  string (e.g. "3.0.0.2040.0"), if Param==false;
             5 numbers (e.g. 3,0,0,2040,0), if Param==true;

ACTL_GETWINDOWINFO:
    Param1:  window number; 1-based integer (optional; default=0)
    Result:  table (see its fields below), or nil.
        Type:      integer
        Id:        userdata (if Type is WTYPE_DIALOG or WTYPE_VMENU), or integer
        Pos:       integer (1-based)
        Flags:     flags
        TypeName:  string
        Name:      string

ACTL_SETARRAYCOLOR:
    Param2:  table (see its fields below;
             its array part contains colors
             (each color can be supplied as either a tFarColor table or a number)
        Flags:       flags
        StartIndex:  integer
    Result:  integer    

ACTL_SETPROGRESSSTATE:
    Param1:  flags
    Result:  integer    

ACTL_SETPROGRESSVALUE:
    Param2:  table (see its fields below)
        Completed, Total:  numbers
    Result:  integer    

ACTL_GETFARRECT:
    Result:  table (see its fields below), or nil
        Left, Top, Right, Bottom: integers

ACTL_GETCURSORPOS:
    Result:  table (see its fields below), or nil
        X, Y: integers

ACTL_SETCURSORPOS:
    Param2:  table (see its fields below)
        X, Y: integers
    Result:  integer    

ACTL_GETWINDOWTYPE:
    Result:  table (see its fields below), or nil
        Type: integer

Far API used:
  AdvControl