centrafuse.Plugins.CFControls.skinListbox Class Reference

Centrafuse list box. More...

Inherits centrafuse::Plugins::CFControls::skinPanel.

Collaboration diagram for centrafuse.Plugins.CFControls.skinListbox:

[legend]

List of all members.

Classes
class	EndofListArgs
	End of list event arguments. More...
Public Types
enum	PagingDirection {   UP = 0,   DOWN = 1 }
	Paging Direction enumeration. More...
Public Member Functions
	skinListbox ()
	Creates new list box.
	skinListbox (Rectangle Rect)
	Creates new list box.
	skinListbox (Point Position, Size Dimension)
	Creates new list box.
	skinListbox (int Left, int Top, int Width, int Height)
	Creates new list box.
void	clearClickEvents ()
	Clear Click events.
void	startPaging (PagingDirection direction)
	Start Paging.
void	stopPaging ()
	Stop Paging.
void	ClearList ()
	Clears list box.
void	CheckItem (int pi_iIndex)
	Checks item at specified index.
void	pageDown ()
	Moves list down one page.
void	pageUp ()
	Moves list up one page.
bool	IsChecked (int pi_iNdx)
	Determines if item is selected.
int	backCount ()
	Returns count of items in the back queue list.
void	goBack ()
	Go back in list, used for Single Click mode.
void	goForward ()
	Go forward in list, used for Single Click mode to save previous selection.
void	clearBack ()
	Clear the back queue list, used for Single Click mode.
void	addPrevious (skinListboxItem pitem)
	Clear the back queue list, used for Single Click mode.
Static Public Member Functions
static void	enableRollOver (bool rollover)
static void	enableVideoArt (bool enablevideoart)
	Set whether list rolls over at beginning and end.
Protected Member Functions
override void	Dispose (bool disposing)
	Disposes list box.
override void	OnDoubleClick (EventArgs e)
	Double click event.
override bool	ProcessCmdKey (ref Message msg, Keys keyData)
	Processes command key.
override void	OnKeyUp (KeyEventArgs e)
override void	OnKeyDown (KeyEventArgs e)
	Key down event.
override void	OnMouseDown (MouseEventArgs e)
	Mouse down event.
override void	OnMouseMove (MouseEventArgs e)
	Mouse move event.
override void	OnMouseUp (MouseEventArgs e)
	Mouse up event.
override void	OnMouseWheel (MouseEventArgs e)
	Mouse wheel event.
override void	OnPaint (PaintEventArgs pe)
	List box paint method.
override void	OnPaintBackground (PaintEventArgs pe)
	List box background paint method.
override void	OnResize (EventArgs e)
	Resize event.
Properties
ArrayList	ListImages [get, set]
	Gets or sets image list.
ArrayList	FBListImages [get, set]
	Gets or sets system image list.
int	ArtSpacerSize [get, set]
	Gets or sets art spacer size.
new Font	Font [get, set]
	Gets or sets list box font.
Font	ArtFont [get, set]
	Gets or sets cover art font.
int	ItemHeight [get]
	Gets item height.
ArrayList	Items [get]
	Gets item array.
Color	SelectBarColor [get, set]
	Gets or sets select bar color.
Color	SelectBarFontColor [get, set]
	Gets or sets select bar font color.
int	SelectBarTransparency [get, set]
	Gets or sets select bar transparency.
int	SelectedIndex [get, set]
	Gets or sets current selection.
skinListboxItem	SelectedItem [get]
	Gets selected list item.
skinListboxItem	AbsoluteItem [get]
	Gets absolute list item, always use this to get the selected item in the single or double click event.
bool	NewList [get, set]
	Gets or sets new list flag.
bool	SingleClickAlways [get, set]
	Gets or sets always fire single click flag.
bool	DisableKeyJump [get, set]
	Disable list view key jump.
bool	ArtBrowse [get, set]
	Gets or sets cover art flag.
bool	RotatePicture [get, set]
	Gets or sets picture rotate.
bool	PictureMode [get, set]
	Gets or sets picture mode flag.
bool	HighlightTimerEnabled [get]
	Gets highlight timer enabled flag.
bool	PaintHighlightOverride [get, set]
	Gets or sets paint highlight override flag.
Size	ArtSize [get, set]
	Gets or sets cover art size.
int	ArtColumns [get]
	Gets number of cover art columns.
int	ArtRows [get]
	Gets number of cover art rows.
int	MaxLines [get]
	Gets max number of lines.
int	TopLine [get]
	Gets top most index based on currently displayed rows.
int	RowSize [get, set]
	Gets or sets row size.
string	Skin [get, set]
	Gets or sets skin.
double	WidthRatio [get, set]
	Gets or sets width ratio.
double	HeightRatio [get, set]
	Gets or sets height ratio.
Events
EventHandler	CheckItemChanged
	Check item changed event.
new EventHandler	DoubleClick
	Double click event.
EventHandler	SingleClick
	Single click event.
EventHandler	SelectedIndexChanged
	Selected index changed event.
KeyEventHandler	ListKeyDown
	List key down event.
