ComboIcon Action Plugin Help File

ComboIcon Action Plugin Help File

Plugin Name:

ComboIcon Action Plugin

Current Version:

1.0.0.1

Description:

The ComboIcon is a powerful but easy to use advanced combobox object that supports variable size icons and custom colors.

Licence:

Commerical Plugin

More Info

Author:

Dean Hall (AKA) RizlaUK

Web:

luadevils.com

E-mail:

rizlauk@luadevils.com

Requirements:

Explorer objects require AMSWaves 'Memory' plugin for its call backsystem.

Memory Plugin

Copyright:

Copyright © 2010 Lua Devils

Install Notes:

Copy folder ComboIcon' to your AMS install directory '\Plugins\Actions'


Table of Contents

ComboIcon.AddItem
ComboIcon.CountItems
ComboIcon.Create
ComboIcon.EnterKey
ComboIcon.GetAlign
ComboIcon.GetBackCol
ComboIcon.GetEnabled
ComboIcon.GetIconSize
ComboIcon.GetItemHeight
ComboIcon.GetItemIcon
ComboIcon.GetItemText
ComboIcon.GetPos
ComboIcon.GetSelectBackCol
ComboIcon.GetSelectTextCol
ComboIcon.GetSelected
ComboIcon.GetSize
ComboIcon.GetTextCol
ComboIcon.GetUnpackPath
ComboIcon.GetVisible
ComboIcon.InsertItem
ComboIcon.LoadIcon
ComboIcon.RemoveItem
ComboIcon.Reset
ComboIcon.SetAlign
ComboIcon.SetBackCol
ComboIcon.SetEnabled
ComboIcon.SetIconSize
ComboIcon.SetItemHeight
ComboIcon.SetItemIcon
ComboIcon.SetItemText
ComboIcon.SetPos
ComboIcon.SetSelectBackCol
ComboIcon.SetSelectTextCol
ComboIcon.SetSelected
ComboIcon.SetSize
ComboIcon.SetTextCol
ComboIcon.SetUnpackPath
ComboIcon.SetVisible

ComboIcon.AddItem


(number) ComboIcon.AddItem ( 

(number) nComboIconID,

(string) Text,

(number) IconID = nil )

Description

Adds an item to the Comboicon object.

Note: The list is sorted automaticly after adding a item if "Sort" flag is set.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Text

(string) The text to add the the ComboIcon object.

Note: Multiline text is supported (\r\n)

IconID

(number) The ID of the icon as returned with ComboIcon.LoadIcon

Note: The icon will be automaticly resized to the default icon size for the ComboIcon object.
You can change the default size of the displayed icon with "ComboIcon.SetIconSize".

Returns

(number) The return value is the zero-based index to the string in the list box of the combo box. If an error occurs, the return value is -1.


ComboIcon.CountItems


(number) ComboIcon.CountItems ( 

(number) nComboIconID )

Description

Conts the items in the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(number) The number of items currently in the list, if any error -1 is returned.


ComboIcon.Create


(number) ComboIcon.Create ( 

(number) X,

(number) Y,

(number) Width,

(number) Height,

(table) Flags = nil )

Description

Creates a ComboIcon object.

Parameters

X

(number) The X position of the object.

Y

(number) The Y position of the object.

Width

(number) The width of the object.

Height

(number) The height of the object.

Flags

(table) The optional falgs table.

CONSTANT

VALUE

DESCRIPTION

Upper

8192

The text is displayed in upper case.

Lower

16384

The text is displayed in lower case.

Editible

66

The Comboicon is editible
Note: It is not recomended to use this flag whan useing icons!

Sort

256

The ComboIcon Items are automaticly sorted.

Returns

(number) Returns a numeric ID for the object, if any error then nil is returned.


ComboIcon.EnterKey


ComboIcon.EnterKey ( 

(string) Key )

Description

Enter your key here.

Parameters

Key

(string) The key you recived whren you purchased this plugin.

Returns

This action dose not return any value.


ComboIcon.GetAlign


(number) ComboIcon.GetAlign ( 

(number) nComboIconID )

Description

Gets the text alignment of the combo.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(number) The text alignment state
0=Left (Default)
1=Center
2=Right


ComboIcon.GetBackCol


(number) ComboIcon.GetBackCol ( 

(number) nComboIconID )

Description

Gets the background color of the combo.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(number) The decimal color value, is any error -1 is returned.


ComboIcon.GetEnabled


(boolean) ComboIcon.GetEnabled ( 

(number) nComboIconID )

Description

