xToolBar Help File

xToolBar Help File

Plugin Name:

xToolBar

Current Version:

1.5.1.0

Author:

WeBuLtRa

Web:

http://webultra.blogspot.com/


Table of Contents

xToolBar.AddItem
xToolBar.Animate
xToolBar.CreateToolbar
xToolBar.GetAnimation
xToolBar.GetIconsSize
xToolBar.GetnMaxSize
xToolBar.GetnShakes
xToolBar.GetnSpace
xToolBar.GetOpacity
xToolBar.GetPos
xToolBar.HideTooltip
xToolBar.SetAnimation
xToolBar.SetIconsSize
xToolBar.SetnMaxSize
xToolBar.SetnShakes
xToolBar.SetnSpace
xToolBar.SetOpacity
xToolBar.SetPos
xToolBar.SetTooltipSide
xToolBar.ShowTooltip
xToolBar.SwitchOrientation
xToolBar.SlideUp
xToolBar.SlideDown
xToolBar.SlideLeft
xToolBar.SlideRight
xToolBar.SlideLR
xToolBar.SlideUD
xToolBar.SlideLRToggle
xToolBar.SlideUDToggle
xToolBar.SlideUpShow
xToolBar.SlideDownShow
xToolBar.SlideUDToggleShow
xToolBar.SlideUpHide
xToolBar.SlideSideHide
xToolBar.SlideSideShow
xToolBar.AnimateSizebk
xToolBar.AnimateSize

xToolBar.AddItem


(boolean) xToolBar.AddItem ( 

(string) Object,

(table) xToolBar = mTB )

Description

Adds an image or button object to an xToolBar.

Parameters

Object

(string) The object name to be added

xToolBar

(table) The xToolbar to add the object

Returns

(boolean)


xToolBar.Animate


xToolBar.Animate ( 

(number) e_X = e_X,

(number) e_Y = e_Y,

(table) xToolBar = mTB )

Description

Choose an xToolBar to animate, place this function at "On Mouse Move" event

Parameters

e_X

(number) The X position of the mouse

e_Y

(number) The Y position of the mouse

xToolBar

(table) The xToolBar to animate

Returns

This action dose not return any value.


xToolBar.CreateToolbar


(table) xToolBar.CreateToolbar ( 

(string) xToolBar_Name = "MyToolBar",

(number) X_Center = 1,

(number) Y_Center = 1,

(number) nIconSize = 48,

(number) nSpace = 1,

(number) Animation = xMODESTRAIGHT,

(boolean) Show tooltip = true,

(number) Initial opacity = 50,

(number) Orientation = 1 )

Description

Creates an xToolBar container

Parameters

xToolBar_Name

(string) The name of the xToolBar

X_Center

(number) The X center position to be the center of the xToolBar

Y_Center

(number) The Y center position to be the center of the xToolbar

nIconSize

(number) The size, in pixels, that will be applied for each item in the xToolBar

nSpace

(number) The space, in pixels, between each xToolBar item

Animation

(number) The kind of animation (1-12)

CONSTANT

VALUE

DESCRIPTION

xMODESTRAIGHT

NA

NA

xMODEUP

NA

NA

xMODEDOWN

NA

NA

xMODESTRAIGHTUP

NA

NA

xMODESTRAIGHTDOWN

NA

NA

xMODESHAKEME

NA

NA

xMODEFISHEYE_UP

NA

NA

xMODEFISHEYE_DOWN

NA

NA

xMODEFISHEYE_MIDDLE

NA

NA

xMODESHAKEME_UD

NA

NA

xMODESHAKEME_LR

NA

NA

xMODESTRAIGHTALL

NA

NA

Show tooltip

(boolean) A boolean value to choose if shows or not the tooltip object. If so, it takes the tooltip text from each added item and shows it the tooltip object (included)

Initial opacity

(number) Set the initial opacity of the image image objects. Choose -1 for not opacity change.

Orientation

(number) Set the orientation of the toolbar. 1=Horizontal and 2=Vertical.

CONSTANT

VALUE

DESCRIPTION

x_ORIENTATION_HOR

NA

NA

x_ORIENTATION_VER

NA

NA

Returns

(table)


xToolBar.GetAnimation


(number) xToolBar.GetAnimation ( 

(table) xToolBar = mTB )

Description

Gets the current animation number of an xToolBar

Parameters

xToolBar

(table) The xToolBar

Returns

(number)


xToolBar.GetIconsSize


(number) xToolBar.GetIconsSize ( 

(table) xToolBar = mTB )

Description

Gets the default icon size of an xToolBar

Parameters

xToolBar

(table) The xToolBar

Returns

(number)


xToolBar.GetnMaxSize


(number) xToolBar.GetnMaxSize ()

Description

Gets the max % to increase the items of a toolbar with FISHEYE animation

Returns

(number)


xToolBar.GetnShakes


(number) xToolBar.GetnShakes ()

Description

Gets the number of shakes for the xMODESHAKEME animation

