coChoiceParam.h

Go to the documentation of this file.

/* This file is part of COVISE.

   You can use it under the terms of the GNU Lesser General Public License
   version 2.1 or later, see lgpl-2.1.txt.

 * License: LGPL 2+ */

#ifndef _CO_CHOICE_PARAM_H_
#define _CO_CHOICE_PARAM_H_

// +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// +                                                                         +
// +  coChoiceParam Parameter handling class                                +
// +                                                                         +
// +                           Andreas Werner                                +
// +         (C)  Computing Center University of Stuttgart                   +
// +                          Allmandring 30a                                +
// +                          70550 Stuttgart                                +
// + Date:  19.07.99                                                         +
// +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

#include <covise/covise.h>
#include "coUifPara.h"

namespace covise
{

class APIEXPORT coChoiceParam : public coUifPara
{

private:
    enum
    {
        MAX_CHOICE_LABELS = 256
    };

    coChoiceParam(const coChoiceParam &);

    coChoiceParam &operator=(const coChoiceParam &);

    coChoiceParam();

    static coUifPara::Typeinfo s_paraType;

    int d_numChoices;
    int d_activeChoice;
    char **d_choice;

    // Parameter type name
    static const char *s_type;

public:
    coChoiceParam(const char *name, const char *desc);

    virtual ~coChoiceParam();

    virtual int isOfType(coUifPara::Typeinfo type);

    static coUifPara::Typeinfo getType();

    virtual int paramChange();

    virtual void initialize();

    virtual void print(ostream &str) const;

    typedef enum
    {
        CASE_SENSITIVE,
        CASE_INSENSITIVE,
        ALPHA
    } cmpMode;

    int updateValue(int numChoices, const char *const *choice, int actChoice, cmpMode cmp = CASE_INSENSITIVE);

    int setValue(int numChoices, const char *const *choice, int actChoice);
    int setValue(int numChoices, const std::vector<string> &list, int actChoice);

    int setValue(int actChoice);

    int setValue(const char *choiceLabel);

    int getValue() const;

    const char *getActLabel() const;

    const char *getLabel(int i) const;

    int getNumChoices() const;

    virtual const char *getTypeString() const;

    virtual const char *getValString() const;

    virtual void setValString(const char *str);
};
}
#endif