Qt4Pi

TXSLib : Class TScalarWidget

La classe TScalarWidget est parente de toutes les classes de widgets qui représentent une vlauer numérique scalaire. Elle complémente la classe TWidget en ajoutant un indicateur numérique en bas du cadre du widget et une zone de couleur définissant les couleurs de certaines parties actives du widget en fonction de la données scalaire qu'il représente.

La classe TScalarWidget est abstraite, vous ne pouvez pas créer un objet de ce type.

Relations d'héritage

- Hérite de :
- TWidget.

- Est Héritée par :
- TAnalogLed
- TCircularScalarWidget
- TLinearScalarWidget
- TScrollRuler
- TThumbWheel

Fonctions publiques

bool	AppendColorZone(const double& Min,const double& Max, const QColor& Color)
bool	AreColorZonesEmpty()
void	ClearColorZones()
bool	GetColorFromValue(const double& Value, QColor* pOutColor)
bool	GetColorZoneColor(const int& nZone, QColor* pOutColor)
bool	GetColorZoneMax(const int& nZone, double* pOutValue)
bool	GetColorZoneMin(const int& nZone, double* pOutValue)
bool	GetColorZoneMinMax(const int& nZone, , double* pOutValueMin, double* pOutValueMax)
bool	GetColorZoneProperties(const int& nZone, QColor* pOutColor, double* pOutValueMin, double* pOutValueMax)
bool	InsertColorZone(int Position, const double& Min,const double& Max, const QColor& Color)
int	NumberOfColorZones()
bool	PrependColorZone(const double& Min,const double& Max, const QColor& Color)
bool	RemoveColorZoneAt(int Position)
bool	SortColorZones()
bool	UpdateColorZone(int Position, const double& Min,const double& Max, const QColor& Color)

Propriétés

Propriétés	Type	Ecriture	Lecture
NumericIndicatorDigitsAfterDecimalSeparator	uint	SetNumericIndicatorDigitsAfte...	GetNumericIndicatorDigitsAft...
NumericIndicatorDigitsBeforeDecimalSeparator	uint	SetNumericIndicatorDigitsBefo...	GetNumericIndicatorDigitsBef...
NumericIndicatorEnableGroupSeparator	bool	SetNumericIndicatorEnableGroup...	GetNumericIndicatorEnableGr...
NumericIndicatorFont	QFont	SetNumericIndicatorFont	GetNumericIndicatorFont
NumericIndicatorForceCLocal	bool	SetNumericIndicatorForceCLocal	GetNumericIndicatorForceC...
NumericIndicatorForceSign	bool	SetNumericIndicatorForceSign	GetNumericIndicatorForceSign
NumericIndicatorForegroundColor	QColor	SetNumericIndicatorForegroundColor	GetNumericIndicatorForegrou...
NumericIndicatorHrzAlignment	TXS::HrzAlignment	SetNumericIndicatorHrzAlignment	GetNumericIndicatorHrzAlig...
NumericIndicatorNumberFormat	TXS::NumberFormat	SetNumericIndicatorNumberFormat	GetNumericIndicatorNumber...
NumericIndicatorPadCharacter	QChar	SetNumericIndicatorPadCharacter	GetNumericIndicatorPadChar...
NumericIndicatorPrefix	QString	SetNumericIndicatorPrefix	GetNumericIndicatorPrefix
NumericIndicatorUnit	TXS::Unit	SetNumericIndicatorUnit	GetNumericIndicatorUnit
NumericIndicatorVisible	bool	SetNumericIndicatorVisible	GetNumericIndicatorVisible

bool TScalarWidget::AppendColorZone(const double& Min,const double& Max, const QColor& Color)

Description : Ajoute une zone de couleur à la fin de la liste des zones de couleurs.

Plus de détails : Zones de couleurs

Paramètre : Min - type const double& - Seuil bas de la zone de couleur.

Paramètre : Max - type const double& - Seuil haut de la zone de couleur.

Paramètre : Color - type const QColor& - Couleur de la zone de couleur.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool TScalarWidget::AreColorZonesEmpty()

Description : Retourne une valeur booléenne indiquant si la liste de zones de couleurs est vide ou non.

Plus de détails : Zones de couleurs

Valeur de retour : Retourne true si la liste de zones de couleurs est vvide, sinon retourne false.