Get the enabled state of the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(boolean) True if the button is enabled, false if it is disabled. If an error occurs, false will be returned.


ComboIcon.GetIconSize


(table) ComboIcon.GetIconSize ( 

(number) nComboIconID )

Description

Gets the icon size for the ComboIcon object.

Note: This is the global size for the icons and does not apply to individual items.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(table) A table containing the icons pixel dimensions, indexed by values "Width" and "Height." If any error nil will be returned.


ComboIcon.GetItemHeight


(number) ComboIcon.GetItemHeight ( 

(number) nComboIconID )

Description

Sets the height of the ComboIcon items height.

Note: This is a global height and does not apply to individual items

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(number) The height of the combos list items, if any error -1 is returned.


ComboIcon.GetItemIcon


(number) ComboIcon.GetItemIcon ( 

(number) nComboIconID,

(number) Position )

Description

Gets the IconID from the specified item in the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Position

(number) The position of the item whos IconID to retrieve.

Returns

(number) The numeric ID of the items current icon, if the item contains no item or any error nil is retuened.


ComboIcon.GetItemText


(string) ComboIcon.GetItemText ( 

(number) nComboIconID,

(number) Position )

Description

Gets the text from the specified item in the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Position

(number) The position of the item whos text to retrieve.

Returns

(string) A string containing the item's text. If an error occurs, a blank string "" will be returned.


ComboIcon.GetPos


(table) ComboIcon.GetPos ( 

(number) nComboIconID )

Description

Gets the position of the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(table) A table containing the object's current coordinates, indexed by values X and Y. If the object cannot be found, nil will be returned.


ComboIcon.GetSelectBackCol


(number) ComboIcon.GetSelectBackCol ( 

(number) nComboIconID )

Description

Gets the selection background color of the combo.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(number) The decimal color value, is any error -1 is returned.


ComboIcon.GetSelectTextCol


(number) ComboIcon.GetSelectTextCol ( 

(number) nComboIconID )

Description

Gets the selection text color of the combo.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(number) The decimal color value, is any error -1 is returned.


ComboIcon.GetSelected


(number) ComboIcon.GetSelected ( 

(number) nComboIconID )

Description

Gets the current selection in the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(number) The o based index of the selected item, if no item is selected or any error -1 is returned.


ComboIcon.GetSize


(table) ComboIcon.GetSize ( 

(number) nComboIconID )

Description

Gets the size of the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(table) A table containing the object's pixel dimensions, indexed by values "Width" and "Height." If the object cannot be found, nil will be returned.


ComboIcon.GetTextCol


(number) ComboIcon.GetTextCol ( 

(number) nComboIconID )

Description

Gets the text color of the combo.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(number) The decimal color value, is any error -1 is returned.


ComboIcon.GetUnpackPath


ComboIcon.GetUnpackPath ()

Description

Gets the unpack path for the plugins external dll resource.

Returns

This action dose not return any value.


ComboIcon.GetVisible


(boolean) ComboIcon.GetVisible ( 

(number) nComboIconID )

Description

Get the visible state of the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

(boolean) True if the button is visible, false if it's invisible. If an error occurs, false will be returned.


ComboIcon.InsertItem


(number) ComboIcon.InsertItem ( 

(number) nComboIconID,

(number) Position,

(string) Text,

(number) IconID = nil )

Description

Inserts an item to the Comboicon object.

Note: Unlike "ComboIcon.AddItem", the list is NOT sorted when a item is added.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Position

(number) The position where to insert this item

Text

(string) The text to add the the ComboIcon object.

Note: The icon will be automaticly resized to the default icon size for the ComboIcon object.

IconID

(number) The ID of the icon as returned with ComboIcon.LoadIcon

Note: The icon will be automaticly resized to the default icon size for the ComboIcon object.
You can change the default size of the displayed icon with "ComboIcon.SetIconSize".

Returns

(number) The return value is the zero-based index to the string in the list box of the combo box. If an error occurs, the return value is -1.


ComboIcon.LoadIcon


(number) ComboIcon.LoadIcon ( 

(string) Path )

Description

Loads an icon into memory for later use.

Note: Only .ico format is supported.

Parameters

Path

(string) The path to the folder you want to unpact the dll to.

Returns

(number) A numeric ID for the icon, if any error nil is returned.


ComboIcon.RemoveItem


ComboIcon.RemoveItem ( 

(number) nComboIconID,

(number) Position )

Description

Removes an item from the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Position

(number) The position of the item to remove.

Returns

This action dose not return any value.


ComboIcon.Reset


