NodeExport Class Reference
[Gdb]

Stores the node exporting values. More...

List of all members.

Public Member Functions

 NodeExport ()
 Creates a new instance.
virtual ~NodeExport ()
 Destructor.
void SetDefaults ()
 Sets to default values.
const std::wstring & GetLabel () const
 Gets the node label.
void SetLabel (const std::wstring &label)
 Sets the node label.
NodeShape GetShape () const
 Gets the node shape.
void SetShape (NodeShape shape)
 Sets the node shape.
ColorRGB GetColorRGB () const
 Gets the node color.
void SetColorRGB (ColorRGB color)
 Sets the node color.
ColorRGB GetLabelColorRGB () const
 Gets the node label color.
void SetLabelColorRGB (ColorRGB color)
 Sets the node label color.
int32_t GetHeight () const
 Gets the node height.
void SetHeight (int32_t height)
 Sets the node height.
int32_t GetWidth () const
 Gets the node width.
void SetWidth (int32_t width)
 Gets the node width.
bool_t IsFit () const
 Gets whether the node size is fitted to the label or not.
void SetFit (bool_t fit)
 Sets the node fit property.
int32_t GetFontSize () const
 Gets the node label font size.
void SetFontSize (int32_t size)
 Sets the node label font size.


Detailed Description

Stores the node exporting values.

When 'fit' is set to TRUE, then 'height' and 'width' will be ignored.

Some properties may be ignored depending on the exportation type.

Default values are:

Label: "" (empty string).

Shape: Box.

Color: 10863606 (0xa5c3f6).

Label color: 0 (Ox000000, Black).

Height: 25px.

Width: 25px.

Fit: TRUE.

Font size: 10.

Author:
Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

const std::wstring& NodeExport::GetLabel (  )  const [inline]

Gets the node label.

Returns:
The node label.

void NodeExport::SetLabel ( const std::wstring &  label  )  [inline]

Sets the node label.

Parameters:
label [in] The node label.

NodeShape NodeExport::GetShape (  )  const [inline]

Gets the node shape.

Returns:
The node shape.

void NodeExport::SetShape ( NodeShape  shape  )  [inline]

Sets the node shape.

Parameters:
shape [in] The node shape.

ColorRGB NodeExport::GetColorRGB (  )  const [inline]

Gets the node color.

Returns:
The node color.

void NodeExport::SetColorRGB ( ColorRGB  color  )  [inline]

Sets the node color.

Parameters:
color The node color.

ColorRGB NodeExport::GetLabelColorRGB (  )  const [inline]

Gets the node label color.

Returns:
The node label color.

void NodeExport::SetLabelColorRGB ( ColorRGB  color  )  [inline]

Sets the node label color.

Parameters:
color [in] The node label color.

int32_t NodeExport::GetHeight (  )  const [inline]

Gets the node height.

Returns:
The node height in pixels.

void NodeExport::SetHeight ( int32_t  height  )  [inline]

Sets the node height.

Parameters:
height [in] The node height in pixels.

int32_t NodeExport::GetWidth (  )  const [inline]

Gets the node width.

Returns:
The node width in pixels.

void NodeExport::SetWidth ( int32_t  width  )  [inline]

Gets the node width.

Parameters:
width The node width in pixels.

bool_t NodeExport::IsFit (  )  const [inline]

Gets whether the node size is fitted to the label or not.

Returns:
If TRUE, then the node size is fitted to the label, otherwise the size is fixed with the values of 'height' and 'width'.

void NodeExport::SetFit ( bool_t  fit  )  [inline]

Sets the node fit property.

Parameters:
fit [in] If TRUE, then the node size is fitted to the label ('height' and 'width' will be ignored), otherwise the size is fixed with the values of 'height' and 'width'.

int32_t NodeExport::GetFontSize (  )  const [inline]

Gets the node label font size.

Returns:
The node label font size.

void NodeExport::SetFontSize ( int32_t  size  )  [inline]

Sets the node label font size.

Parameters:
size [in] The node label font size.


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

Generated on Fri Sep 12 13:36:34 2014 for Sparksee by  doxygen 1.5.6