void TScalarWidget::ClearColorZones()

Description : Efface toutes les zones de couleurs de la liste de zones de couleurs.

Plus de détails : Zones de couleurs

bool TScalarWidget::GetColorFromValue(const double& Value, QColor* pOutColor)

Description : Retourne la couleur associée à une valeur numérique depuis la liste de zones de couleurs.

Plus de détails : Zones de couleurs

Paramètre : Value - type const double& - Valeur pour laquelle la couleur est retournée.

Paramètre de sortie : pOutColor - type QColor* - En retour de la fonction la valeur pointée sera la couleur de la zone à laquelle appartient la valeur Value.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction. Retourne false si la valeur ne peut être trouvée dans les zones de couleurs.

bool TScalarWidget::GetColorZoneColor(const int& nZone, QColor* pOutColor)

Description : Retourne la couleur associée à une zone de couleur depuis la liste de zones de couleurs.

Plus de détails : Zones de couleurs

Paramètre : nZone - type const int& - Indice de la zone de couleur dans la liste des zones de couleurs.

Paramètre de sortie : pOutColor - type QColor* - En retour de la fonction la valeur pointée sera la couleur de la zone à l'indice nZone.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction. Retourne false si la zone ne peut être trouvée dans les zones de couleurs.

bool TScalarWidget::GetColorZoneMax(const int& nZone, double* pOutValueMax)

Description : Retourne la valeur de seuil haut associée à une zone de couleur depuis la liste de zones de couleurs.

Plus de détails : Zones de couleurs

Paramètre : nZone - type const int& - Indice de la zone de couleur dans la liste des zones de couleurs.

Paramètre de sortie : pOutValueMax - type double* - En retour de la fonction la valeur pointée sera la valeur de seuil haut de la zone à l'indice nZone.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction. Retourne false si la zone ne peut être trouvée dans les zones de couleurs.

bool TScalarWidget::GetColorZoneMin(const int& nZone, double* pOutValueMin)

Description : Retourne la valeur de seuil bas associée à une zone de couleur depuis la liste de zones de couleurs.

Plus de détails : Zones de couleurs

Paramètre : nZone - type const int& - Indice de la zone de couleur dans la liste des zones de couleurs.

Paramètre de sortie : pOutValueMin - type double* - En retour de la fonction la valeur pointée sera la valeur de seuil bas de la zone à l'indice nZone.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction. Retourne false si la zone ne peut être trouvée dans les zones de couleurs.

bool TScalarWidget::GetColorZoneMinMax(const int& nZone, double* pOutValueMin, double* pOutValueMax)

Description : Retourne les valeurs de seuils bas et haut associées à une zone de couleur depuis la liste de zones de couleurs.

Plus de détails : Zones de couleurs

Paramètre : nZone - type const int& - Indice de la zone de couleur dans la liste des zones de couleurs.

Paramètre de sortie : pOutValueMin - type double* - En retour de la fonction la valeur pointée sera la valeur de seuil bas de la zone à l'indice nZone.

Paramètre de sortie : pOutValueMax - type double* - En retour de la fonction la valeur pointée sera la valeur de seuil haut de la zone à l'indice nZone.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction. Retourne false si la zone ne peut être trouvée dans les zones de couleurs.

bool TScalarWidget::GetColorZoneProperties(const int& nZone, QColor* pOutColor, double* pOutValueMin, double* pOutValueMax)

Description : Retourne les valeurs de seuils bas et haut ainsi que la couleur associées à une zone de couleur depuis la liste de zones de couleurs.

Plus de détails : Zones de couleurs

Paramètre : nZone - type const int& - Indice de la zone de couleur dans la liste des zones de couleurs.

Paramètre de sortie : pOutColor - type QColor* - En retour de la fonction la valeur pointée sera la couleur de la zone à l'indice nZone.

Paramètre de sortie : pOutValueMin - type double* - En retour de la fonction la valeur pointée sera la valeur de seuil bas de la zone à l'indice nZone.

Paramètre de sortie : pOutValueMax - type double* - En retour de la fonction la valeur pointée sera la valeur de seuil haut de la zone à l'indice nZone.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction. Retourne false si la zone ne peut être trouvée dans les zones de couleurs.

bool TScalarWidget::InsertColorZone(int Position, const double& Min,const double& Max, const QColor& Color)