Returns

(number)


xToolBar.GetnSpace


(number) xToolBar.GetnSpace ( 

(table) xToolBar = mTB )

Description

Gets the current space between items of an xToolBar

Parameters

xToolBar

(table) The xToolBar

Returns

(number)


xToolBar.GetOpacity


(number) xToolBar.GetOpacity ( 

(table) xToolBar = mTB )

Description

Gets the default opacity of an xToolBar

Parameters

xToolBar

(table) The xToolBar

Returns

(number)


xToolBar.GetPos


(table) xToolBar.GetPos ( 

(table) xToolBar = mTB )

Description

Gets the current X center and Y center of an xToolBar

Parameters

xToolBar

(table) The xToolBar

Returns

(table)


xToolBar.HideTooltip


(number) xToolBar.HideTooltip ( 

(table) xToolBar = mTB )

Description

Hides the tooltip of an xToolBar

Parameters

xToolBar

(table) The xToolBar to be switched

Returns

(number)


xToolBar.SetAnimation


xToolBar.SetAnimation ( 

(table) xToolBar = mTB,

(number) Animation = xMODESTRAIGHT )

Description

Sets the animation of an xToolBar

Parameters

xToolBar

(table) The xToolBar to be modded

Animation

(number) The kind of animation (1-12)

CONSTANT

VALUE

DESCRIPTION

xMODESTRAIGHT

NA

NA

xMODEUP

NA

NA

xMODEDOWN

NA

NA

xMODESTRAIGHTUP

NA

NA

xMODESTRAIGHTDOWN

NA

NA

xMODESHAKEME

NA

NA

xMODEFISHEYE_UP

NA

NA

xMODEFISHEYE_DOWN

NA

NA

xMODEFISHEYE_MIDDLE

NA

NA

xMODESHAKEME_UD

NA

NA

xMODESHAKEME_LR

NA

NA

xMODESTRAIGHTALL

NA

NA

Returns

This action dose not return any value.


xToolBar.SetIconsSize


xToolBar.SetIconsSize ( 

(table) xToolBar = mTB,

(number) Size = 48 )

Description

Sets the default size per icon of an xToolBar

Parameters

xToolBar

(table) The xToolBar to be modded

Size

(number) Size in pixels

Returns

This action dose not return any value.


xToolBar.SetnMaxSize


xToolBar.SetnMaxSize ( 

(number) nMaxSize = 100 )

Description

Sets the max size (in %) of the items in a toolbar with FISHEYE animation (DEFAULT 50%)

Parameters

nMaxSize

(number) The % of size to increase

Returns

This action dose not return any value.


xToolBar.SetnShakes


xToolBar.SetnShakes ( 

(number) nShakes = 200 )

Description

Sets the number of shakes for the xMODESHAKEME animations (Default 200)

Parameters

nShakes

(number) The number of shakes

Returns

This action dose not return any value.


xToolBar.SetnSpace


xToolBar.SetnSpace ( 

(table) xToolBar = mTB,

(number) nSpace = 10 )

Description

Sets the default space between icons of an xToolBar

Parameters

xToolBar

(table) The xToolBar to be modded

nSpace

(number) nSpace in pixels

Returns

This action dose not return any value.


xToolBar.SetOpacity


xToolBar.SetOpacity ( 

(table) xToolBar = mTB,

(number) Opacity = 50 )

Description

Sets the default opacity of an xToolBar

Parameters

xToolBar

(table) The xToolBar to be modded

Opacity

(number) Opacity

Returns

This action dose not return any value.


xToolBar.SetPos


xToolBar.SetPos ( 

(table) xToolBar = mTB,

(number) X Center = 100,

(number) Y Center = 100 )

Description

Sets X and Y position of an xToolBar

Parameters

xToolBar

(table) The xToolBar to be modded

X Center

(number) Size in pixels

Y Center

(number) Size in pixels

Returns

This action dose not return any value.


xToolBar.SetTooltipSide


xToolBar.SetTooltipSide ( 

(number) Side = x_SIDE_LEFT )

Description

Sets the side of the tooltips in Vertical oriented toolbars

Parameters

Side

(number) The side's number to place the tooltip object (LEFT=1 and RIGHT=2)

CONSTANT

VALUE

DESCRIPTION

x_SIDE_LEFT

NA

NA

x_SIDE_RIGHT

NA

NA

Returns

This action dose not return any value.


xToolBar.ShowTooltip


xToolBar.ShowTooltip ( 

(table) xToolBar = mTB )

Description

Shows the tooltip of an xToolBar

Parameters

xToolBar

(table) The xToolBar to be modded

Returns

This action dose not return any value.


xToolBar.SwitchOrientation


xToolBar.SwitchOrientation ( 

(table) xToolBar = mTB )

Description

Switch a toolbar's orientation between horizontal and vertical

Parameters

xToolBar

(table) The xToolBar to be switched

Returns

This action dose not return any value.


