World of Hello
Public Member Functions | List of all members
CreateDropList Class Reference

a drop list element. More...

Inheritance diagram for CreateDropList:
element event

Public Member Functions

 CreateDropList (int x=0, int y=0, int w=100, int h=200)
 create a drop list. More...
 
element setSelected (int ind)
 sets the selected item by index. More...
 
int getSelected ()
 gets the selected item by index. More...
 
string getSelectedName ()
 gets the selected item's text. More...
 
element addItem (string item)
 adds an item to the list. More...
 
string getItem (int ind)
 gets an item by index. More...
 
element removeItem (int ind)
 removes an item by index. More...
 
int getItemCount ()
 gets the amount of items in the list. More...
 
element clear ()
 clears all items from the list. More...
 
- Public Member Functions inherited from element
conditional< string, bool > runScript ()
 run the element's script once. More...
 
element setRunScript (bool runScript=true)
 runs the script each frame. More...
 
element setScript (string code)
 set the element's script. More...
 
string getScript ()
 get the current code of the element. More...
 
conditional< string, bool > doScriptString (string code)
 does a script string. More...
 
element blockFunction (string functionName, bool block=true)
 blocks a function from being used outside of the current script. More...
 
string getID ()
 get the ID of the element. More...
 
bool setID (string ID)
 set the ID of the element. More...
 
float getX ()
 get the X axis of the element. More...
 
float getY ()
 get the Y axis of the element. More...
 
float getWidth ()
 get the width of the element. More...
 
float getHeight ()
 get the height of the element. More...
 
element bringToFront ()
 brings the element to the top-most layer. More...
 
element bringToBack ()
 brings the element to the bottom-most layer. More...
 
element setX (float X)
 sets the X axis of the element More...
 
element setY (float Y)
 sets the Y axis of the element. More...
 
element setWidth (float width)
 sets the width of the element. More...
 
element setWidth (float height)
 sets the height of the element. More...
 
element setScale (float scale)
 sets the scale of the element. More...
 
element setScale (float widthScale, float heightScale)
 sets the width and height scale of the element. More...
 
element setMaintainAspectRatio (bool maintainAspectRatio=true)
 sets whether or not changing the width/height maintains aspect ratio scaling. More...
 
element center ()
 centers the element. More...
 
element setScalePosition ()
 sets that setScale() should also scale the element's position. More...
 
element setScalePosition (bool scalePosition)
 sets whether or not setScale() should also scale the element's position. More...
 
element setScalePosition (bool scaleX, bool scaleY)
 sets whether or not setScale() should also scale the element's X and Y position. More...
 
element setCollisionWith (element elem)
 add collision with another element. More...
 
element removeCollisionWith (element elem)
 removes the collision with another element. More...
 
element setMinWidth (float minWidth)
 sets the minimum resize width. More...
 
element setMinHeight (float minHeight)
 sets the minimum resize height. More...
 
element setMaxWidth (float maxWidth)
 sets the maximum resize width. More...
 
element setMaxHeight (float maxHeight)
 sets the maximum resize height. More...
 
string getType ()
 get the type of this element. More...
 
element setPosition (float X, float Y)
 set the position of the element. More...
 
multiReturn< float, float > getPosition ()
 gets the position of the element. More...
 
element setTabEnabled (bool enabled=true)
 sets whether or not you can tab to get to this element. More...
 
element setTabOrder (int orderNo)
 sets the order in which this element can be tabbed to. More...
 
element setClipped (bool clipped)
 sets whether the element should be cut off by it's rectangle. More...
 
element setDPIAware (bool dpiAware=true)
 
element setDefaultControls (bool defaultControls, float speed)
 sets whether the element can be moves with keys. More...
 
element setFocused (bool focused=true)
 set the focus of the element. More...
 
bool isFocused ()
 get whether or not the element is in focus. More...
 
element setMovable (bool movable=true, int movableHeight=-1)
 sets the movability of the element. More...
 
element setMovableBoundaries (int x, int y, int endX, int endY)
 sets the movable boundaries. More...
 
multiReturn< int, int, int, int > getMovableBoundaries ()
 gets the movable boundaries. More...
 
bool hitsBoundary (string direction)
 checks if the element has collided with a boundary. More...
 
