ExplorerCombo Help File

ExplorerCombo Help File

Plugin Name:

ExplorerCombo

Current Version:

1.0.0.1

Description:

Creates a ComboBox that lets you display a path and all its parent folders so the user can choose one of them.

Licence:

Freeware

Author:

RizlaUK

Web:

www.luadevils.com

E-mail:

rizlauk@luadevils.com


Table of Contents

ExplorerCombo.Create
ExplorerCombo.SetCallback
ExplorerCombo.GetSelectedPath
ExplorerCombo.SetSelectedPath

ExplorerCombo.Create


(boolean) ExplorerCombo.Create ( 

(string) Object,

(string) Path = "",

(table) Flags = nil )

Description

Creates a ExplorerCombo object.

Parameters

Object

(string) The name of the AMS host object.

Path

(string) The initial displayed directory/file.

Note: This must be the full path to the folder, not a local path!

Flags

(table) Flags can be a combination of the following values:

CONSTANT

VALUE

DESCRIPTION

DrivesOnly

Boolean

The combo will only display drives To choose from.

Editable

Boolean

The combo will be editable With an autocomplete feature. With this flag set, it acts exactly like the one in Windows Explorer.

NoMyDocuments

Boolean

The 'My Documents' Folder will Not be displayed As a separate item.

Returns

(boolean) True if the object was created, false if not.


Example


--[[

The callback function exposes the following events:

OnSetFocus : sArgument = ""

OnKillFocus : sArgument = ""

OnSelect : sArgument = Selected path or ""

OnOpen : sArgument = ""

OnClose : sArgument = ""


]]

Debug.ShowWindow();

function MyCallback(sObject, sEvent, sArgument)

Debug.Print("Object="..sObject.." - Event="..sEvent.." - sArgument="..sArgument.."\r\n")

end


local bCreate = ExplorerCombo.Create("ComboBox1", "", nil);
if bCreate then
    
    ExplorerCombo.SetCallback ("ComboBox1", "MyCallback");

    
end



ExplorerCombo.SetCallback


ExplorerCombo.SetCallback ( 

(string) Object,

(string) Function )

Description

Sets the objects callback function.

Parameters

Object

(string) The name of the host object.

Function

(string) The name of the callback function.

Returns

This action dose not return any value.


ExplorerCombo.GetSelectedPath


(string) ExplorerCombo.GetSelectedPath ( 

(string) Object )

Description

Gets the path to the currently selected folder.

Parameters

Object

(string) The name of the host object.

Returns

(string) The full path to the current active folder, or a blank string ("") is no selection.


ExplorerCombo.SetSelectedPath


ExplorerCombo.SetSelectedPath ( 

(string) Object,

(string) Path )

Description

Sets the path to the currently selected folder.

Note: This must be the full path to the folder, not a local path!

Parameters

Object

(string) The name of the host object.

Path

(string) The path to the file/folder to select.

Returns

This action dose not return any value.




This File Was Generated With AMS ActionFile Editor