| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions
TeLegendEntry Class Reference

A Legend Entry represents a group of objects of a theme. More...

`#include <TeLegendEntry.h>`

List of all members.

## Public Member Functions

| TeLegendEntry ()
| Empty constructor.
| TeLegendEntry (const TeSlice &slice)
| Constructor from a slice.
| TeLegendEntry (const TeLegendEntry &leg)
| Copy constructor.
TeLegendEntry & | operator= (const TeLegendEntry &leg)
| Operator =.
virtual | ~TeLegendEntry ()
| Destructor.
void | clear ()
| Clear the legend.
int | id ()
| Returns the legend id.
void | id (int i)
| Sets the legend id.
int | theme ()
| Returns the theme identifier to which the legend belongs.
void | theme (int i)
| Sets the theme id to which this legend belongs to.
int | group ()
| Returns the group identifier associated to the legend.
void | group (int i)
| Sets the group identification to which this legend refers to.
TeVisual * | visual (TeGeomRep rep, const string &visualType="tevisual")
| Returns the visual presentation characteristics associated to a given representation.
void | setVisual (TeVisual *vis, TeGeomRep rep)
| Sets the visual presentation characteristics associated to a given representation.
void | setVisual (TeVisual &vis, TeGeomRep rep)
| Sets the visual presentation characteristics associated to a given representation.
TeGeomRepVisualMap & | getVisualMap ()
| Return the visual presentation characteristics map.
TeSlice & | slice ()
| Returns the slice associated to this legend.
void | setSlice (const TeSlice &sl)
int | count ()
| Returns the number of objects of the legend.
void | count (int n)
| Sets the number of objects with the legend.
void | incCount (int n=1)
| Increase the number of objects with the legend.
string | from ()
| Returns the lower value associated to the legend.
void | from (string &s)
| Sets the lower value associated to the legend.
string | to ()
| Returns the upper value associated to the legend.
void | to (string &s)
| Sets the upper value associated to the legend.
string | label ()
| Returns the label associated to the legend.
void | label (string &s)
| Sets the label associated to the legend.
void | color (TeColor &color)
| Sets the color associated to the legend.

## Detailed Description

A Legend Entry represents a group of objects of a theme.

A legend entry is associated to a group of a theme. It has a label and a TeSlice that defines a property of of the objects that fall into this legend. A legend entry has an associated label and the visual presentation characteristics of the objects that fall into this legend.

## Constructor & Destructor Documentation

TeLegendEntry::TeLegendEntry | ( |  | ) | `[inline]`

Empty constructor.

TeLegendEntry::TeLegendEntry | ( | const TeSlice & | slice | ) |

Constructor from a slice.

TeLegendEntry::TeLegendEntry | ( | const TeLegendEntry & | leg | ) |

Copy constructor.

virtual TeLegendEntry::~TeLegendEntry | ( |  | ) | `[inline, virtual]`

Destructor.

## Member Function Documentation

void TeLegendEntry::clear | ( | void |  | ) |

Clear the legend.

void TeLegendEntry::color | ( | TeColor & | color | ) |

Sets the color associated to the legend.

void TeLegendEntry::count | ( | int | n | ) | `[inline]`

Sets the number of objects with the legend.

int TeLegendEntry::count | ( |  | ) | `[inline]`

Returns the number of objects of the legend.

string TeLegendEntry::from | ( |  | ) | `[inline]`

Returns the lower value associated to the legend.

void TeLegendEntry::from | ( | string & | s | ) | `[inline]`

Sets the lower value associated to the legend.

TeGeomRepVisualMap& TeLegendEntry::getVisualMap | ( |  | ) | `[inline]`

Return the visual presentation characteristics map.

void TeLegendEntry::group | ( | int | i | ) | `[inline]`

Sets the group identification to which this legend refers to.

int TeLegendEntry::group | ( |  | ) | `[inline]`

Returns the group identifier associated to the legend.

void TeLegendEntry::id | ( | int | i | ) | `[inline]`

Sets the legend id.

int TeLegendEntry::id | ( |  | ) | `[inline]`

Returns the legend id.

void TeLegendEntry::incCount | ( | int | n = `1` | ) | `[inline]`

Increase the number of objects with the legend.

string TeLegendEntry::label | ( |  | ) |

Returns the label associated to the legend.

void TeLegendEntry::label | ( | string & | s | ) | `[inline]`

Sets the label associated to the legend.

TeLegendEntry & TeLegendEntry::operator= | ( | const TeLegendEntry & | leg | ) |

Operator =.

void TeLegendEntry::setSlice | ( | const TeSlice & | sl | ) | `[inline]`

void TeLegendEntry::setVisual | ( | TeVisual * | vis,
|  | TeGeomRep | rep
| ) |  |

Sets the visual presentation characteristics associated to a given representation.

void TeLegendEntry::setVisual | ( | TeVisual & | vis,
|  | TeGeomRep | rep
| ) |  |

Sets the visual presentation characteristics associated to a given representation.

TeSlice& TeLegendEntry::slice | ( |  | ) | `[inline]`

Returns the slice associated to this legend.

void TeLegendEntry::theme | ( | int | i | ) | `[inline]`

Sets the theme id to which this legend belongs to.

int TeLegendEntry::theme | ( |  | ) | `[inline]`

Returns the theme identifier to which the legend belongs.

string TeLegendEntry::to | ( |  | ) | `[inline]`

Returns the upper value associated to the legend.

void TeLegendEntry::to | ( | string & | s | ) | `[inline]`

Sets the upper value associated to the legend.

TeVisual * TeLegendEntry::visual | ( | TeGeomRep | rep,
|  | const string & | visualType = `"tevisual"`
| ) |  |

Returns the visual presentation characteristics associated to a given representation.

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

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/kernel/TeLegendEntry.h
- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/kernel/TeLegendEntry.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines