C# Class DSShared.Lists.ObjRow

Class that represents a row in a CustomList

Inheritance: IComparable

Mostra file Open project: pmprog/OpenXCOM.Tools Class Usage Examples

Protected Properties

Property	Type	Description
addStr	string
clickCol	CustomListColumn
columns	CustomListColumnCollection
cursorTimer	Timer
flip	bool
obj	Object
rowIdx	int
selCol	CustomListColumn
width	int

Public Methods

Method	Description
Click ( CustomListColumn col ) : void	Called when the mouse clicks on a row
CompareTo ( object other ) : int	Compares one row to another. other must be an ObjRow and ObjRow.obj must implement IComparable
Equals ( object other ) : bool	Equality test against another object. Calls Object.Equals(other.Object)
FireRefresh ( ) : void	Outside access to fire the refresh event
GetHashCode ( ) : int	Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.
KeyDown ( KeyEventArgs e ) : void	This function currently does nothing
KeyPress ( KeyPressEventArgs e ) : void	Called when a key is pressed on the keyboard and this row is selected
KeyUp ( KeyEventArgs e ) : void	This function currently does nothing
MouseLeave ( ) : void	Called when the mouse leaves the row's bounding rectangle
MouseOver ( CustomListColumn col ) : void	called when a mouse moves over the row
ObjRow ( object obj ) : System	Initializes a new instance of the T:ObjRow class.
ObjRow ( object obj, CustomListColumnCollection columns ) : System	Initializes a new instance of the T:ObjRow class.
Render ( PaintEventArgs e, int yOffset ) : void	Method that paints this row
UnClick ( ) : void	This method is called before another row is clicked. This is used as a 'turn off' function

Private Methods

Method	Description
startTimer ( ) : void
stopTimer ( ) : void
timerTick ( object sender, EventArgs e ) : void

Method Details

Click() public method

Called when the mouse clicks on a row

public Click ( CustomListColumn col ) : void
col	CustomListColumn	The column the mouse was over when the button was clicked
return	void

CompareTo() public method

Compares one row to another. other must be an ObjRow and ObjRow.obj must implement IComparable

public CompareTo ( object other ) : int
other	object	The object to compare with
return	int

Equals() public method

Equality test against another object. Calls Object.Equals(other.Object)

public Equals ( object other ) : bool
other	object	The other object to test against
return	bool

FireRefresh() public method

Outside access to fire the refresh event

public FireRefresh ( ) : void
return	void

GetHashCode() public method

Serves as a hash function for a particular type. is suitable for use in hashing algorithms and data structures like a hash table.

public GetHashCode ( ) : int
return	int

KeyDown() public method

This function currently does nothing

public KeyDown ( KeyEventArgs e ) : void
e	System.Windows.Forms.KeyEventArgs
return	void

KeyPress() public method

Called when a key is pressed on the keyboard and this row is selected

public KeyPress ( KeyPressEventArgs e ) : void
e	System.Windows.Forms.KeyPressEventArgs	The instance containing the event data.
return	void

KeyUp() public method

This function currently does nothing

public KeyUp ( KeyEventArgs e ) : void
e	System.Windows.Forms.KeyEventArgs
return	void

MouseLeave() public method

Called when the mouse leaves the row's bounding rectangle

public MouseLeave ( ) : void
return	void

MouseOver() public method

called when a mouse moves over the row

public MouseOver ( CustomListColumn col ) : void
col	CustomListColumn
return	void

ObjRow() public method

Initializes a new instance of the T:ObjRow class.

public ObjRow ( object obj ) : System
obj	object	The obj.
return	System

ObjRow() public method

Initializes a new instance of the T:ObjRow class.

public ObjRow ( object obj, CustomListColumnCollection columns ) : System
obj	object	The obj.
columns	CustomListColumnCollection	The columns.
return	System

Render() public method

Method that paints this row

public Render ( PaintEventArgs e, int yOffset ) : void
e	PaintEventArgs
yOffset	int
return	void

UnClick() public method

This method is called before another row is clicked. This is used as a 'turn off' function

public UnClick ( ) : void
return	void

Property Details

addStr protected_oe property

String for the blinking cursor

protected string addStr
return	string

clickCol protected_oe property

Clicked-on column

protected CustomListColumn,DSShared.Lists clickCol
return	CustomListColumn

columns protected_oe property

The list of columns that specify what information of the obj is being displayed

protected CustomListColumnCollection,DSShared.Lists columns
return	CustomListColumnCollection

cursorTimer protected_oe property

Timer to make a blinking cursor when an editable cell is clicked on

protected Timer cursorTimer
return	Timer

flip protected_oe property

Timer information

protected bool flip
return	bool

obj protected_oe property

The object this row wraps around

protected Object obj
return	Object

rowIdx protected_oe property

Row index

protected int rowIdx
return	int

selCol protected_oe property

Selected column

protected CustomListColumn,DSShared.Lists selCol
return	CustomListColumn

width protected_oe property

Row screen information

protected int width
return	int