A class for describing mouse modes in use in VAPOR. More...

#include <MouseModeParams.h>

Inheritance diagram for MouseModeParams:

Classes
struct	MouseMode

Public Member Functions
	MouseModeParams (VAPoR::ParamsBase::StateSave *ssave)
	Create a MouseModeParams object from scratch.

	MouseModeParams (VAPoR::ParamsBase::StateSave ssave, VAPoR::XmlNode node)
	Create a MouseModeParams object from an existing XmlNode tree.

virtual	~MouseModeParams ()

const char const	GetIcon (string name) const
	method identifies pixmap icon for each mode

string	GetCurrentMouseMode () const

void	SetCurrentMouseMode (string name)

int	GetNumMouseModes ()
	method indicates how many mouse modes are available.

vector< string >	GetAllMouseModes ()
	Return a vector of all registered mouse mode names.

Public Member Functions inherited from VAPoR::ParamsBase
	ParamsBase (StateSave *ssave, const string &classname)

	ParamsBase (StateSave ssave, XmlNode node)

	ParamsBase (const ParamsBase &rhs)
	Copy constructor.

ParamsBase &	operator= (const ParamsBase &rhs)

	ParamsBase (ParamsBase &&)=delete

ParamsBase &	operator= (ParamsBase &)=delete

bool	operator== (const ParamsBase &rhs) const
	Equivalence operator.

bool	operator!= (const ParamsBase &rhs) const

virtual	~ParamsBase ()

void	SetParent (ParamsBase *parent)

XmlNode *	GetNode () const

void	BeginGroup (const string &description)

void	EndGroup ()

void	IntermediateChange ()

virtual vector< long >	GetValueLongVec (const string tag) const

virtual vector< long >	GetValueLongVec (const string tag, const vector< long > &defaultVal) const

virtual long	GetValueLong (const string tag, long defaultVal) const

virtual vector< double >	GetValueDoubleVec (const string tag) const

virtual vector< double >	GetValueDoubleVec (const string tag, const vector< double > &defaultVal) const

virtual double	GetValueDouble (const string tag, double defaultVal) const

virtual vector< string >	GetValueStringVec (const string tag) const

virtual vector< string >	GetValueStringVec (const string tag, const vector< string > &defaultVal) const

virtual string	GetValueString (const string tag, string defaultVal) const

virtual void	SetValueLongVec (const string &tag, string description, const vector< long > &values)

virtual void	SetValueLong (const string &tag, string description, long value)

virtual void	SetValueDoubleVec (const string &tag, string description, const vector< double > &values)

virtual void	SetValueDouble (const string &tag, string description, double value)

virtual void	SetValueStringVec (const string &tag, string description, const vector< string > &values)

virtual void	SetValueString (const string &tag, string description, const string &value)

string	GetName () const

Public Member Functions inherited from Wasp::MyBase
	MyBase ()

const string &	getClassName () const

Static Public Member Functions
static string	GetClassType ()

static string	GetNavigateModeName ()

static string	GetRegionModeName ()

Static Public Member Functions inherited from Wasp::MyBase
static void	SetErrMsg (const char *format,...)
	Record a formatted error message.

static void	SetErrMsg (int errcode, const char *format,...)
	Record a formatted error message and an error code.

static const char *	GetErrMsg ()

static void	SetErrCode (int err_code)
	Record an error code.

static int	GetErrCode ()
	Retrieve the current error code.

static void	SetErrMsgCB (ErrMsgCB_T cb)

static ErrMsgCB_T	GetErrMsgCB ()

static void	SetErrMsgFilePtr (FILE *fp)

static const FILE *	SetErrMsgFilePtr ()

static void	SetDiagMsg (const char *format,...)
	Record a formatted diagnostic message.

static const char *	GetDiagMsg ()

static void	SetDiagMsgCB (DiagMsgCB_T cb)

static DiagMsgCB_T	GetDiagMsgCB ()

static void	SetDiagMsgFilePtr (FILE *fp)

