ExplorerList Help File

ExplorerList Help File

Plugin Name:

ExplorerList

Current Version:

1.0.0.0

Licence:

Freeware

Author:

Dean Hall (AKA) RizlaUK

Web:

www.luadevils.com

E-mail:

rizlauk@luadevils.com


Table of Contents

ExplorerList.SetPath
ExplorerList.GetPath
ExplorerList.GetSelected
ExplorerList.SetPattern
ExplorerList.DropFilesAccept
ExplorerList.SetView

ExplorerList.SetPath


ExplorerList.SetPath ( 

(string) ObjectName,

(string) Path )

Description

Sets the currently displayed directory.

Parameters

ObjectName

(string) The name of the object.

Path

(string) The full path to the directory to display.

Returns

This action dose not return any value.


ExplorerList.GetPath


(string) ExplorerList.GetPath ( 

(string) ObjectName )

Description

Gets the currently displayed directory.

Parameters

ObjectName

(string) The name of the object.

Returns

(string) The full path to the current displayed directory, if any error, a blank string ("") is returned.


ExplorerList.GetSelected


(table) ExplorerList.GetSelected ( 

(string) ObjectName )

Description

Gets information about the selected item.

Parameters

ObjectName

(string) The name of the object.

Returns

(table) A table index by the values "Name" and "Type", if any error, nil is returned.


Example

tSel = ExplorerList.GetSelected("ExplorerList_0");
if tSel then
    Dialog.Message("Selected Item", "Name="..tSel.Name.."\r\nType="..tSel.Type)
end



ExplorerList.SetPattern


ExplorerList.SetPattern ( 

(string) ObjectName,

(string) Pattern )

Description

Sets the currently displayed file pattern.

Parameters

ObjectName

(string) The name of the object.

Pattern

(string) The file pattern/s to display (EG: "*.txt;*.lua")

Returns

This action dose not return any value.


ExplorerList.DropFilesAccept


ExplorerList.DropFilesAccept ( 

(string) ObjectName,

(boolean) Enable )

Description

Enablers the user to drop a file onto the object.

Parameters

ObjectName

(string) The name of the object.

Enable

(boolean) True to enable file drop, false to disable it.

Returns

This action dose not return any value.


ExplorerList.SetView


ExplorerList.SetView ( 

(string) ObjectName,

(number) ViewMode )

Description

Sets the currently display mode.

Parameters

ObjectName

(string) The name of the object.

ViewMode

(number) The desired view mode..

CONSTANT

VALUE

DESCRIPTION

EXPLORER_LARGEICON

0

Large icon mode.

EXPLORER_SMALLICON

1

Small icon mode.

EXPLORER_LIST

2

List icon mode.

EXPLORER_REPORT

3

Report mode (columns, default mode).

Returns

This action dose not return any value.




This File Was Generated With AMS ActionFile Editor