Interface IIconFactory

A factory for creating icons.

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IIconFactory

Methods

GetArrowIcon(ArrowDirection, Nullable<Color>)

Creates an arrow icon.

Declaration

IBorderStyle GetArrowIcon(ArrowDirection direction, Color? color = default(Color? ))

Parameters

Type	Name	Description
ArrowDirection	direction	Direction.
System.Nullable<Color>	color	Color.

Returns

Type	Description
IBorderStyle	The arrow icon.

GetFileIcon(Boolean, Nullable<Color>, Nullable<Color>, Nullable<Color>, Nullable<Color>)

Creates a file icon.

Declaration

ISelectableIcon GetFileIcon(bool isSelected = false, Color? color = default(Color? ), Color? foldColor = default(Color? ), Color? selectedColor = default(Color? ), Color? selectedFoldColor = default(Color? ))

Parameters

Type	Name	Description
System.Boolean	isSelected	Is the icon selected.
System.Nullable<Color>	color	Color.
System.Nullable<Color>	foldColor	Fold color.
System.Nullable<Color>	selectedColor	Seleced color.
System.Nullable<Color>	selectedFoldColor	Selected fold color.

Returns

Type	Description
ISelectableIcon	The file icon.

GetFolderIcon(Boolean, Nullable<Color>, Nullable<Color>, Nullable<Color>, Nullable<Color>)

Creates a folder icon.

Declaration

ISelectableIcon GetFolderIcon(bool isSelected = false, Color? color = default(Color? ), Color? foldColor = default(Color? ), Color? selectedColor = default(Color? ), Color? selectedFoldColor = default(Color? ))

Parameters

Type	Name	Description
System.Boolean	isSelected	Is the icon selected.
System.Nullable<Color>	color	Color.
System.Nullable<Color>	foldColor	Fold color.
System.Nullable<Color>	selectedColor	Seleced color.
System.Nullable<Color>	selectedFoldColor	Selected fold color.

Returns

Type	Description
ISelectableIcon	The folder icon.

GetXIcon(Single, Single, Nullable<Color>)

Create an "X" icon (for close windows buttons, for example).

Declaration

IBorderStyle GetXIcon(float lineWidth = 3F, float padding = 3F, Color? color = default(Color? ))

Parameters

Type	Name	Description
System.Single	lineWidth	Line width.
System.Single	padding	Padding.
System.Nullable<Color>	color	Color (leave empty for red).

Returns

Type	Description
IBorderStyle	The icon.