xToolBar.SlideUp


xToolBar.SlideUp ( 

(string) Object,

(number) Up = 100 )

Description

Set an image or button object to slide up

Parameters

Object

(string) The object name

Up

(number) Set up number

Returns

This action dose not return any value.


xToolBar.SlideDown


xToolBar.SlideDown ( 

(string) Object,

(number) Down = 100 )

Description

Set an image or button object to slide down

Parameters

Object

(string) The object name

Down

(number) Set down number

Returns

This action dose not return any value.


xToolBar.SlideLeft


xToolBar.SlideLeft ( 

(string) Object,

(number) Left = 100 )

Description

Set an image or button object to slide left

Parameters

Object

(string) The object name

Left

(number) Set left number

Returns

This action dose not return any value.


xToolBar.SlideRight


xToolBar.SlideRight ( 

(string) Object,

(number) Right = 100 )

Description

Set an image or button object to slide right.

Parameters

Object

(string) The object name

Right

(number) Set right number

Returns

This action dose not return any value.


xToolBar.SlideLR


xToolBar.SlideLR ( 

(string) Object,

(number) LR = 100,

(boolean) BOOL = true )

Description

Set an image or button object to slide LR.

Parameters

Object

(string) The object name

LR

(number) Set LR number

BOOL

(boolean) A boolean value to choose

Returns

This action dose not return any value.


xToolBar.SlideUD


xToolBar.SlideUD ( 

(string) Object,

(number) UD = 100,

(boolean) BOOL = true )

Description

Set an image or button object to slide UD.

Parameters

Object

(string) The object name

UD

(number) Set UD number

BOOL

(boolean) A boolean value to choose

Returns

This action dose not return any value.


xToolBar.SlideLRToggle


xToolBar.SlideLRToggle ( 

(string) Object,

(number) LR Toggle = 100,

(boolean) BOOL = true )

Description

Set an image or button object to slide LR toggle

Parameters

Object

(string) The object name

LR Toggle

(number) Set LR toggle number

BOOL

(boolean) A boolean value to choose

Returns

This action dose not return any value.


xToolBar.SlideUDToggle


xToolBar.SlideUDToggle ( 

(string) Object,

(number) UD Toggle = 100,

(boolean) BOOL = true )

Description

Set an image or button object to slide UD toggle

Parameters

Object

(string) The object name

UD Toggle

(number) Set UD toggle number

BOOL

(boolean) A boolean value to choose

Returns

This action dose not return any value.


xToolBar.SlideUpShow


xToolBar.SlideUpShow ( 

(string) Object )

Description

Set an image or button object to slide up show

Parameters

Object

(string) The object name

Returns

This action dose not return any value.


xToolBar.SlideDownShow


xToolBar.SlideDownShow ( 

(string) Object )

Description

Set an image or button object to slide down show

Parameters

Object

(string) The object name

Returns

This action dose not return any value.


xToolBar.SlideUDToggleShow


xToolBar.SlideUDToggleShow ( 

(string) Object )

Description

Set an image or button object to slide UD toggle show

Parameters

Object

(string) The object name

Returns

This action dose not return any value.


xToolBar.SlideUpHide


xToolBar.SlideUpHide ( 

(string) Object,

(boolean) BOOL = true )

Description

Set an image or button object to slide up hide

Parameters

Object

(string) The object name

BOOL

(boolean) A boolean value to choose

Returns

This action dose not return any value.


xToolBar.SlideSideHide


xToolBar.SlideSideHide ( 

(string) Object,

(boolean) BOOL = true )

Description

Set an image or button object to slide side hide

Parameters

Object

(string) The object name

BOOL

(boolean) A boolean value to choose

Returns

This action dose not return any value.


xToolBar.SlideSideShow


xToolBar.SlideSideShow ( 

(string) Object,

(boolean) BOOL = true )

Description

Set an image or button object to slide side show

Parameters

Object

(string) The object name

BOOL

(boolean) A boolean value to choose

Returns

This action dose not return any value.


xToolBar.AnimateSizebk


xToolBar.AnimateSizebk ( 

(string) Object,

(string) Propertie = "width",

(number) Size = 100 )

Description

AnimateSizebk

Parameters

Object

(string) The object name

Propertie

(string) String of properties.

CONSTANT

VALUE

DESCRIPTION

"width"

"width"

NA

"height"

"height"

NA

Size

(number) Size

Returns

This action dose not return any value.


xToolBar.AnimateSize


xToolBar.AnimateSize ( 

(string) Object,

(table) Properties = {width = 100, height = 100},

(string) Speed = "normal" )

Description

AnimateSize

Parameters

Object

(string) The object name

Properties

(table) Table of properties.

Speed

(string) Efect speed.

CONSTANT

VALUE

DESCRIPTION

"slow"

"slow"

NA

"normal"

"normal"

NA

"fast"

"fast"

NA

Returns

This action dose not return any value.




This File Was Generated With AMS ActionFile Editor