Textbox

From IfsoGUIWiki

Textbox

Type: ifsoGUI_Textbox
Module: ifsogui.textbox
Extends: ifsoGUI_Base
Imports: None

General

The textbox gadget is used to get a line of text from the user.

Events

• ifsoGUI_EVENT_CLICK – Occurs when the user clicks on the textbox with the left mouse button. Data is set to the cursor position in the textbox.
• ifsoGUI_EVENT_RIGHT_CLICK - Occurs when the user clicks on the textbox with the right mouse button. Data is set to the cursor position in the textbox.
• ifsoGUI_EVENT_MIDDLE_CLICK - Occurs when the user clicks on the textbox with the middle mouse button. Data is set to the cursor position in the textbox.
• ifsoGUI_EVENT_CHANGE – The text in the textbox has been changed. Occurs when the gadget loses focus.
• ifsoGUI_EVENT_KEYHIT – A key was pressed in the textbox. Data contains the value of the keypress. MouseX/Y are set to 0.
• 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.
• ifsoGUI_EVENT_CUT - User has requested a Cut. (Ctrl-X).
• ifsoGUI_EVENT_COPY - User has requested a Copy. (Ctrl-C).
• ifsoGUI_EVENT_PASTE - User has requested a Paste. (Ctrl-V).

Functions

Functions used by the programmer to use the gadgets.

• Create:ifsoGUI_TextBox(iX:Int, iY:Int, iW:Int, iH:Int, strName:String, strText: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.
• CutSelection:String() - Returns the selected text and removes it from the gadget.
• GetAbsoluteXY(iX:Int Var, iY:Int Var, caller:ifsoGUI_Base = Null) - Retrieves the gadgets Absolute x and y position.
• GetCursorBlinkRate:Int() - Returns the rate at which the cursor blinks.
• GetCursorPosition:Int() - Returns the character position of the cursor.
• GetCursorWidth:Int() - Returns the width of the cursor bar.
• 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.
• GetProperty:Object(key:String) - Returns a custom property.
• GetReadOnly:Int() - Returns whether or not the textbox is read only.
• GetSelectBegin:Int() - Returns the location of the selection beginning.
• GetSelection:String() - Returns the selected text.
• GetShowBorder:Int() - Returns whether or not the border is showing.
• GetShowFocus:Int() - Returns whether or not the gadget will show the focus box.
• GetTabOrder:Int() - Returns the gadgets TabOrder.
• GetText:String() - Returns the text in the textbox.
• 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.
• InsertText(strText:String) - Inserts text at the cursor position.
• SendToBack() - Sends the gadget to the back of its parent child list.
• 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.
• SetCursorBlinkRate(iBlinkRate:Int) - Sets the blink rate of the cursor.
• SetCursorPosition(iPosition:Int) - Sets the character position of the cursor.
• SetCursorWidth(iCursorWidth:Int) - Sets the width of the cursor bar.
• SetEnabled(bEnabled:Int = True) - Sets the gadget enabled/disabled.
• SetFilter(funcFilter:Int(key:Int, gadget:ifsoGUI_Base)) - Sets the function to use to filter keypresses.
• 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.
• SetProperty(key:String, value:Object) - Set a custom property.
• SetReadOnly(bReadOnly:Int) - Sets the textbox to be read only or not.
• SetSelectBegin(iBegin:Int) - Sets The Selection begining.
• SetSelectColor(iRed:Int, iGreen:Int, iBlue:Int) - Sets the selection color.
• SetShowBorder(bShowBorder:Int) - Sets whether or not the border will show.
• 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
• SetText(NewValue:String) - Sets the text in the textbox.
• 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.

Skinning

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