KeyEventHandler	ListKeyUp
	List key up event.
EventHandler	EndofList
	End of list event.

---

Detailed Description

Centrafuse list box.

---

Member Enumeration Documentation

enum centrafuse::Plugins::CFControls::skinListbox::PagingDirection

Paging Direction enumeration.

---

Constructor & Destructor Documentation

centrafuse.Plugins.CFControls.skinListbox.skinListbox

(

)

Creates new list box.

centrafuse.Plugins.CFControls.skinListbox.skinListbox

(

Rectangle

Rect

)

Creates new list box.

Parameters:

Rect

List box bounds.

centrafuse.Plugins.CFControls.skinListbox.skinListbox	(	Point	Position,
		Size	Dimension
	)

Creates new list box.

Parameters:

	Position	List box point.
	Dimension	List box size.

centrafuse.Plugins.CFControls.skinListbox.skinListbox	(	int	Left,
		int	Top,
		int	Width,
		int	Height
	)

Creates new list box.

Parameters:

	Left	List box left position.
	Top	List box top position.
	Width	List box width.
	Height	List box height.

---

Member Function Documentation

void centrafuse.Plugins.CFControls.skinListbox.addPrevious

(

skinListboxItem

pitem

)

Clear the back queue list, used for Single Click mode.

int centrafuse.Plugins.CFControls.skinListbox.backCount

(

)

Returns count of items in the back queue list.

void centrafuse.Plugins.CFControls.skinListbox.CheckItem

(

int

pi_iIndex

)

Checks item at specified index.

Parameters:

pi_iIndex

Item index.

void centrafuse.Plugins.CFControls.skinListbox.clearBack

(

)

Clear the back queue list, used for Single Click mode.

void centrafuse.Plugins.CFControls.skinListbox.clearClickEvents

(

)

Clear Click events.

void centrafuse.Plugins.CFControls.skinListbox.ClearList

(

)

Clears list box.

override void centrafuse.Plugins.CFControls.skinListbox.Dispose

(

bool

disposing

)

[protected]

Disposes list box.

Parameters:

disposing

Disposing flag.

static void centrafuse.Plugins.CFControls.skinListbox.enableRollOver

(

bool

rollover

)

[static]

Set whether list rolls over at beginning and end.

static void centrafuse.Plugins.CFControls.skinListbox.enableVideoArt

(

bool

enablevideoart

)

[static]

Set whether list rolls over at beginning and end.

void centrafuse.Plugins.CFControls.skinListbox.goBack

(

)

Go back in list, used for Single Click mode.

void centrafuse.Plugins.CFControls.skinListbox.goForward

(

)

Go forward in list, used for Single Click mode to save previous selection.

bool centrafuse.Plugins.CFControls.skinListbox.IsChecked

(

int

pi_iNdx

)

Determines if item is selected.

Parameters:

pi_iNdx

Item index.

Returns:

Returns checked flag.

override void centrafuse.Plugins.CFControls.skinListbox.OnDoubleClick

(

EventArgs

e

)

[protected]

Double click event.

Parameters:

e

Event arguments.

override void centrafuse.Plugins.CFControls.skinListbox.OnKeyDown

(

KeyEventArgs

e

)

[protected]

Key down event.

Parameters:

e

Key event arguments.

override void centrafuse.Plugins.CFControls.skinListbox.OnKeyUp

(

KeyEventArgs

e

)

[protected]

Key up event.

Parameters:

e

Key event arguments.

override void centrafuse.Plugins.CFControls.skinListbox.OnMouseDown

(

MouseEventArgs

e

)

[protected]

Mouse down event.

Parameters:

e

Mouse event arguments.

override void centrafuse.Plugins.CFControls.skinListbox.OnMouseMove

(

MouseEventArgs

e

)

[protected]

Mouse move event.

Parameters:

e

Mouse event arguments.

override void centrafuse.Plugins.CFControls.skinListbox.OnMouseUp

(

MouseEventArgs

e

)

[protected]

Mouse up event.

Parameters:

e

Mouse event arguments.

override void centrafuse.Plugins.CFControls.skinListbox.OnMouseWheel

(

MouseEventArgs

e

)

[protected]

Mouse wheel event.

Parameters:

e

Mouse event arguments.

override void centrafuse.Plugins.CFControls.skinListbox.OnPaint

(

PaintEventArgs

pe

)

[protected]

List box paint method.

Parameters:

pe

Paint event arguments.

Reimplemented from centrafuse.Plugins.CFControls.skinPanel.

override void centrafuse.Plugins.CFControls.skinListbox.OnPaintBackground

(

PaintEventArgs

pe

)

[protected]

List box background paint method.

Parameters:

pe

Paint event arguments.

Reimplemented from centrafuse.Plugins.CFControls.skinPanel.

override void centrafuse.Plugins.CFControls.skinListbox.OnResize

(

EventArgs

e

)

[protected]

Resize event.

Parameters:

e

Event arguments.

void centrafuse.Plugins.CFControls.skinListbox.pageDown

(

)

Moves list down one page.

void centrafuse.Plugins.CFControls.skinListbox.pageUp

(

)

Moves list up one page.

override bool centrafuse.Plugins.CFControls.skinListbox.ProcessCmdKey	(	ref Message	msg,
		Keys	keyData
	)			[protected]

Processes command key.

Parameters:

	msg	Key message.
	keyData	Key data.

Returns:

Returns true if key command processed; false otherwise.

void centrafuse.Plugins.CFControls.skinListbox.startPaging

(

PagingDirection

direction

)

Start Paging.

void centrafuse.Plugins.CFControls.skinListbox.stopPaging

(

)

Stop Paging.

---

Property Documentation

skinListboxItem centrafuse.Plugins.CFControls.skinListbox.AbsoluteItem [get]

Gets absolute list item, always use this to get the selected item in the single or double click event.

bool centrafuse.Plugins.CFControls.skinListbox.ArtBrowse [get, set]

Gets or sets cover art flag.

int centrafuse.Plugins.CFControls.skinListbox.ArtColumns [get]

Gets number of cover art columns.

Font centrafuse.Plugins.CFControls.skinListbox.ArtFont [get, set]

Gets or sets cover art font.

int centrafuse.Plugins.CFControls.skinListbox.ArtRows [get]

Gets number of cover art rows.

Size centrafuse.Plugins.CFControls.skinListbox.ArtSize [get, set]

Gets or sets cover art size.

int centrafuse.Plugins.CFControls.skinListbox.ArtSpacerSize [get, set]

Gets or sets art spacer size.

bool centrafuse.Plugins.CFControls.skinListbox.DisableKeyJump [get, set]

Disable list view key jump.

ArrayList centrafuse.Plugins.CFControls.skinListbox.FBListImages [get, set]

Gets or sets system image list.

new Font centrafuse.Plugins.CFControls.skinListbox.Font [get, set]

Gets or sets list box font.

double centrafuse.Plugins.CFControls.skinListbox.HeightRatio [get, set]

Gets or sets height ratio.

bool centrafuse.Plugins.CFControls.skinListbox.HighlightTimerEnabled [get]

Gets highlight timer enabled flag.

int centrafuse.Plugins.CFControls.skinListbox.ItemHeight [get]

Gets item height.

ArrayList centrafuse.Plugins.CFControls.skinListbox.Items [get]

Gets item array.

ArrayList centrafuse.Plugins.CFControls.skinListbox.ListImages [get, set]

Gets or sets image list.

int centrafuse.Plugins.CFControls.skinListbox.MaxLines [get]

Gets max number of lines.

bool centrafuse.Plugins.CFControls.skinListbox.NewList [get, set]

Gets or sets new list flag.

bool centrafuse.Plugins.CFControls.skinListbox.PaintHighlightOverride [get, set]

Gets or sets paint highlight override flag.

bool centrafuse.Plugins.CFControls.skinListbox.PictureMode [get, set]

Gets or sets picture mode flag.

bool centrafuse.Plugins.CFControls.skinListbox.RotatePicture [get, set]

Gets or sets picture rotate.

int centrafuse.Plugins.CFControls.skinListbox.RowSize [get, set]

Gets or sets row size.

Color centrafuse.Plugins.CFControls.skinListbox.SelectBarColor [get, set]

Gets or sets select bar color.

Color centrafuse.Plugins.CFControls.skinListbox.SelectBarFontColor [get, set]

Gets or sets select bar font color.

int centrafuse.Plugins.CFControls.skinListbox.SelectBarTransparency [get, set]

Gets or sets select bar transparency.

int centrafuse.Plugins.CFControls.skinListbox.SelectedIndex [get, set]

Gets or sets current selection.

skinListboxItem centrafuse.Plugins.CFControls.skinListbox.SelectedItem [get]

Gets selected list item.

bool centrafuse.Plugins.CFControls.skinListbox.SingleClickAlways [get, set]

Gets or sets always fire single click flag.

string centrafuse.Plugins.CFControls.skinListbox.Skin [get, set]

Gets or sets skin.

int centrafuse.Plugins.CFControls.skinListbox.TopLine [get]

Gets top most index based on currently displayed rows.

double centrafuse.Plugins.CFControls.skinListbox.WidthRatio [get, set]

Gets or sets width ratio.

---

Event Documentation

EventHandler centrafuse.Plugins.CFControls.skinListbox.CheckItemChanged

Check item changed event.

new EventHandler centrafuse.Plugins.CFControls.skinListbox.DoubleClick

Double click event.

EventHandler centrafuse.Plugins.CFControls.skinListbox.EndofList

End of list event.

KeyEventHandler centrafuse.Plugins.CFControls.skinListbox.ListKeyDown

List key down event.

KeyEventHandler centrafuse.Plugins.CFControls.skinListbox.ListKeyUp

List key up event.

EventHandler centrafuse.Plugins.CFControls.skinListbox.SelectedIndexChanged

Selected index changed event.

EventHandler centrafuse.Plugins.CFControls.skinListbox.SingleClick

Single click event.

---

The documentation for this class was generated from the following file:

• CFControls.cs