ComboIcon.Reset ( 

(number) nComboIconID )

Description

Removes all items from the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Returns

This action dose not return any value.


ComboIcon.SetAlign


ComboIcon.SetAlign ( 

(number) nComboIconID,

(number) Align )

Description

Sets the text alignment of the combo.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Align

(number) The alignment to set.

CONSTANT

VALUE

DESCRIPTION

CB_LEFT

0

Aligns the text to the left.

CB_CENTER

1

Aligns the text to the center.

CB_RIGHT

2

Aligns the text to the right.

Returns

This action dose not return any value.


ComboIcon.SetBackCol


ComboIcon.SetBackCol ( 

(number) nComboIconID,

(number) Color )

Description

Sets the background color of the combo.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Color

(number) The decimal color value.

Returns

This action dose not return any value.


ComboIcon.SetEnabled


ComboIcon.SetEnabled ( 

(number) nComboIconID,

(boolean) Visible )

Description

Set the enabled state of the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Visible

(boolean) True to show the object.

Returns

This action dose not return any value.


ComboIcon.SetIconSize


ComboIcon.SetIconSize ( 

(number) nComboIconID,

(number) Width,

(number) Height )

Description

Sets the icon size for the ComboIcon object.

Note: This is the global size for the icons and does not apply to individual items.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Width

(number) The width of the icon

Height

(number) The height of the icon.

Returns

This action dose not return any value.


ComboIcon.SetItemHeight


ComboIcon.SetItemHeight ( 

(number) nComboIconID,

(number) Height )

Description

Sets the height of the ComboIcon items height.

Note: This is a globla height and does not apply to individual items

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Height

(number) The height of the items.

Returns

This action dose not return any value.


ComboIcon.SetItemIcon


ComboIcon.SetItemIcon ( 

(number) nComboIconID,

(number) Position,

(number) IconID )

Description

Sets the IconID for the specified item in the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Position

(number) The position of the item whos IconID to retrieve.

IconID

(number) The new IconID for this item.

Returns

This action dose not return any value.


ComboIcon.SetItemText


ComboIcon.SetItemText ( 

(number) nComboIconID,

(number) Position,

(string) Text )

Description

Sets the text for the specified item in the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Position

(number) The position of the item whos text to retrieve.

Text

(string) The new text for this item.

Note: Multiline text is supported (\r\n)

Returns

This action dose not return any value.


ComboIcon.SetPos


ComboIcon.SetPos ( 

(number) nComboIconID,

(number) X,

(number) Y )

Description

Sets the position of the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

X

(number) The X position of the object

Y

(number) The Y position of the object.

Returns

This action dose not return any value.


ComboIcon.SetSelectBackCol


ComboIcon.SetSelectBackCol ( 

(number) nComboIconID,

(number) Color )

Description

Sets the selection background color of the combo.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Color

(number) The decimal color value.

Returns

This action dose not return any value.


ComboIcon.SetSelectTextCol


ComboIcon.SetSelectTextCol ( 

(number) nComboIconID,

(number) Color )

Description

Sets the selection text color of the combo.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Color

(number) The decimal color value.

Returns

This action dose not return any value.


ComboIcon.SetSelected


ComboIcon.SetSelected ( 

(number) nComboIconID,

(number) Position )

Description

Sets the current selection in the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Position

(number) The position of the item to select.

Returns

This action dose not return any value.


ComboIcon.SetSize


ComboIcon.SetSize ( 

(number) nComboIconID,

(number) Width,

(number) Height )

Description

Sets the size of the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Width

(number) The width of the object

Height

(number) The height of the object.

Returns

This action dose not return any value.


ComboIcon.SetTextCol


ComboIcon.SetTextCol ( 

(number) nComboIconID,

(number) Color )

Description

Sets the text color of the combo.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Color

(number) The decimal color value.

Returns

This action dose not return any value.


ComboIcon.SetUnpackPath


(string) ComboIcon.SetUnpackPath ( 

(string) Path )

Description

Sets the unpack path for the plugins external dll resource.

Parameters

Path

(string) The path to the folder you want to unpact the dll to.

Returns

(string)


ComboIcon.SetVisible


ComboIcon.SetVisible ( 

(number) nComboIconID,

(boolean) Visible )

Description

Set the visible state of the ComboIcon object.

Parameters

nComboIconID

(number) The numeric ID of the object as returned with ComboIcon.Create

Visible

(boolean) True to show the object.

Returns

This action dose not return any value.



Copyright © 2010 Lua Devils
This File Was Generated With AMS ActionFile Editor