element setResizable (bool resizable=true)
 sets whether the element is resizable. More...
 
element setResizableDepth (int resizableDepth)
 sets the depth of the pixels the user must click to resize an element. More...
 
element setRect (int x, int y, int width, int height)
 sets the rectangle of the element. More...
 
element hide ()
 sets the element to be invisible. More...
 
element show ()
 sets the element to be visible. More...
 
element setVisible (bool visible=true)
 sets the visibility of the element. More...
 
bool isVisible ()
 get the visibility of the element. More...
 
element addElement (element elem)
 adds a child element. More...
 
element setParent (element elem)
 adds this element as a child of the given element. More...
 
element removeElement (element elem)
 removes a child element. More...
 
element[] getElements ()
 gets all child elements. More...
 
element getParent ()
 get the parent element. More...
 
element resetLayers ()
 resets the order of the layers. More...
 
void remove ()
 removes the element. More...
 
string getObject (bool includeChildren=true)
 get the element as a total object. More...
 
element doCommands (string cmd)
 creates the element from an object like a server command. More...
 
element removeFromClients ()
 removes the element from all online clients. More...
 
element sendToClients (bool removeOthers=false, string key="", string keyAns="")
 sends the element to all connected clients who meet the criteria. More...
 
element setProperty (string property, string value)
 sets a property of the element to be sent next. More...
 
string getProperty (string property)
 gets the value of a set property. More...
 
string[] getProperties ()
 gets all properties from the object. More...
 
element removeProperty (string property)
 removes a property from the object. More...
 
element clearProperties ()
 removes all properties from the object. See removeProperty() More...
 
bool setParentScript (string scriptPath)
 sets the parent script. More...
 
- Public Member Functions inherited from event
void setEventListener (ElementEvent event, function func,...)
 sets a function to run on the given event. Removes all other event listeners of the same event type. More...
 
void addEventListener (ElementEvent event, function func,...)
 adds a function to run on the given event. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from element
static void drawRectangle (int x, int y, int width=100, int height=50, bool border=false, int r=0, int g=0, int b=0, int a=255, clipX=0, clipY=0, clipWidth=game:getWindowWidth(), clipHeight=game:getWindowHeight())
 draws a 2D rectangle on top of the element. More...
 

Detailed Description

a drop list element.

Constructor & Destructor Documentation

◆ CreateDropList()

CreateDropList::CreateDropList ( int  x = 0,
int  y = 0,
int  w = 100,
int  h = 200 
)

create a drop list.

   Creates a drop list element where one item can be selected from.\n
   Once there are enough items in the drop list, a scroll bar will automatically be created on the list.\n
   Derives all element functions.
Parameters
(optional)The X axis the list should be placed on the screen.
(optional)The Y axis the list should be placed on the screen.
(optional)The width of the list.
(optional)The height of the list.

Member Function Documentation

◆ addItem()

element CreateDropList::addItem ( string  item)

adds an item to the list.

Parameters
Theitem to be added.
Returns
Returns itself.

◆ clear()

element CreateDropList::clear ( )

clears all items from the list.

Returns
Returns itself.

◆ getItem()

string CreateDropList::getItem ( int  ind)

gets an item by index.

   Gets an item by it's index. Indexing starts at 0.
Returns
The item the given index.

◆ getItemCount()

int CreateDropList::getItemCount ( )

gets the amount of items in the list.

Returns
The amount of items in the list.

◆ getSelected()

int CreateDropList::getSelected ( )

gets the selected item by index.

   Gets the number of the item that is selected.\n
   Indexing starts at 0.
Returns
The index of the item that is selected.

◆ getSelectedName()

string CreateDropList::getSelectedName ( )

gets the selected item's text.

Returns
The name of the item that is selected.

◆ removeItem()

element CreateDropList::removeItem ( int  ind)

removes an item by index.

   Removes an item by it's index. Indexing starts at 0.
Parameters
Theitem index to be removed.
Returns
Returns itself.

◆ setSelected()

element CreateDropList::setSelected ( int  ind)

sets the selected item by index.

   Sets the selected item by index.\n
   Indexing start at 0.
Parameters
Theindex of the item to be selected.
Returns
Returns itself.