C# Class FlatRedBall.Gui.CollapseItem

Summary description for CollapseItem.

Show file Open project: vchelaru/FlatRedBall Class Usage Examples

Public Properties

Property	Type	Description
ReferenceObject	object

Protected Properties

Property	Type	Description
itemText	string
v	Microsoft.Xna.Framework.Graphics.VertexPositionColorTexture[]

Public Methods

Method	Description
AddIcon ( Microsoft.Xna.Framework.Graphics.Texture2D texture, string name ) : ListBoxIcon
AddIcon ( float top, float bottom, float left, float right, string name ) : ListBoxIcon	Adds an icon to the CollapseItem Do not use $ in the name of the icon as the Collapse list boxes use this character for icons such as + and - boxes for expanding CollapseItems with children.
AddIcon ( float top, float bottom, float left, float right, string name, int index ) : ListBoxIcon
AddItem ( string itemToAdd ) : CollapseItem
AddItem ( string itemToAdd, object referenceObject ) : CollapseItem
AttachItemToThis ( CollapseItem itemToAdd ) : CollapseItem
ClearIcons ( ) : void
Collapse ( ) : void
CollapseAll ( ) : void
CollapseItem ( string text, object referenceObject ) : System
Contains ( object objectToSearchFor ) : bool	Returns whether this or any children CollapseItems contain the argument object as their ReferenceObject.
ContainsItem ( CollapseItem item ) : bool
Detach ( ) : void
Expand ( ) : void
ExpandAll ( ) : void
FillWithAllDescendantCollapseItems ( IList listToFill ) : void
FillWithAllReferencedItems ( IList listToFill ) : void
FixCollapseIcon ( ) : void
GetCount ( int &count ) : int
GetHighlighted ( int &count, int highlightedNum ) : CollapseItem
GetItem ( object itemToGet ) : CollapseItem
GetItem ( string itemToGet ) : CollapseItem
GetItemNum ( int &count, CollapseItem itemToGet ) : bool
GetItemNum ( int &count, object itemToGet ) : bool
GetItemNum ( int &count, string itemToGet ) : bool
GetNumContained ( object objectToCount, int &count ) : int
GetObject ( string objectToGet ) : object
InsertItem ( int index, string itemToAdd, object referenceObject ) : CollapseItem
IsChildOf ( CollapseItem potentialParent ) : bool
MoveLeftOne ( ) : void
RemoveAllChildren ( ) : void
RemoveObject ( object objectToRemove ) : CollapseItem
RemoveSelf ( ) : void
RemoveSelfAndChildren ( ) : void
ReorderToMatchList ( IEnumerable list ) : void
ToString ( ) : string
this ( int i ) : CollapseItem

Private Methods

Method	Description
Draw ( Camera camera, double startY, double startX, double maxWidth, int numDeep, int &itemNum, int &numDrawn, int startAt, int numToDraw, float distanceBetweenLines ) : void
GetNthVisibleItem ( int &countedSoFar, int itemNumber ) : CollapseItem
GetNumberOfVerticesToDraw ( Camera camera, double startY, double startX, double maxWidth, int numDeep, int &itemNum, int &numDrawn, int startAt, int numToDraw ) : int
GetVisibleIndex ( int &countedSoFar, CollapseItem collapseItem ) : int
TurnOffDrawHighlighted ( ) : void

Method Details

AddIcon() public method

public AddIcon ( Microsoft.Xna.Framework.Graphics.Texture2D texture, string name ) : ListBoxIcon
texture	Microsoft.Xna.Framework.Graphics.Texture2D
name	string
return	ListBoxIcon

AddIcon() public method

Adds an icon to the CollapseItem

Do not use $ in the name of the icon as the Collapse list boxes use this character for icons such as + and - boxes for expanding CollapseItems with children.

public AddIcon ( float top, float bottom, float left, float right, string name ) : ListBoxIcon
top	float
bottom	float
left	float
right	float
name	string
return	ListBoxIcon

AddIcon() public method

public AddIcon ( float top, float bottom, float left, float right, string name, int index ) : ListBoxIcon
top	float
bottom	float
left	float
right	float
name	string
index	int
return	ListBoxIcon