static bool	EnableErrMsg (bool enable)

static bool	GetEnableErrMsg ()

Additional Inherited Members
Public Types inherited from Wasp::MyBase
typedef void(*	ErrMsgCB_T) (const char *msg, int err_code)

typedef void(*	DiagMsgCB_T) (const char *msg)

Static Public Attributes inherited from Wasp::MyBase
static char *	ErrMsg

static int	ErrCode

static int	ErrMsgSize

static FILE *	ErrMsgFilePtr

static ErrMsgCB_T	ErrMsgCB

static char *	DiagMsg

static int	DiagMsgSize

static FILE *	DiagMsgFilePtr

static DiagMsgCB_T	DiagMsgCB

static bool	Enabled

Protected Member Functions inherited from VAPoR::ParamsBase
	ParamsBase (StateSave *ssave)

void	Remove (const string &name)

const map< string, string > &	GetAttributes ()

void	Clear ()

Protected Member Functions inherited from Wasp::MyBase
void	SetClassName (const string &name)

Protected Attributes inherited from VAPoR::ParamsBase
StateSave *	_ssave

XmlNode *	_node

Detailed Description

A class for describing mouse modes in use in VAPOR.

Author: Alan Norton

Version: 3.0

Date: April 2014

Definition at line 35 of file MouseModeParams.h.

Constructor & Destructor Documentation

◆ MouseModeParams() [1/2]

MouseModeParams::MouseModeParams ( VAPoR::ParamsBase::StateSave * ssave )

Create a MouseModeParams object from scratch.

◆ MouseModeParams() [2/2]

MouseModeParams::MouseModeParams	(	VAPoR::ParamsBase::StateSave *	ssave,
		VAPoR::XmlNode *	node
	)

Create a MouseModeParams object from an existing XmlNode tree.

◆ ~MouseModeParams()

virtual MouseModeParams::~MouseModeParams ( )

virtual

Member Function Documentation

◆ GetAllMouseModes()

vector< string > MouseModeParams::GetAllMouseModes ( )

inline

Return a vector of all registered mouse mode names.

Definition at line 78 of file MouseModeParams.h.

◆ GetClassType()

static string MouseModeParams::GetClassType ( )

inlinestatic

Definition at line 87 of file MouseModeParams.h.

◆ GetCurrentMouseMode()

string MouseModeParams::GetCurrentMouseMode ( ) const

inline

method indicates the current mouse mode

Return values

current mouse mode

Definition at line 65 of file MouseModeParams.h.

References VAPoR::ParamsBase::GetValueString().

◆ GetIcon()

const char *const * MouseModeParams::GetIcon ( string name ) const

inline

method identifies pixmap icon for each mode

Definition at line 53 of file MouseModeParams.h.

References VAssert.

◆ GetNavigateModeName()

static string MouseModeParams::GetNavigateModeName ( )

inlinestatic

Definition at line 89 of file MouseModeParams.h.

◆ GetNumMouseModes()

int MouseModeParams::GetNumMouseModes ( )

inline

method indicates how many mouse modes are available.

Definition at line 74 of file MouseModeParams.h.

◆ GetRegionModeName()

static string MouseModeParams::GetRegionModeName ( )

inlinestatic

Definition at line 91 of file MouseModeParams.h.

◆ SetCurrentMouseMode()

void MouseModeParams::SetCurrentMouseMode ( string name )

method sets the current mouse mode

Parameters

[in] name current mouse mode

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

/Users/pearse/VAPOR/include/vapor/MouseModeParams.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MouseModeParams() [1/2]

◆ MouseModeParams() [2/2]

◆ ~MouseModeParams()

Member Function Documentation

◆ GetAllMouseModes()

◆ GetClassType()

◆ GetCurrentMouseMode()

◆ GetIcon()

◆ GetNavigateModeName()

◆ GetNumMouseModes()

◆ GetRegionModeName()

◆ SetCurrentMouseMode()