sf::ProjectData::InformationVariables::DataCursor Struct Reference

Holds the custom variable list. More...

#include <ProjectData.h>

Inheritance diagram for sf::ProjectData::InformationVariables::DataCursor:

Collaboration diagram for sf::ProjectData::InformationVariables::DataCursor:

Public Member Functions
	DataCursor ()
	Initializing constructor.
void	variableEventHandler (EEvent, const Variable &, Variable &, bool) override
	Overridden method from base class sf::VariableHandler.
Public Member Functions inherited from sf::VariableHandler
virtual	~VariableHandler ()
	Destructor clears the link with variable instances so no errors occur when the link is destructed before the variable is.

Public Attributes
ProjectData *	ProjData {nullptr}
Value::int_type	PopIndex {0}
	Hold the project data instance pointer.
Value::flt_type	Fraction {0}
	Holds the pop index in the pop data of the current cursor position.
Value::int_type	Index {0}
	Holds the fraction of the scan line at the cursor position.
int	Event {0}
	Holds the index in the data of the cursor position.
bool	Active {false}
	Holds button up down and ctrl/shift/alt key status.
Variable	vPopIndex
Variable	vEvent
	Variable for synchronising the data members with when they exist.
Variable	vFraction
	Variable for synchronising the data members with when they exist.
Variable	vIndex
	Variable for synchronising the data members with when they exist.

Additional Inherited Members
Public Types inherited from sf::VariableTypes
enum	EEvent : int {   veConvert = 64000 , veNewId = -32000 , veUserGlobal , veFirstLocal = 0 ,   veFlagsChange = 1 , veValueChange = 2 , veInvalid = 3 , veConverted = 4 ,   veUserLocal = 5 , veFirstPrivate = 16000 , veIdChanged = 16001 , veDesiredId = 16002 ,   veRemove = 16003 , veGetOwner = 16004 , veLostOwner = 16005 , veLinked = 16006 ,   veUnlinked = 16007 , veSetup = 16008 , veUserPrivate = 16009 }
	Events send to the handler set with sf::Variable::setHandler. More...
enum	EField : int {   vfId = 0 , vfName , vfUnit , vfFlags ,   vfDescription , vfType , vfConversionType , vfRound ,   vfDefault , vfMinimum , vfMaximum , vfFirstState }
	Enumeration of the order of fields in the setup string. More...
enum	EFlag : flags_type {   flgReadonly = 1 << 0 , flgArchive = 1 << 1 , flgShare = 1 << 2 , flgLink = 1 << 3 ,   flgFunction = 1 << 4 , flgParameter = 1 << 5 , flgHidden = 1 << 6 , flgExport = 1 << 7 ,   flgWriteable = 1 << 8 }
	Enumeration type for specifying flags. More...
enum	EStringType : int {   stNormal = 0 , stMulti , stPath , stDirectory ,   stFilename , stSubdirectory }
	Enumeration of string types used for filtering. More...
typedef TVector< Variable * >	PtrVector
	Vector for pointers to variables.
typedef TVector< Variable >	Vector
	Vector for instances of variables.
typedef TVector< VariableReference * >	ReferenceVector
	Types for internal use.
Public Types inherited from sf::InformationTypes
typedef unsigned long long	id_type
	Type used for the identifying integer (64-bits).
typedef int32_t	flags_type
	Type used for the flag integer.
typedef size_t	size_type
	Type used for size of vectors.
typedef ssize_t	ssize_type
	Same as size_type but a signed version.
typedef uintptr_t	data_type
	Type used for containing a single data element which is the largest integer.
typedef intptr_t	sdata_type
	Type used for containing a single data element which is the largest signed integer.
typedef TVector< id_type >	IdVector
	Vector for lists of information ID's.
typedef TVector< InformationBase * >	Vector
	Vector for containing different information base derived classes.
Static Public Member Functions inherited from sf::InformationTypes
template<typename T >
static constexpr std::enable_if_t<(sizeof(T)<=sizeof(data_type)), data_type >	toDataType (T value)
	Casts any type to a data_type value.
template<typename T >
static constexpr std::enable_if_t<(sizeof(T)<=sizeof(data_type)||std::is_reference_v< T >), T >	fromDataType (data_type value)
	Casts a data_type value to a given type. Reference types are also possible since they are the same size as a pointer underwater.
Static Public Attributes inherited from sf::InformationTypes
static constexpr size_t	npos = std::numeric_limits<size_type>::max()
	Unsigned size value indicating not found or no index.

Detailed Description

Holds the custom variable list.

Data cursor related variables.

Constructor & Destructor Documentation

DataCursor()

sf::ProjectData::InformationVariables::DataCursor::DataCursor ( )

inline

Initializing constructor.

Member Function Documentation

variableEventHandler()

void sf::ProjectData::InformationVariables::DataCursor::variableEventHandler ( EEvent  , const Variable &  , Variable &  , bool    )

overridevirtual

Overridden method from base class sf::VariableHandler.

Implements sf::VariableHandler.

Member Data Documentation

Active

bool sf::ProjectData::InformationVariables::DataCursor::Active {false}

Holds button up down and ctrl/shift/alt key status.

Event

int sf::ProjectData::InformationVariables::DataCursor::Event {0}

Holds the index in the data of the cursor position.

Fraction

Value::flt_type sf::ProjectData::InformationVariables::DataCursor::Fraction {0}

Holds the pop index in the pop data of the current cursor position.

Index

Value::int_type sf::ProjectData::InformationVariables::DataCursor::Index {0}

Holds the fraction of the scan line at the cursor position.

PopIndex

Value::int_type sf::ProjectData::InformationVariables::DataCursor::PopIndex {0}

Hold the project data instance pointer.

ProjData

ProjectData* sf::ProjectData::InformationVariables::DataCursor::ProjData {nullptr}

vEvent

Variable sf::ProjectData::InformationVariables::DataCursor::vEvent

Variable for synchronising the data members with when they exist.

vFraction

Variable sf::ProjectData::InformationVariables::DataCursor::vFraction

Variable for synchronising the data members with when they exist.

vIndex

Variable sf::ProjectData::InformationVariables::DataCursor::vIndex

Variable for synchronising the data members with when they exist.

vPopIndex

Variable sf::ProjectData::InformationVariables::DataCursor::vPopIndex

---

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

• ProjectData.h