TXSLib : Class TGraphAxis

La classe TGraphAxis représente un axe d'un repère orthonormé utilisé par la classe :


 - Graph


Et ses descendantes :


 - TXYGraph
 - TYGraph


Cette classe hérite de la classe :


 - TAxis


La classe TGraphAxis complémente la classe TAxis avec un titre d'axe pouvant inclure une unité de mesure.

Cette classe ne peut pas être instanciée par un programme utilisateur. Les objets de cette classe sont créés par les classes héritant de TWidget lorsque le widget utilise 1 ou plusieurs axes. La classe du widget fournie toujours les fonctions et propriétés permettant de manipuler les axes. Ce filtrage par ce widget aux fonctionnalités des classes d'axes permet de s'assurer de la compatibilité des réglages avec le widget lui même. Cependant les classes TYGraph et TXYGraph permettent un accès aux axes via la classe TGraph dont ils héritent et sa fonction Axis(const TXS::Axis& eAxis). Cela permet notamment d'accéder aux propriétés des objets TAxisGrid de chaque axe dont les propriétés n'ont pas besoin d'être filtrées. Les propriétés de l'axe nécessitant un filtrage par l'objet les utilisant sont également rendues inaccessibles en écriture via ce moyen.

Fonctions publiques

QStringGetFullTitle()
boolIsTitleVisible()
voidSetAllColors(const QColor& Color, const bool& bRefresh = true)
voidSetTitle(const QString& strTitle, const bool& bAddUnit = false, const bool& bRefresh = true)
voidSetUnitString(const TXS::Unit& Unit, const QString& UserDefinedUnit, const bool& bRefresh = true)

Propriétés

Propriétés Type Ecriture Lecture
Title QString GetTitle
TitleColor QColor SetTitleColor GetTitleColor
TitleFont QFont SetTitleFont GetTitleFont
Unit TXS::Unit GetUnit
UnitString QString GetUnitString
UserDefinedUnitString QString GetUserDefinedUnitString
Visible QString SetVisible GetVisible


QDateTime TGraphAxis::GetFullTitle()

Description : Cette fonction retourrne le titre complet de l'axe. Ce titre peut être complété d'une unité de mesure. Le titre est défini par un appel à la fonction SetTitle et l'unité par un appel à la fonction SetUnitString.


valeur de retour : Titer de l'axe et unité, si elle est définie



bool TGraphAxis::IsTitleVisible()

Description : Cete fonction retourne un booléen indiquant si le titre de l'axe existe et est visible.


valeur de retour : true si le titre est visible, sinon false.



void TGraphAxis::SetAllColors(const QColor& Color, const bool& bRefresh = true)

Description : Cette fonction permet d'ajuster tous les composants d'un axe à la même couleur.


Paramètre : Color - type QColor& - Couleur à appliquer.

Paramètre : bRefresh - bool& - Indique si le widget doit être mis à jour immédiatement. true par défaut.



void TGraphAxis::SetTitle(const QString& strTitle, const bool& bAddUnit = false, const bool& bRefresh = true)

Description : Cette fonction permet de définir le titre de l'axe et de préciser si ce titre doit inclure une unité de mesure ou non. L'unité de msure pourra être définie par un appel à la fonction SetUnitString.


Paramètre : strTitle - type QString& - Titre de l'axe.

Paramètre : bAddUnit - bool& - Indique si le titre inclus une unité de mesure. false par défaut.


Paramètre : bRefresh - bool& - Indique si le widget doit être mis à jour immédiatement. true par défaut.



void TGraphAxis::SetUnitString(const TXS::Unit& Unit, const QString& UserDefinedUnit, const bool& bRefresh = true)

Description : Cette fonction définie l'unité de mesure de l'axe.


Cette fonction recoit deux paramètres. 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 UserDefinedUnit QString.


Paramètre : Unit - type TXS::Unit& - Unité de mesure.

Paramètre : UserDefinedUnit - QString& - Unité de mesure définie apr l'utilisateur.


Paramètre : bRefresh - bool& - Indique si le widget doit être mis à jour immédiatement. true par défaut.



Title

Description : Cette propriété définie le titre d'un axe. Ce titre peut être définie par appel de la méthode SetTitle.


Type : QString

Valeur par défaut : Chaine vide

Lecture : QString GetTitle()



TitleColor

Description : Cette propriété définie la couleur du titre d'un axe. La fonction d'écriture reçoit un paramètre précisant si le widget doit être mis à jour immédiatement (true pas défaut).


Type : QColor

Valeur par défaut : QColor(255,255,255,255) : Blanc

Ecriture : SeTitleColor(const QColor& Color, const bool& bRefresh = true)

Lecture : QColor GetTitleColor()



TitleFont

Description : Cette propriété définie la police de caractères du titre d'un axe. La fonction d'écriture reçoit un paramètre précisant si le widget doit être mis à jour immédiatement (true pas défaut).


Type : QFont

Valeur par défaut : Police par défaut de l'application

Ecriture : SetTitleFont(const QColor& Color, const bool& bRefresh = true)

Lecture : QFont GetTitleFont()



Unit

Description : Cette propriété définie l'unité d'un axe. Lorsque cette propriété prend la valeur TXS::Unit_userdefined, l'unité est alors définie par la propriété UserDefinedUnitString. Cette propriété est ajustée via la méthode SetUnitString.


Type : TXS::Unit

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

Lecture : TXS::Unit GetUnit()



UnitString

Description : Cette propriété retourne l'unité d'un axe sous forme de chaine de caractères. Cette propriété est ajustée via la méthode SetUnitString.


Type : QString

Valeur par défaut : Chaine vide

Lecture : QString GetUnitString()



UserDefinedUnitString

Description : Cette propriété retourne l'unité d'un axe définie par l'utilisateur lorsque la propriété Unit. est fixée à la valeur TXS::Unit_userdefined. Cette propriété est ajustée via la méthode SetUnitString.


Type : QString

Valeur par défaut : Chaine vide

Lecture : QString UserDefinedUnitString()