EdgeExport Class Reference
[Gdb]

Stores edge exporting values. More...

List of all members.

Public Member Functions

 EdgeExport ()
 Creates a new instance.
virtual ~EdgeExport ()
 Destructor.
void SetDefaults ()
 Sets to default values.
const std::wstring & GetLabel () const
 Gets the edge label.
void SetLabel (const std::wstring &l)
 Sets the edge label.
bool_t AsDirected () const
 Gets if the edge should be managed as directed.
void SetAsDirected (bool_t b)
 Sets if the edge should be managed as directed.
ColorRGB GetColorRGB () const
 Gets the edge color.
void SetColorRGB (ColorRGB c)
 Sets the edge color.
ColorRGB GetLabelColorRGB () const
 Gets the edge label color.
void SetLabelColorRGB (ColorRGB c)
 Sets the edge label color.
int32_t GetWidth () const
 Gets the edge width.
void SetWidth (int32_t w)
 Sets the edge width.
int32_t GetFontSize () const
 Gets the edge label font size.
void SetFontSize (int32_t s)
 Sets the edge label font size.


Detailed Description

Stores edge exporting values.

Some properties may be ignored depending on the exportation type.

Default values are:

Label: "" (empty string).

As directed: TRUE.

Color: 13882323 (OxD3D3D3, Light gray).

Label color: 0 (Ox000000, Black).

Width: 5px.

Font size: 10.

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

Member Function Documentation

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

Gets the edge label.

Returns:
The edge label.

void EdgeExport::SetLabel ( const std::wstring &  l  )  [inline]

Sets the edge label.

Parameters:
l [in] The edge label.

bool_t EdgeExport::AsDirected (  )  const [inline]

Gets if the edge should be managed as directed.

TRUE is the default value. If TRUE, use as directed, otherwise use as undirected.

Returns:
The edge direction.

void EdgeExport::SetAsDirected ( bool_t  b  )  [inline]

Sets if the edge should be managed as directed.

Parameters:
b [in] If TRUE, use as directed, otherwise use as undirected.

ColorRGB EdgeExport::GetColorRGB (  )  const [inline]

Gets the edge color.

Returns:
The edge color.

void EdgeExport::SetColorRGB ( ColorRGB  c  )  [inline]

Sets the edge color.

Parameters:
c [in] The edge color.

ColorRGB EdgeExport::GetLabelColorRGB (  )  const [inline]

Gets the edge label color.

Returns:
The edge label color.

void EdgeExport::SetLabelColorRGB ( ColorRGB  c  )  [inline]

Sets the edge label color.

Parameters:
c [in] The edge label color.

int32_t EdgeExport::GetWidth (  )  const [inline]

Gets the edge width.

Returns:
The edge width.

void EdgeExport::SetWidth ( int32_t  w  )  [inline]

Sets the edge width.

Parameters:
w [in] The edge width.

int32_t EdgeExport::GetFontSize (  )  const [inline]

Gets the edge label font size.

Returns:
The edge label font size.

void EdgeExport::SetFontSize ( int32_t  s  )  [inline]

Sets the edge label font size.

Parameters:
s [in] The edge label font size.


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

Generated on Fri Feb 7 13:09:52 2014 for Sparksee by  doxygen 1.5.6