ToolBar.Ex Help File

Welcome

ToolBar.Ex Help File

Plugin Name:

ToolBar.Ex

Current Version:

1.0.0.0

Description:

This is an extension of reteset's ToolBar Object Plugin.

Licence:

Free to use and distribute.

Author:

CentauriSoldier

E-mail:
CentauriSoldier@AMSPublic
Requirements:
ToolBar Object Plugin
AutoPlay Media Studio 8.0
Copyright:
Install Notes:
Place the "ToolBar.Ex" folder in your "AutoPlay Media Studio 8.0\Plugins\Actions" folder.

ToolBarEx.OnButtonHighLight
ToolBarEx.OnLButtonDown
ToolBarEx.OnLButtonUp
ToolBarEx.OnMouseMove
ToolBarEx.OnSetUp
ToolBarEx.OnTTLinkClk
ToolBarEx.SetButton
ToolBarEx.SetScript

ToolBarEx.OnButtonHighLight

ToolBarEx.OnButtonHighLight (

(string) Object = "ToolBar",

(number) e_ButtonID = e_ButtonID,

(number) e_X = e_X,

(number) e_Y = e_Y )

Description

This script is placed on the event of the same name.

Parameters

Object

(string) The name of the ToolBar object to which this applies.

e_ButtonID

(number) The number returned by the ToolBar event.

Note: DO NOT CHANGE.

e_X

(number) The number returned by the ToolBar event.

Note: DO NOT CHANGE.

e_Y

(number) The number returned by the ToolBar event.

Note: DO NOT CHANGE.

Returns

This action dose not return any value.

ToolBarEx.OnLButtonDown

ToolBarEx.OnLButtonDown (

(string) Object = "ToolBar",

(number) e_ButtonID = e_ButtonID,

(number) e_X = e_X,

(number) e_Y = e_Y )

Description

This script is placed on the event of the same name.

Parameters

Object

(string) The name of the ToolBar object to which this applies.

e_ButtonID

(number) The number returned by the ToolBar event.

Note: DO NOT CHANGE.

e_X

(number) The number returned by the ToolBar event.

Note: DO NOT CHANGE.

e_Y

(number) The number returned by the ToolBar event.

Note: DO NOT CHANGE.

Returns

This action dose not return any value.

ToolBarEx.OnLButtonUp

ToolBarEx.OnLButtonUp (

(string) Object = "ToolBar",

(number) e_ButtonID = e_ButtonID,

(number) e_X = e_X,

(number) e_Y = e_Y )

Description

This script is placed on the event of the same name.

Parameters

Object

(string) The name of the ToolBar object to which this applies.

e_ButtonID

(number) The number returned by the ToolBar event.

Note: DO NOT CHANGE.

e_X

(number) The number returned by the ToolBar event.

Note: DO NOT CHANGE.

e_Y

(number) The number returned by the ToolBar event.

Note: DO NOT CHANGE.

Returns

This action dose not return any value.

ToolBarEx.OnMouseMove

ToolBarEx.OnMouseMove (

(string) Object = "ToolBar",

(number) e_X = e_X,

(number) e_Y = e_Y )

Description

This script is placed on the event of the same name.

Parameters

Object

(string) The name of the ToolBar object to which this applies.

e_X

(number) The number returned by the ToolBar event.

Note: DO NOT CHANGE.

e_Y

(number) The number returned by the ToolBar event.

Note: DO NOT CHANGE.

Returns

This action dose not return any value.

ToolBarEx.OnSetUp

ToolBarEx.OnSetUp (

(string) Object = "ToolBar",

(number) Size = 32,

(number) BitDepth = BIT_32 )

Description

This script is placed on the event of the same name.

Parameters

Object

(string) The name of the ToolBar object to which this applies.

Size

(number) The size of each icon in the image list.

Note: This function creates an image list for the object.

CONSTANT	VALUE	DESCRIPTION
16	16	NA
32	32	NA
48	48	NA
64	64	NA

BitDepth

(number) The bit depth of the image list depends on the icons you will use (if you don't know what this is then set it to 'BIT_32' ). Also, remember to set this in the objects properties as well.

CONSTANT	VALUE	DESCRIPTION
BIT_4	BIT_4	NA
BIT_8	BIT_8	NA
BIT_16	BIT_16	NA
BIT_24	BIT_24	NA
BIT_32	BIT_32	NA

Returns

This action dose not return any value.

ToolBarEx.OnTTLinkClk

ToolBarEx.OnTTLinkClk (

(string) Object = "ToolBar",

(variant) e_Url = e_Url )

Description

This script is placed on the event of the same name.

Parameters

Object

(string) The name of the ToolBar object to which this applies.

e_Url

(variant) The value returned by the ToolBar event.

Note: DO NOT CHANGE.

CONSTANT	VALUE	DESCRIPTION
e_Url	e_Url	NA

Returns

This action dose not return any value.

ToolBarEx.SetButton

ToolBarEx.SetButton (

(string) Object = "ToolBar",

(number) Position = 1,

(string) Button = "New",

(string) TooltipText = "This is a Tooltip",

(variant) Data = 32,

(boolean) Marked = false,

(boolean) Show Tooltip = true,

(string) Normal Icon = "C:\\MyIcon.ico",

(string) Highlight Icon = "",

(string) Down Icon = "" )

Description

Creates a new button or edits an existing one.

Parameters

Object

(string) The name of the ToolBar object to which this applies.

Position

(number) The button's position from left to right.

Button

(string) The name of the button (this can be any string you choose).

TooltipText

(string) The text to display in the Tooltip.

Data

(variant) The data to store.

Marked

(boolean) Whether the button is marked or not.

Show Tooltip

(boolean) Whether or not the Tooltip will be visible.

Normal Icon

(string) The path to the icon that will display normally.

Highlight Icon

(string) The path to the icon that will apear when the button is highlighted.

Note: Leave blank to use the icon loaded last.

Down Icon

(string) the path to the icon that will display when the icon is down.

Note: Leave blank to use the icon loaded last.

Returns

This action dose not return any value.

ToolBarEx.SetScript

ToolBarEx.SetScript (

(string) Object = "ToolBar",

(string) Button = "New",

(string) Event = "OnLButtonUp",

(string) Script = "Dialog.Message(\"Test\", \"It seems to be working\");" )

Description

Assigns the script that will be called when the specified button is activated.

Note: This is per event.

Parameters

Object

(string) The name of the ToolBar object to which this applies.

Button

(string) The name of the button that will call the script.

Event

(string) The event which will trigger the script.

CONSTANT	VALUE	DESCRIPTION
"OnLButtonDown"	"OnLButtonDown"	NA
"OnLButtonUp"	"OnLButtonUp"	NA
"OnButtonHightLight"	"OnButtonHightLight"	NA
"OnMouseMove"	"OnMouseMove"	NA
"OnTTLinkClk"	"OnTTLinkClk"	NA

Script

(string) The script to be called.

Returns

This action dose not return any value.

ToolBar.Ex Help File