CMFCCaptionButton, classe

La CMFCCaptionButton classe implémente un bouton qui s’affiche dans la barre de légende pour un volet d’ancrage ou une fenêtre mini-frame. En général, l'infrastructure crée les boutons de légende automatiquement.

Syntaxe

class CMFCCaptionButton : public CObject

Membres

Constructeurs

Nom	Description
CMFCCaptionButton ::CMFCCaptionButton	Construit un objet CMFCCaptionButton.

Méthodes publiques

Nom	Description
CMFCCaptionButton ::GetHit	Retourne la commande représentée par le bouton.
CMFCCaptionButton ::GetIconID	Retourne l’ID d’image associé au bouton.
CMFCCaptionButton ::GetRect	Retourne le rectangle occupé par le bouton.
CMFCCaptionButton ::GetSize	Retourne la largeur et la hauteur du bouton.
CMFCCaptionButton ::IsMiniFrameButton	Indique si la hauteur de la barre de titre est définie sur mini-taille.
CMFCCaptionButton ::Move	Définit l’emplacement du dessin du bouton et l’état d’affichage de la fenêtre.
CMFCCaptionButton ::OnDraw	Dessine le bouton légende.
CMFCCaptionButton ::SetMiniFrameButton	Définit la mini-taille de la barre de titre.

Notes

Vous pouvez dériver une classe de la classe CPaneFrameWnd et utiliser la méthode protégée, AddButtonpour ajouter des boutons légende à une fenêtre mini frame.

CPaneFrameWnd.h définit des ID de commande pour deux types de boutons légende :

• AFX_CAPTION_BTN_PIN, qui affiche un bouton épingle lorsque le volet d’ancrage prend en charge le mode de masquage automatique.

• AFX_CAPTION_BTN_CLOSE, qui affiche un bouton Fermer lorsque le volet peut être fermé ou masqué.

Exemple

L’exemple suivant montre comment construire un CMFCCaptionButton objet et définir la mini taille de la barre de titre.

CMFCCaptionButton *captionButton = new CMFCCaptionButton(AFX_HTCLOSE);
captionButton->SetMiniFrameButton(true);

Hiérarchie d'héritage

CObject

CMFCCaptionButton

Spécifications

En-tête : afx légende button.h

CMFCCaptionButton ::CMFCCaptionButton

Construit un objet CMFCCaptionButton.

CMFCCaptionButton();

CMFCCaptionButton(
    UINT nHit,
    BOOL bLeftAlign = FALSE);

Paramètres

nHit
[in] Commande associée au bouton.

bLeftAlign
[in] Spécifie si le bouton est aligné à gauche.

Le tableau suivant répertorie les valeurs possibles pour le paramètre nHit .

Value	Commande
AFX_HTCLOSE	Bouton Fermer.
HTMINBUTTON	Bouton Réduire.
HTMAXBUTTON	Bouton Agrandir.
AFX_HTLEFTo UTTON	Bouton Flèche gauche.
AFX_HTRIGHTo UTTON	Bouton Flèche droite.
AFX_HTMENU	Bouton de menu flèche bas.
HTNOWHERE	Valeur par défaut ; représente aucune commande.

Notes

Par défaut, les boutons légende ne sont pas associés à une commande.

Les boutons de légende sont alignés à droite ou à gauche.

CMFCCaptionButton ::GetHit

Retourne la commande représentée par le bouton.

UINT GetHit() const;

Valeur de retour

Commande représentée par le bouton.

Le tableau suivant répertorie les valeurs de retour possibles.

Value	Commande
AFX_HTCLOSE	Bouton Fermer.
HTMINBUTTON	Bouton Réduire.
HTMAXBUTTON	Bouton Agrandir.
AFX_HTLEFTo UTTON	Bouton Flèche gauche.
AFX_HTRIGHTo UTTON	Bouton Flèche droite.
AFX_HTMENU	Bouton de menu flèche bas.
HTNOWHERE	Valeur par défaut ; représente aucune commande.

CMFCCaptionButton ::GetIconID

Retourne l’ID d’image associé au bouton.

virtual CMenuImages::IMAGES_IDS GetIconID(
    BOOL bHorz,
    BOOL bMaximized = FALSE) const;

Paramètres

bHorz
[in] TRUE pour les ID d’image de flèche gauche ou droite ; FALSE pour les ID d’image vers le haut ou le bas.

bMaximized
[in] TRUE pour optimiser l’ID d’image ; FALSE pour un ID d’image réduit.

Valeur de retour

ID d’image.

Notes

Les paramètres spécifient les ID d’image pour réduire ou agrandir les boutons légende.

CMFCCaptionButton ::GetRect

Retourne le rectangle occupé par le bouton.

virtual CRect GetRect() const;

Valeur de retour

Rectangle qui représente l’emplacement du bouton.

Notes

Si vous ne voyez pas le bouton, la taille retournée est 0.

CMFCCaptionButton ::GetSize

Retourne la largeur et la hauteur du bouton.

static CSize GetSize();

Valeur de retour

Dimensions externes du bouton.

Notes

La taille retournée inclut la marge de bouton et la bordure.

CMFCCaptionButton ::IsMiniFrameButton

Indique si la hauteur de la barre de titre est définie sur mini-taille.

BOOL IsMiniFrameButton() const;

Valeur de retour

TRUE si le légende est défini sur mini-taille ; sinon FALSE.

Notes

CMFCCaptionButton ::Move

Définit l’emplacement du dessin du bouton et l’état d’affichage de la fenêtre.

void Move(
    const CPoint& ptTo,
    BOOL bHide = FALSE);

Paramètres

ptTo
[in] Nouvel emplacement.

bHide
[in] Indique s’il faut afficher le bouton.

CMFCCaptionButton ::OnDraw

Dessine le bouton légende.

virtual void OnDraw(
    CDC* pDC,
    BOOL bActive,
    BOOL bHorz = TRUE,
    BOOL bMaximized = TRUE,
    BOOL bDisabled = FALSE);

Paramètres

pDC
[in] Pointeur vers un contexte d’appareil pour le bouton.

bActive
[in] Indique s’il faut dessiner une image de bouton actif.

bHorz
[in] Réservé à une utilisation dans une classe dérivée.

bMaximized
[in] Indique s’il faut dessiner une image de bouton agrandie.

bDisabled
[in] Indique s’il faut dessiner une image de bouton activée.

Notes

Le paramètre bMaximized est utilisé lorsque le bouton est un bouton agrandi ou réduit.

CMFCCaptionButton ::SetMiniFrameButton

Définit la mini-taille de la barre de titre.

void SetMiniFramebutton(BOOL bSet = TRUE);

Paramètres

bSet
[in] TRUE pour la hauteur de la barre de titre mini ; FALSE pour la hauteur de la barre de titre par défaut.

Voir aussi

Graphique hiérarchique
Classes
CPaneFrameWnd, classe
CDockablePane, classe