DParameterColorChoice.h

Classes

DParameterColorChoice -- Implementation of DParameterChoice to store color selection parameters. (full description)

class DParameterColorChoice : public DParameterChoice

Interface

Public Members
DParameterColorChoice(const String name, const String description, const String help, const String context = "", const Bool editable = True)
DParameterColorChoice(const DParameterColorChoice &other)
virtual ~DParameterColorChoice()
DParameterColorChoice &operator=(const DParameterColorChoice &other)
Protected Members
DParameterColorChoice()

Description

Prerequisite

Etymology

DParameterColorChoice is an implementation of a DisplayParameter providing a choice parameter type tuned to selecting colors.

Motivation

It is common to have the user select a color for a particular element of the display, hence this class.

Thrown Exceptions

To Do

Member Description

DParameterColorChoice(const String name, const String description, const String help, const String context = "", const Bool editable = True)

Constructor takes the name of the parameter, a short description and some help text. The context of the parameter, and whether it is editable, can also be given. The default and initial color is always the foreground color.

DParameterColorChoice(const DParameterColorChoice &other)

Copy constructor using copy semantics.

virtual ~DParameterColorChoice()

Destructor.

DParameterColorChoice &operator=(const DParameterColorChoice &other)

Copy assignment.

DParameterColorChoice()

(Required) default constructor.