Description : Insère à l'indice Position une nouvelle zone de couleur dans la liste de zones de couleurs.

Plus de détails : Zones de couleurs

Paramètre : Position - type int - Indice dans la liste de zones de couleurs ou insérer la nouvelle zone de couleur.

Paramètre : Min - type const double& - Seuil bas de la zone de couleur.

Paramètre : Max - type const double& - Seuil haut de la zone de couleur.

Paramètre : Color - type const QColor& - Couleur de la zone de couleur.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

int TScalarWidget::NumberOfColorZones()

Description : Retourne le nombre de zones de couleurs dans la liste de zones de couleurs.

Plus de détails : Zones de couleurs

Valeur de retour :Nombre de zones de couleurs dans la liste de zones de couleurs.

bool TScalarWidget::PrependColorZone(const double& Min,const double& Max, const QColor& Color)

Description : Ajoute une zone de couleur en début de la liste des zones de couleurs.

Plus de détails : Zones de couleurs

Paramètre : Min - type const double& - Seuil bas de la zone de couleur.

Paramètre : Max - type const double& - Seuil haut de la zone de couleur.

Paramètre : Color - type const QColor& - Couleur de la zone de couleur.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool TScalarWidget::RemoveColorZoneAt(int Position)

Description : Supprime de la liste de zones de couleurs la zone à l'indice Position.

Plus de détails : Zones de couleurs

Paramètre : Position - type int - Indice de la zone de couleur dans la liste des zones de couleurs.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction. Retourne false si la zone ne peut être trouvée dans les zones de couleurs.

void TScalarWidget::SortColorZones()

Description : Trie la liste de zones de couleurs de manière ascendante.

Plus de détails : Zones de couleurs

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.

bool TScalarWidget::UpdateColorZone(int Position, const double& Min,const double& Max, const QColor& Color)

Description : Modifie les propriétés de la zone de couleur à l'indice Position dans la liste de zones de couleurs.

Plus de détails : Zones de couleurs

Paramètre : Position - type int - Indice dans la liste de zones de couleurs ou modifier.

Paramètre : Min - type const double& - Seuil bas de la zone de couleur.

Paramètre : Max - type const double& - Seuil haut de la zone de couleur.

Paramètre : Color - type const QColor& - Couleur de la zone de couleur.

Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction. Retourne false si la zone ne peut être trouvée dans les zones de couleurs.

NumericIndicatorDigitsAfterDecimalSeparator

Description : Cette propriété définie le nombre de chiffres après le séparateur décimal. Le comportement de cette propriété dépend de la valeur de la propriété NumericIndicatorNumberFormat.

Plus de détails : Formatage des nombres

Type : int

Valeur par défaut : 6

Ecriture : void SetNumericIndicatorDigitsAfterDecimalSeparator(const int& nDigits)

Lecture : int GetNumericIndicatorDigitsAfterDecimalSeparator();

NumericIndicatorDigitsBeforeDecimalSeparator

Description : Cette propriété définie le nombre de chiffres avant le séparateur décimal. Le comportement de cette propriété dépend de la valeur de la propriété NumericIndicatorNumberFormat.

Plus de détails : Formatage des nombres

Type : int

Valeur par défaut : 6

Ecriture : void SetNumericIndicatorDigitsBeforeDecimalSeparator(const int& nDigits)

Lecture : int GetNumericIndicatorDigitsBeforeDecimalSeparator();

NumericIndicatorEnableGroupSeparator

Description : Cette propriété définie si un espace doit être insérer entre chaque groupe de 3 chiffres. Le comportement de cette propriété dépend de la valeur de la propriété NumericIndicatorNumberFormat.

Plus de détails : Formatage des nombres

Type : bool

Valeur par défaut : true

Ecriture : void SetNumericIndicatorEnableGroupSeparator(const bool& Tf)

Lecture : bool GetNumericIndicatorEnableGroupSeparator();

NumericIndicatorFont

Description : Cette propriété définie la police de caractères de l'indicateur numérique.

Type : QFont

Valeur par défaut : Police de caraactères par défaut de l'application.

Ecriture : void SetNumericIndicatorFont(const QFont& font)

Lecture : QFont GetNumericIndicatorFont();

NumericIndicatorForceCLocal

