A catalog for color schemes.
More...
#include <ColorSchemeCatalog.h>
A catalog for color schemes.
A color scheme catalog contains several color scheme groups that can be choosed by the user in order to color a given map.
- See also
- ColorScheme, ColorSchemeGroup, ColorSchemeCatalogManager
- Note
- Any doubts, please, send us an e-mail to help improve the documentation quality!
Definition at line 58 of file ColorSchemeCatalog.h.
◆ ColorSchemeCatalog() [1/2]
te::color::ColorSchemeCatalog::ColorSchemeCatalog |
( |
const std::string & |
name | ) |
|
◆ ~ColorSchemeCatalog()
te::color::ColorSchemeCatalog::~ColorSchemeCatalog |
( |
| ) |
|
◆ ColorSchemeCatalog() [2/2]
Copy constructor not allowed.
- Parameters
-
rhs | The right-hand-side copy that would be used to copy from. |
◆ disconnect()
It removes the internal reference to the group.
- Parameters
-
group | The group to remove the internal reference. |
- Note
- The caller of thi smethod will take the ownership of the group.
◆ getAuthor()
const std::string& te::color::ColorSchemeCatalog::getAuthor |
( |
| ) |
const |
It returns the catalog author name.
- Returns
- The catalog author name.
◆ getColorSchemeGroups()
const std::vector<ColorSchemeGroup*>& te::color::ColorSchemeCatalog::getColorSchemeGroups |
( |
| ) |
const |
It returns the list of color scheme groups in the catalog.
- Returns
- The list of color scheme groups in the catalog.
◆ getCopyright()
const std::string& te::color::ColorSchemeCatalog::getCopyright |
( |
| ) |
const |
It returns the catalog copyright notice.
- Returns
- The catalog copyright notice.
◆ getDescription()
const std::string& te::color::ColorSchemeCatalog::getDescription |
( |
| ) |
const |
It returns the catalog description.
- Returns
- The catalog description.
◆ getName()
const std::string& te::color::ColorSchemeCatalog::getName |
( |
| ) |
const |
It returns the catalog name.
- Returns
- The catalog name.
◆ getOnlineResource()
const std::string& te::color::ColorSchemeCatalog::getOnlineResource |
( |
| ) |
const |
It returns a link for more information about the catalog.
- Returns
- A link for more information about the catalog.
◆ operator=()
Assignment operator not allowed.
- Parameters
-
rhs | The right-hand-side copy that would be used to copy from. |
- Returns
- A reference to this object.
◆ push_back()
It adds a new group to the catalog and sets its relationship.
- Parameters
-
group | The group that will take part of the catalog. |
- Note
- The catalog will take the ownership of the group.
-
Don't inform a NULL pointer.
◆ setAuthor()
void te::color::ColorSchemeCatalog::setAuthor |
( |
const std::string & |
author | ) |
|
It sets the catalog author name.
- Parameters
-
author | The catalog author name. |
◆ setCopyright()
void te::color::ColorSchemeCatalog::setCopyright |
( |
const std::string & |
c | ) |
|
It sets the catalog copyright notice.
- Parameters
-
c | The catalog copyright notice. |
◆ setDescription()
void te::color::ColorSchemeCatalog::setDescription |
( |
const std::string & |
d | ) |
|
It sets the catalog description.
- Parameters
-
d | The catalog description. |
◆ setName()
void te::color::ColorSchemeCatalog::setName |
( |
const std::string & |
newName | ) |
|
It changes the catalog name and adjusts its entry in the catalog manager if needed.
- Parameters
-
newName | The new catalog name (must be a non-empty value). |
◆ setOnlineResource()
void te::color::ColorSchemeCatalog::setOnlineResource |
( |
const std::string & |
r | ) |
|
It sets the link for more information about the catalog.
- Parameters
-
r | The link for more information about the catalog. |
◆ m_author
std::string te::color::ColorSchemeCatalog::m_author |
|
private |
◆ m_colorSchemeGroups
std::vector<ColorSchemeGroup*> te::color::ColorSchemeCatalog::m_colorSchemeGroups |
|
private |
◆ m_copyright
std::string te::color::ColorSchemeCatalog::m_copyright |
|
private |
◆ m_description
std::string te::color::ColorSchemeCatalog::m_description |
|
private |
◆ m_name
std::string te::color::ColorSchemeCatalog::m_name |
|
private |
◆ m_onlineResource
std::string te::color::ColorSchemeCatalog::m_onlineResource |
|
private |
The documentation for this class was generated from the following file: