Scrollbar

From IfsoGUIWiki

Jump to: navigation, search

Contents

Scrollbar

Type: ifsoGUI_Scrollbar
Module: ifsogui.scrollbar
Extends: ifsoGUI_Base
Imports: None

General

The scrollbar gadget is used to allow the user to select a portion of a large list or area. It gives an indication of the size of the viewable portion by varying the size of the bar.

Events

  • ifsoGUI_EVENT_CHANGE – Gadget’s value has changed.
  • 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, iMouseX, and iMouseY are all set to 0.
  • ifsoGUI_EVENT_LOST_FOCUS – Gadget has lost the focus. Data, iMouseX, and iMouseY are all set to 0.

Functions

Functions used by the programmer to use the gadgets.

  • Create:ifsoGUI_ScrollBar(iX:Int, iY:Int, iW:Int, iH:Int, strName:String, bVertical:Int = True) - 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.
  • GetBarInterval:Int() - Returns the change in value when the bar area is clicked.
  • GetEnabled:Int() - Returns whether the gadget is enabled.
  • GetGadgetAlpha:Float() - Returns the gadgets alpha value.
  • GetH:Int() - Returns the gadgets height.
  • GetInterval:Int() - Returns the amount the value changes per tick.
  • GetMax:Int() - Returns the maximum value of the gadget.
  • GetMin:Int() - Returns the minimum value of the gadget.
  • GetProperty:Object(key:String) - Returns a custom property.
  • GetShowFocus:Int() - Returns whether or not the gadget will show the focus box.
  • GetTabOrder:Int() - Returns the gadgets TabOrder.
  • GetTip:String() - Returns the gadgets tip text.
  • GetValue:Int() - Returns the current value.
  • GetVertical:Int() - Returns whether or not the gadget is vertical.
  • 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.
  • SetBarInterval(iBarInterval:Int) - Sets the amount the value changes when the bar area is clicked.
  • 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.
  • SetGadgetAlpha(fltAlpha:Float) - Sets the gadgets alpha value.
  • SetGadgetColor(iRed:Int, iGreen:Int, iBlue:Int) - Sets the gadget color of the gadget.
  • SetInterval(intInterval:Int) - Sets the amount the value changes per tick.
  • SetMax(intMax:Int) - Sets the maximum value of the gadget..
  • SetMin(intMin:Int) - Sets the minimum value of the gadget.
  • SetMinMax(intMin:Int, intMax:Int) - Sets the minimum and maximum values of the gadget in one call.
  • SetProperty(key:String, value:Object) - Set a custom property.
  • SetShowFocus(intShowFocus:Int) - Sets whether or not to show the focus box for this gadget.
  • SetTabOrder(iTabOrder:Int) - Sets the gadgets TabOrder. 0=Do not tab to this gadget -1=Last in the Tab Order
  • SetTip(strTip:String) - Sets the gadget tip text.
  • SetValue(iNewValue:Int) - Sets the current value.
  • 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.

  • CalcBarPos() - Calculates the location of the bar.
  • 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.

Skinning

dimensions.txt keyword: scrollbar
Filename: scrollbar.png
Filename: scrollbardown.png
Filename: scrollbarover.png
This is a representation of the scrollbar slider button, the sides will be stretched or tiled the height of the button, the top and bottom will be stretched or tiled the width of the button, and the center will be stretched or tiled to the length and width of the button. The corners will remain as is and will not be stretched or tiled at all. The scrollbardown.png and scrollbarover.png files are the pressed and mouseover images.

dimensions.txt keyword: scrollbar button
Filename: scrollbutton.png
Filename: scrollbuttondown.png
Filename: scrollbuttonover.png
This is a representation of the scrollbar buttons on the ends of the scrollbar, the sides will be stretched or tiled the height of the button, the top and bottom will be stretched or tiled the width of the button, and the center will be stretched or tiled to the length and width of the button. The corners will remain as is and will not be stretched or tiled at all. The scrollbuttondown.png and scrollbuttonover.png files are the pressed and mouseover images.

dimensions.txt keyword: scrollbar background
Filename: scrollback.png
This is a representation of the background portion of the scrollbar, the sides will be stretched or tiled the height of the scrollbar, the top and bottom will be stretched or tiled the width of the scrollbar, and the center will be stretched or tiled to the length and width of the scrollbar. The corners will remain as is and will not be stretched or tiled at all.

Filename: arrow.png
This is the arrow that will be placed on the scrollbar end buttons. This graphic should normally be pointing to the right.

Retrieved from "http://wiki.ifsogui.com/index.php/Scrollbar"
Personal tools