Description : Cette propriété définie si l'indicateur numérique formatte le nombre au format "C" ou le séparateur décimal est toujours un point. Le comportement de cette propriété dépend de la valeur de la propriété NumericIndicatorNumberFormat.

Plus de détails : Formatage des nombres

Type : bool

Valeur par défaut : false

Ecriture : void SetNumericIndicatorForceCLocal(const bool& Tf)

Lecture : bool GetNumericIndicatorForceCLocal();

NumericIndicatorForceSign

Description : Cette propriété définie si l'indicateur numérique affiche toujours le signe, y compmris pour les valeurs positives. Le comportement de cette propriété dépend de la valeur de la propriété NumericIndicatorNumberFormat.

Plus de détails : Formatage des nombres

Type : bool

Valeur par défaut : false

Ecriture : void SetNumericIndicatorForceSign(const bool& Tf)

Lecture : bool GetNumericIndicatorForceSign();

NumericIndicatorForegroundColor

Description : Cette propriété définie la couleur de l'indicateur numérique du widget lorsque celui-ci est visible.

Plus de détails : Styles des widgets

Type : QColor

Valeur par défaut : Couleur de la palette courante de l'application avec le rôle "QPalette::ButtonText" et la groupe "QPalette::Active". (Voir la classe QPalette de Qt)

Ecriture : void SetNumericIndicatorForegroundColor(const QColor& Color)

Lecture : QColor GetNumericIndicatorForegroundColor();

NumericIndicatorHrzAlignment

Description : Cette propriété définie la position horizontale de l'indicateur numérique du widget lorsque celui-ci est visible.

Plus de détails : Formatage des nombres

Type : TXS::HrzAlignment

Valeur par défaut : TXS::AlignCenter.

Ecriture : void SetNumericIndicatorHrzAlignment(const TXS::HrzAlignment& Align)

Lecture : TXS::HrzAlignment GetNumericIndicatorHrzAlignment();

NumericIndicatorNumberFormat

Description : Cette propriété définie le format d'affichage du nombre par l'indicateur numérique du widget lorsque celui-ci est visible.

Plus de détails : Formatage des nombres

Type : TXS::NumberFormat

Valeur par défaut : TXS::NumberFormat_Any_Compact.

Ecriture : void SetNumericIndicatorHrzAlignment(const TXS::NumberFormat& Format)

Lecture : TXS::NumberFormat GetNumericIndicatorHrzAlignment();

NumericIndicatorPadCharacter

Description : Cette propriété définie le caractère de remplissage aux endroits d'un nombre ou aucun chiffre n'apparait. Le comportement de cette propriété dépend de la valeur de la propriété NumericIndicatorNumberFormat.

Plus de détails : Formatage des nombres

Type : QChar

Valeur par défaut : '_'

Ecriture : void SetNumericIndicatorPadCharacter(const QChar& PadChar)

Lecture : QChar GetNumericIndicatorPadCharacter();

NumericIndicatorPrefix

Description : Cette propriété définie le préfixe de l'indicateur numérique.

Plus de détails : Formatage des nombres

Type : QString

Valeur par défaut : ""

Ecriture : void SetNumericIndicatorPrefix(const QString& strPrefix)

Lecture : QString GetNumericIndicatorPrefix();

NumericIndicatorUnit

Description : Cette propriété définie l'unité de mesure de l'indicateur numérique.

Cette propriété recouvre deux paramètres. Il n'y a qu'une fonction d'écriture pour les 2 paramètres et 2 fonctions de lecture, une pour chaque paramètre. Si le paramètre de type TXS::Unit est fixé à la valeur TXS::Unit_userdefined, alors l'unité est définie par le paramètre de type QString.

Plus de détails : Formatage des nombres

Type : TXS::Unit et QString

Valeur par défaut : TXS::Unit_nounit et ""

Ecriture : void SetNumericIndicatorUnit(const TXS::Unit& eUnit, const QString& strUserDefinedUnit)

Lecture : TXS::Unit GetNumericIndicatorUnit();

Lecture : QString GetNumericIndicatorUserDefinedUnit();

NumericIndicatorVisible

Description : Cette propriété définie si l'indicateur numérique du widget est visible ou non.

Type : bool

Valeur par défaut : true.

Ecriture : void SetNumericIndicatorVisible(const bool& Tf)

Lecture : bool GetNumericIndicatorVisible();