ImageButton

From IfsoGUIWiki

Button

Type: ifsoGUI_ImageButton
Module: ifsogui.imagebutton
Extends: ifsoGUI_Button
Imports: None

General

A push button gadget with an image on it, the button has three different graphic images: normal, mouse over, and pressed. The image on the button can also optionally have three different images for Normal, MouseOver, and MouseDown. Normal must be included, the other two are optional.

Events

• ifsoGUI_EVENT_CLICK – Occurs when the user clicks on the button with the left mouse button. Data is set to the mouse button that was clicked.
• ifsoGUI_EVENT_MOUSE_DOWN – Mouse button was pressed on the gadget. Data is set to the mouse button that was pressed.
• ifsoGUI_EVENT_MOUSE_UP – Mouse button was release on the gadget. Data is set to the mouse button that was released.
• ifsoGUI_EVENT_MOUSE_ENTER – Mouse has moved over the gadget. Data is set to 0.
• ifsoGUI_EVENT_MOUSE_EXIT – Mouse has moved away from the gadget. Data is set to 0.
• ifsoGUI_EVENT_GAIN_FOCUS – Gadget has gained the focus. Data i set to 0, iMouseX/Y are also set to 0.
• ifsoGUI_EVENT_LOST_FOCUS – Gadget has lost the focus. Data i set to 0, iMouseX/Y are also set to 0.

Functions

Functions used by the programmer to use the gadgets.

• Create:ifsoGUI_Button(iX:Int, iY:Int, iW:Int, iH:Int, strName:String, strLabel:String) - Creates and returns an instance of the gadget.

Methods/Properties

These are the methods and properties used by the programmer to use the gadgets.

• AddSound(iSoundEvent:Int, sndSound:TSound) - Add a sound to the event of a gadget.
• BringToFront() - Brings the gadget to the front of its parents child list.
• CanActive:Int() - Returns whether or not this gadget can be the active gadget.
• GetAbsoluteXY(iX:Int Var, iY:Int Var, caller:ifsoGUI_Base = Null) - Retrieves the gadgets Absolute x and y position.
• GetAutoSize:Int() - Returns whether or not to the gadget will autosize or be manually controlled by the user.
• GetEnabled:Int() - Returns whether the gadget is enabled.
• GetFont:TImageFont() - Returns the font the gadget is using.
• GetGadgetAlpha:Float() - Returns the gadgets alpha value.
• GetH:Int() - Returns the gadgets height.
• GetLabel:String() - Returns the buttons label.
• GetProperty:Object(key:String) - Returns a custom property.
• GetShowButton:Int() - Returns whether or not the button will show.
• GetShowFocus:Int() - Returns whether or not the gadget will show the focus box.
• GetShowLabel:Int() - Returns whether or not the button label will show.
• GetTabOrder:Int() - Returns the gadgets TabOrder.
• GetTip:String() - Returns the gadgets tip text.
• GetVisible:Int() - Returns whether the gadget is visible.
• GetW:Int() - Returns the gadgets width.
• GetWH(width:Int Var, height:Int Var) - Retrieves the gadgets width and height.
• GetXY(iX:Int Var, iY:Int Var) - Retrieves the gadgets x and y positions.
• SendToBack() - Sends the gadget to the back of its parent child list.
• SetAutoSize(intAutoSize:Int) - Sets whether or not to the gadget will autosize or be manually controlled by the user.
• SetBounds(iX:Int, iY:Int, iW:Int, iH:Int) - Sets the x, y, width, and height all in one call.
• SetCallBack(func(gadget:ifsoGUI_Base, id:Int, data:Int, iMouseX:Int, iMouseY:Int)) - Sets the event callback function for the gadget.
• SetEnabled(bEnabled:Int = True) - Sets the gadget enabled/disabled.
• SetFocus() - Gives the gadget the focus.
• SetFocusColor(iRed:Int, iGreen:Int, iBlue:Int) - Sets the gadgets focus box color.
• SetFont(Font:TImageFont) - Sets the font of the gadget.
• SetGadgetAlpha(fltAlpha:Float) - Sets the gadgets alpha value.
• SetGadgetColor(iRed:Int, iGreen:Int, iBlue:Int) - Sets the gadget color of the gadget.
• SetImages(imgNormal:TImage, imgOver:TImage = Null, imgDown:TImage = Null) - Sets the images that will appear.
• SetLabel(strLabel:String) - Sets the buttons label.
• SetProperty(key:String, value:Object) - Set a custom property.
• SetShowButton(bShowButton:Int) - Sets whether or not the button will show.
• SetShowFocus(intShowFocus:Int) - Sets whether or not to show the focus box for this gadget.
• SetShowLabel(bShowLabel:Int) - Sets whether or not the button label will show.
• SetTabOrder(iTabOrder:Int) - Sets the gadgets TabOrder. 0=Do not tab to this gadget -1=Last in the Tab Order
• SetTextColor(iRed:Int, iGreen:Int, iBlue:Int) - Sets the text color of the gadget.
• SetTip(strTip:String) - Sets the gadget tip text.
• SetVisible(bVisible:Int) - Sets whether the gadget is visible.
• SetWH(width:Int, height:Int) - Sets the gadgets width and height.
• SetXY(iX:Int, iY:Int) - Sets the gadgets x and y position.

