wx.Graph.View.LabelledNode Class Reference

Inheritance diagram for wx.Graph.View.LabelledNode:

List of all members.

Public Member Functions
void	Draw (DC dc, ImageList images, Point pos)
ICollection< Point >	GetDockingPoints (Point pos)
Size	GetSize (DC dc, ImageList images)
	LabelledNode (string label, int imageIndex, Direction direction)
	LabelledNode (string label, int padding)
Public Attributes
event ComponentModel.PropertyChangedHandler	OnChange
Properties
Colour	Background [get, set]
Direction	Direction [get, set]
bool	DrawBorderBox [get, set]
Colour	Foreground [get, set]
int	ImageIndex [get, set]
string	Label [get, set]
int	Padding [get, set]

---

Detailed Description

Use In

---

Constructor & Destructor Documentation

wx.Graph.View.LabelledNode.LabelledNode	(	string	label,
		int	padding
	)

Creates a new instance that will display the provided text label.

Parameters:

label

The text label that shall be displayed

wx.Graph.View.LabelledNode.LabelledNode	(	string	label,
		int	imageIndex,
		Direction	direction
	)

Creates a new instance that will display a text label and an image from an image list.

Parameters:

	label	The text label. If this is empty, the node will be
	imageIndex	The index of the image that shall be displayed.
	direction	The direction defines, whether the label shall be displayd above, below, on the left, or on the right side of the image.

---

Member Function Documentation

void wx.Graph.View.LabelledNode.Draw	(	DC	dc,
		ImageList	images,
		Point	pos
	)

This will be called to draw the node.

Parameters:

	dc	The device context that shall display the node
	pos	The upper left position of the free space that has been reserved by the layout algorithm.
	images	The list of images that is available to display nodes. This can be null if not available.

Implements wx.Graph.View.INodeAppearance.

ICollection<Point> wx.Graph.View.LabelledNode.GetDockingPoints

(

Point

pos

)

If drawn by Draw() at the provided position, this returns a collection of positions that can be used as start or end of drawn edges.

Parameters:

pos

Returns:

Implements wx.Graph.View.INodeAppearance.

Size wx.Graph.View.LabelledNode.GetSize	(	DC	dc,
		ImageList	images
	)

The size of the node. Layout algorithms will reserve free space of this size.

Parameters:

	dc	The device context that shall display the node. Use this context to determine text sizes.
	images	The list of images that is available to display nodes. This can be null if not available.

Returns:

Implements wx.Graph.View.INodeAppearance.

---

Member Data Documentation

event ComponentModel.PropertyChangedHandler wx.Graph.View.LabelledNode.OnChange

Call this if something changed. The graph views will update the display of this node.

Implements wx.Graph.View.INodeAppearance.

---

Property Documentation

Colour wx.Graph.View.LabelledNode.Background [get, set]

The background colour that will be used to draw the node. this can be null. In that case, the background will be filly transparent. If you assign a colour to this, please note: The assigned instance will get readonly.

Direction wx.Graph.View.LabelledNode.Direction [get, set]

This direction defines the position of the text label relatively to the image. If this is Direction.wxUP, the text label will be directly above the image. If this is Direction.wxDOWN, the text label will be directly below the image. If the direction is Direction.wxLEFT or Direction.wxRIGHT, the text label will be on the left side of the image, or right side respectively. If the label is left and up, the label will be positioned relatively to the upper left corner of the image. The other directions are accordingly. In case of Direction.wxALL, the text will be positioned in the center of the image.

bool wx.Graph.View.LabelledNode.DrawBorderBox [get, set]

Set or get a Boolean flag that is true iff the graph node shall be surrounded by a box.

Colour wx.Graph.View.LabelledNode.Foreground [get, set]

The foreground/text colour that will be used to draw the node label. If you assign a colour to this, please note: The assigned instance will get readonly.

int wx.Graph.View.LabelledNode.ImageIndex [get, set]

Get or set the index of the image that shall be displayed. If this is -1, no image will be displayed.

string wx.Graph.View.LabelledNode.Label [get, set]

Get or set the label.

int wx.Graph.View.LabelledNode.Padding [get, set]

Defines a number of pixels that shall be left blank between image and label (if both are given) and between image and label and the surrounding box (if one shall be drawn),

---