AddItem() public method

public AddItem ( string itemToAdd ) : CollapseItem
itemToAdd	string
return	CollapseItem

AddItem() public method

public AddItem ( string itemToAdd, object referenceObject ) : CollapseItem
itemToAdd	string
referenceObject	object
return	CollapseItem

AttachItemToThis() public method

public AttachItemToThis ( CollapseItem itemToAdd ) : CollapseItem
itemToAdd	CollapseItem
return	CollapseItem

ClearIcons() public method

public ClearIcons ( ) : void
return	void

Collapse() public method

public Collapse ( ) : void
return	void

CollapseAll() public method

public CollapseAll ( ) : void
return	void

CollapseItem() public method

public CollapseItem ( string text, object referenceObject ) : System
text	string
referenceObject	object
return	System

Contains() public method

Returns whether this or any children CollapseItems contain the argument object as their ReferenceObject.

public Contains ( object objectToSearchFor ) : bool
objectToSearchFor	object	The object to search for.
return	bool

ContainsItem() public method

public ContainsItem ( CollapseItem item ) : bool
item	CollapseItem
return	bool

Detach() public method

public Detach ( ) : void
return	void

Expand() public method

public Expand ( ) : void
return	void

ExpandAll() public method

public ExpandAll ( ) : void
return	void

FillWithAllDescendantCollapseItems() public method

public FillWithAllDescendantCollapseItems ( IList listToFill ) : void
listToFill	IList
return	void

FillWithAllReferencedItems() public method

public FillWithAllReferencedItems ( IList listToFill ) : void
listToFill	IList
return	void

FixCollapseIcon() public method

public FixCollapseIcon ( ) : void
return	void

GetCount() public method

public GetCount ( int &count ) : int
count	int
return	int

GetHighlighted() public method

public GetHighlighted ( int &count, int highlightedNum ) : CollapseItem
count	int
highlightedNum	int
return	CollapseItem

GetItem() public method

public GetItem ( object itemToGet ) : CollapseItem
itemToGet	object
return	CollapseItem

GetItem() public method

public GetItem ( string itemToGet ) : CollapseItem
itemToGet	string
return	CollapseItem

GetItemNum() public method

public GetItemNum ( int &count, CollapseItem itemToGet ) : bool
count	int
itemToGet	CollapseItem
return	bool

GetItemNum() public method

public GetItemNum ( int &count, object itemToGet ) : bool
count	int
itemToGet	object
return	bool

GetItemNum() public method

public GetItemNum ( int &count, string itemToGet ) : bool
count	int
itemToGet	string
return	bool

GetNumContained() public method

public GetNumContained ( object objectToCount, int &count ) : int
objectToCount	object
count	int
return	int

GetObject() public method

public GetObject ( string objectToGet ) : object
objectToGet	string
return	object

InsertItem() public method

public InsertItem ( int index, string itemToAdd, object referenceObject ) : CollapseItem
index	int
itemToAdd	string
referenceObject	object
return	CollapseItem

IsChildOf() public method

public IsChildOf ( CollapseItem potentialParent ) : bool
potentialParent	CollapseItem
return	bool

MoveLeftOne() public method

public MoveLeftOne ( ) : void
return	void

RemoveAllChildren() public method

public RemoveAllChildren ( ) : void
return	void

RemoveObject() public method

public RemoveObject ( object objectToRemove ) : CollapseItem
objectToRemove	object
return	CollapseItem

RemoveSelf() public method

public RemoveSelf ( ) : void
return	void

RemoveSelfAndChildren() public method

public RemoveSelfAndChildren ( ) : void
return	void

ReorderToMatchList() public method

public ReorderToMatchList ( IEnumerable list ) : void
list	IEnumerable
return	void

ToString() public method

public ToString ( ) : string
return	string

this() public method

public this ( int i ) : CollapseItem
i	int
return	CollapseItem

Property Details

ReferenceObject public property

public object ReferenceObject
return	object

itemText protected property

protected string itemText
return	string

v protected static property

protected static VertexPositionColorTexture[],Microsoft.Xna.Framework.Graphics v
return	Microsoft.Xna.Framework.Graphics.VertexPositionColorTexture[]