Internal Functions

These function are internal to the gadget. They should only need to be called, if you are creating a gadget.

• Drawbox(images:TImage[], ws:Int[], hs:Int[], rX:Int, rY:Int, rW:Int, rH:Int, bDrawBorder:Int = True, bTileSides:Int = False, bTileCenter:Int = False) - Draws the standard ifsoGUI image based on 4 corners, 4 sides, and a center background portion.
• GetDimensions:String(strName:String) - Gets the dimensions from the dimension file for the gadgets graphics.
• Load9Image(srcpath:String, dimensions:String[], gImage:TImage[] Var, imagew:Int[] Var, imageh:Int[] Var) - Loads the graphics for an image in 9 standard parts.
• LoadTheme() - Called when a new theme is loaded, so the gadget can load its images for drawing. The base gadget does not have a LoadTheme function, but any gadget than can be created should have one.
• SystemEvent(id:Int, data:Int) - Called when a system level event occurs that all gadgets should know about, like loading a new theme or changing the default GUI font. The base gadget does not have a SystemEvent function, but any gadget than can be created should have one.

Internal Methods

These methods are called by the GUI itself and should only be used if you are creating your own gadget.

• Compare:Int(withObject:Object) - Compares two gadgets by TabOrder.
• Draw(parX:Int, parY:Int, parW:Int, parH:Int) - Draws the gadget and its children.
• DrawFocus(iX:Int, iY:Int, iW:Int, iH:Int) - Draws the focus box around the gadget.
• DrawTip(iMouseX:Int, iMouseY:Int) - Draws the gadgets tip.
• GadgetSystemEvent(id:Int, data:Int) - Gadget Level GUI system event occured.
• GainFocus(LostFocus:ifsoGUI_Base) - Called when the gadget becomes the active gadget.
• gMouseDown(iButton:Int, iMouseX:Int, iMouseY:Int) - Called when the mouse button is pressed on the gadget.
• gMouseUp(iButton:Int, iMouseX:Int, iMouseY:Int) - Called when the mouse button is released on the gadget.
• IsMouseOver:Int(parX:Int, parY:Int, parW:Int, parH:Int, iMouseX:Int, iMouseY:Int) - Returns whether or not the mouse is over the gadget.
• KeyPress(key:Int) - Called when a key is pressed on the active gadget.
• LostFocus(GainedFocus:ifsoGUI_Base) - Called when the gadget is no longer the Active Gadget.
• MouseOut(iMouseX:Int, iMouseY:Int, gOverGadget:ifsoGUI_Base) - Called when the mouse leaves the gadget.
• MouseOver(iMouseX:Int, iMouseY:Int, gWasOverGadget:ifsoGUI_Base) - Called when the mouse is over this gadget.
• MouseStatus:Int(iMouseX:Int, iMouseY:Int) - Called to determine the mouse status from the gadget.
• Refresh() - Refreshes the gadget.
• SendEvent(id:Int, data:Int, iMouseX:Int, iMouseY:Int) - Sends an event from the gadget.
• SlaveEvent(gadget:ifsoGUI_Base, id:Int, data:Int, iMouseX:Int, iMouseY:Int) - Called from a slave gadget.

Skinning

This gadget Extends the Button gadget and uses the same skins.