TXSLib : Class TWidget
La classe TWidget est la classe de la librairie TXSLib dont héritent toutes les classes représentant des Widgets affichables à l'écran. Elle expose des propriétés et méthodes communes à toutes les classes héritantes. Ces propriétés permettent notamment d'ajuster le titre des widgets, le fond, les caractérisstiques des bords, les marges intérieures, les caractéristiques d'ombrage lorsque le widget est désactivé, etc... Elle expose les méthodes permettant de sérialiser et désérialiser les widgets.
La classe TWidget est abstraite, vous ne pouvez pas créer un objet de ce type.
Relations d'héritage
- Hérite de :
- QFrame.
- Est Héritée par :
- TBinaryInput
- TBinaryViewer
- TDateTime
- TFrame
- TImage
- TImageList
- TLabel
- TLed
- TLedMatrix
- TNumber
- TPolarPlot
- TScalarWidget
- TSwitch
Fonctions publiques
| bool | LoadFrom(const QString& strFileName) |
| void | Refresh() |
| void | RefreshIfAutoRefreshIsEnabled() |
| bool | SaveTo(const QString& strFileName) |
Propriétés
| Propriétés | Type | Ecriture | Lecture |
| AutoRefreshEnabled | bool | SetAutoRefreshEnabled | IsAutoRefreshEnabled |
| BackgroundColor | QColor | SetBackgroundColor | GetBackgroundColor |
| BackgroundIsTransparent | bool | SetBackgroundIsTransparent | IsBackgroundTransparent |
| BorderColor | QColor | SetBorderColor | GetBorderColor |
| BorderEffectWidth | int | SetBorderEffectWidth | GetBorderEffectWidth |
| BorderLineStyle | TXS::LineStyle | SetBorderLineStyle | GetBorderLineStyle |
| BorderShadow | TXS::BorderShadow | SetBorderShadow | GetBorderShadow |
| BorderStyle | TXS::BorderStyle | SetBorderStyle | GetBorderStyle |
| BorderWidth | int | SetBorderWidth | GetBorderWidth |
| BottomMargin | int | SetBottomMargin | GetBottomMargin |
| Caption | QString | SetCaption | GetCaption |
| CaptionColor | QColor | SetCaptionColor | GetCaptionColor |
| CaptionFont | QFont | SetCaptionFont | GetCaptionFont |
| CaptionHrzAlignment | TXS::HrzAlignment | SetCaptionHrzAlignment | GetCaptionHrzAlignment |
| CaptionVisible | bool | SetCaptionVisible | GetCaptionVisible |
| FocusColor | QColor | SetFocusColor | GetFocusColor |
| FocusStyle | TXS::FocusStyle | SetFocusStyle | GetFocusStyle |
| LeftMargin | int | SetLeftMargin | GetLeftMargin |
| Margins | int | SetMargins | GetMargins |
| RightMargin | int | SetLeftMargin | GetLeftMargin |
| ShadeColor | QColor | SetShadeColor | GetShadeColor |
| ShadedWhenDisabled | bool | SetShadedWhenDisabled | GetShadedWhenDisabled |
| ShadeOpacity | int | SetShadeOpacity | GetShadeOpacity |
| ShadePattern | Qt::BrushStyle | SetShadePattern | GetShadePattern |
| TopMargin | int | SetTopMargin | GetTopMargin |
Description : Cette méthode permet de charger l'état des propriétés d'un widget depuis un fichier. Ce fichier aura auparavant été créé par la fonction SaveTo.
Plus de détails : Sérialisation des widgets
Paramètre : strFileName - type const QString& - Nom du fichier de sauvegarde du composant.
Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.
Description : Cette méthode déclenche une mise à jour du widget immédiate à l'écran.
Description : Cette méthode déclenche une mise à jour du widget immédiate à l'écran seulement si la propriété AutoRefreshEnabled vaut true.
Description : Cette méthode permet de sauver l'état des propriétés d'un widget dans un fichier. Ce fichier aura ensuite été lu par la fonction LoadFrom pour recharger l'état des propriétés.
Plus de détails : Sérialisation des widgets
Paramètre : strFileName - type const QString& - Nom du fichier de sauvegarde du composant.
Valeur de retour : Booléen indiquant le succès (true) ou l'échec (false) de la fonction.
Description : Cette propriété définie à quels moments un widget doit être mis à jour à l'écran. Lorsque cette propriété vaut true,
le widget est mis à jour automatiquement et immédiatement dès qu'une propriété de celui-ci est modifiée ou lorsque qu'une de ses fonctions est
utilisée et que celle-ci modifie son aspect. Si cette propriété vaut false, cette mise à jour n'est pas faite automatiquement, elle sera faite
uniquement par un appel à la fonction Refresh.
Placer cette propriété à la valeur false pendant l'initialisation d'un widget imposant la modification de plusieurs propriétés permet de ne retracer
le widget que lorsque toutes les propriétés ont été modifiées. Cela évite une mise à jour à chaque modification de propriété. En fin des modifications
des propriétés, il est conseillé de ramener ccette propriété à true de manière à ne pas avoir à gérer les mise à jour par le programme utilisateur.
Type : bool
Valeur par défaut : true
Ecriture : SetAutoRefreshEnabled(const bool& Tf)
Lecture : bool IsAutoRefreshEnabled();
Description : Cette propriété définie la couleur de fond du widget. Cette couleur est appliquée au fond du widget uniquement si la propriété BackgroundIsTransparent est auparavant placée à true.
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::Button" et la groupe "QPalette::Active". (Voir la classe QPalette de Qt)
Ecriture : SetBackgroundColor(const QColor& Color)
Lecture : QColor GetBackgroundColor();
Description : Cette propriété définie si le fond du widget est transparent ou non.
Plus de détails : Styles des widgets
Type : bool
Valeur par défaut : true
Ecriture : void SetBackgroundIsTransparent(const bool& Tf)
Lecture : bool IsBackgroundTransparent();
Description : Cette propriété définie la couleur du bord 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::Dark" et la groupe "QPalette::Active". (Voir la classe QPalette de Qt)
Ecriture : void SetBorderColor(const QColor& Color)
Lecture : QColor GetBorderColor();
Description : Cette propriété définie l'épaisseur de l'effet de bord (par exemple de relief) lorsque le style de bord définie par la propriété BorderStyle est différente de la valeur "TXS::LineStyledPanel".
Plus de détails : Styles des widgets
Type : int
Valeur par défaut : 1
Ecriture : void SetBorderEffectWidth(const int& Width)
Lecture : int GetBorderEffectWidth();
Description : Cette propriété définie le style de ligne de bord lorsque le style de bord définie par la propriété BorderStyle est plaçée à la valeur "TXS::LineStyledPanel".
Plus de détails : Styles des widgets
Type : TXS::LineStyle
Valeur par défaut : TXS::SolidLine
Ecriture : void SetBorderLineStyle(const TXS::LineStyle& Style)
Lecture : TXS::LineStyle GetBorderLineStyle();
Description : Cette propriété définie le style de l'ombre d'un widget lorsque le style de bord définie par la propriété BorderStyle est différente de la valeur "TXS::LineStyledPanel".
Plus de détails : Styles des widgets
Type : TXS::BorderShadow
Valeur par défaut : TXS::Plain
Ecriture : void SetBorderShadow(const TXS::BorderShadow& Shadow)
Lecture : TXS::BorderShadow GetBorderShadow();
Description : Cette propriété définie le style du bord du widget.
Plus de détails : Styles des widgets
Type : TXS::BorderStyle
Valeur par défaut : TXS::Box
Ecriture : void SetBorderStyle(const TXS::BorderStyle& Style)
Lecture : TXS::BorderStyle GetBorderStyle();
Description : Cette propriété définie l'épaisseur du bord lorsque le style de bord définie par la propriété BorderStyle est plaçée à la valeur "TXS::LineStyledPanel".
Plus de détails : Styles des widgets
Type : int
Valeur par défaut : 1
Ecriture : void SetBorderWidth(const int& Width)
Lecture : int GetBorderWidth();
Description : Cette propriété définie la marge interne entre le bord bas du widget et le tracé interne de sa partie active ou représentative. La valeur minimale est 0 pour les widgets ne recevant pas le focus du clavier et de la souris, 4 pour ceux recevant ce focus.
Plus de détails : Styles des widgets
Type : int
Valeur par défaut : 0 pour les widgets ne recevant pas le focus du clavier et de la souris, 4 pour ceux recevant ce focus.
Ecriture : void SetBottomMargin(const int& Margin)
Lecture : int GetBottomMargin();
Description : Cette propriété définie le titre du widget. La visiblité du titre du widget est contrôlée par la propriété CaptionVisible.
Plus de détails : Styles des widgets
Type : QString
Valeur par défaut : Définie par le type de widget héritant de la classe TWidget.
Ecriture : void SetCaption(const QString& Caption)
Lecture : QString GetCaption();
Description : Cette propriété définie la couleur du titre 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 SetCaptionColor(const QColor& Color)
Lecture : QColor GetCaptionColor();
Description : Cette propriété définie la police de caractères du titre du widget lorsque celui-ci est visible.
Plus de détails : Styles des widgets
Type : QFont
Valeur par défaut : Police de caraactères par défaut de l'application.
Ecriture : void SetCaptionFont(const QFont& Font)
Lecture : QFont GetCaptionFont();
Description : Cette propriété définie la position horizontale du titre du widget lorsque celui-ci est visible.
Plus de détails : Styles des widgets
Type : TXS::HrzAlignment
Valeur par défaut : TXS::AlignCenter.
Ecriture : void SetCaptionHrzAlignment(const TXS::HrzAlignment& Align)
Lecture : TXS::HrzAlignment GetCaptionHrzAlignment();
Description : Cette propriété définie si le titre du widget est visible ou non.
Plus de détails : Styles des widgets
Type : bool
Valeur par défaut : true.
Ecriture : void SetCaptionVisible(const bool& Tf)
Lecture : bool GetCaptionVisible();
Description : Cette propriété définie la couleur du cadre interne au widget indiquant que le widget est celui qui reçoit le focus du clavier et de la souris.
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::Dark" et la groupe "QPalette::Active". (Voir la classe QPalette de Qt)
Ecriture : void SetFocusColor(const QColor& Color)
Lecture : QColor GeFocusColor();
Description : Cette propriété définie le style de ligne du cadre interne au widget indiquant que le widget est celui qui reçoit le focus du clavier et de la souris.
Plus de détails : Styles des widgets
Type : TXS::FocusStyle
Valeur par défaut : TXS::DotFocus
Ecriture : void SetFocusStyle(const TXS::FocusStyle& Style)
Lecture : TXS::FocusStyle GeFocusStyle();
Description : Cette propriété définie la marge interne entre le bord gauche du widget et le tracé interne de sa partie active ou représentative. La valeur minimale est 0 pour les widgets ne recevant pas le focus du clavier et de la souris, 4 pour ceux recevant ce focus.
Plus de détails : Styles des widgets
Type : int
Valeur par défaut : 0 pour les widgets ne recevant pas le focus du clavier et de la souris, 4 pour ceux recevant ce focus.
Ecriture : void SetLeftMargin(const int& Margin)
Lecture : int GetLeftMargin();
Description : Cette propriété définie la marge interne entre les tous bords du widget et le tracé interne de sa partie active ou représentative. La valeur minimale est 0 pour les widgets ne recevant pas le focus du clavier et de la souris, 4 pour ceux recevant ce focus.
Plus de détails : Styles des widgets
Type : int
Valeur par défaut : 0 pour les widgets ne recevant pas le focus du clavier et de la souris, 4 pour ceux recevant ce focus.
Ecriture : void SetMargins(const int& Margin)
Lecture : int GetMargins();
Description : Cette propriété définie la marge interne entre le bord droit du widget et le tracé interne de sa partie active ou représentative. La valeur minimale est 0 pour les widgets ne recevant pas le focus du clavier et de la souris, 4 pour ceux recevant ce focus.
Plus de détails : Styles des widgets
Type : int
Valeur par défaut : 0 pour les widgets ne recevant pas le focus du clavier et de la souris, 4 pour ceux recevant ce focus.
Ecriture : void SetRightMargin(const int& Margin)
Lecture : int GetRightMargin();
Description : Cette propriété définie la couleur couleur de l'ombrage du widget lorsque celui-ci est désactivé. La visibilité de l'ombrage lorsque le widget est désactivé est contrôlée par la propriété ShadedWhenDisabled.
Plus de détails : Styles des widgets
Type : QColor
Valeur par défaut : Qt::black
Ecriture : void SetShadeColor(const QColor& Color)
Lecture : QColor GeShadeColor();
Description : Cette propriété définie si le widget doit être ombrée lorsqu'il est désactivé.
Plus de détails : Styles des widgets
Type : bool
Valeur par défaut : true.
Ecriture : void SetShadedWhenDisabled(const bool& Tf)
Lecture : bool GetShadedWhenDisabled();
Description : Cette propriété définie l'opacité de l'ombrage du widget lorsque celui-ci est désactivé. La visibilité de l'ombrage lorsque le widget est désactivé est contrôlée par la propriété ShadedWhenDisabled. La valeur doit être comprise entre 0 (Pas d'ombrage) et 255 (Ombrage maximal).
Plus de détails : Styles des widgets
Type : int
Valeur par défaut : 96.
Ecriture : void SetShadeOpacity(const int& Opacity)
Lecture : int GetShadeOpacity();
Description : Cette propriété définie le modèle de l'ombrage du widget lorsque celui-ci est désactivé. La visibilité de l'ombrage lorsque le widget est désactivé est contrôlée par la propriété ShadedWhenDisabled.
Plus de détails : Styles des widgets
Type : Qt::BrushStyle
Valeur par défaut : Qt::Dense6Pattern.
Ecriture : void SetShadePattern(const int& Pattern)
Lecture : int GetShadePattern();
Description : Cette propriété définie la marge interne entre le bord haut du widget et le tracé interne de sa partie active ou représentative. La valeur minimale est 0 pour les widgets ne recevant pas le focus du clavier et de la souris, 4 pour ceux recevant ce focus.
Plus de détails : Styles des widgets
Type : int
Valeur par défaut : 0 pour les widgets ne recevant pas le focus du clavier et de la souris, 4 pour ceux recevant ce focus.
Ecriture : void SetTopMargin(const int& Margin)
Lecture : int GetTopMargin();