CMFCAutoHideButton, classe

Bouton qui affiche ou masque une CDockablePane Class configurée pour être masquée.

Pour plus d’informations, consultez le code source situé dans le dossier VC\atlmfc\src\mfc de votre installation de Visual Studio.

Syntaxe

class CMFCAutoHideButton : public CObject

Membres

Méthodes publiques

Nom	Description
CMFCAutoHideButton ::BringToTop
CMFCAutoHideButton ::Create	Crée et initialise les bouton masquer automatiquement.
CMFCAutoHideButton ::GetAlignment	Récupère l'alignement du bouton masquer automatiquement.
CMFCAutoHideButton ::GetAutoHideWindow	Renvoie l’objet CDockablePane associé au bouton masquer automatiquement.
CMFCAutoHideButton ::GetParentToolBar
CMFCAutoHideButton ::GetRect
CMFCAutoHideButton ::GetSize	Détermine la taille du bouton masquer automatiquement.
CMFCAutoHideButton ::GetTextSize	Retourne la taille de l'étiquette de texte du bouton masquer automatiquement.
CMFCAutoHideButton ::HighlightButton	Met en évidence le bouton masquer automatiquement.
CMFCAutoHideButton ::IsActive	Indique si le bouton masquer automatiquement est actif.
CMFCAutoHideButton ::IsHighlighted	Fait état de la mise en évidence du bouton masquer automatiquement.
CMFCAutoHideButton ::IsHorizontal	Détermine si le bouton masquer automatiquement est horizontal ou vertical.
CMFCAutoHideButton ::IsTop
CMFCAutoHideButton ::IsVisible	Indique si le bouton est visible.
CMFCAutoHideButton ::Move
CMFCAutoHideButton ::OnDraw	L'infrastructure appelle cette méthode au moment de dessiner le bouton masquer automatiquement.
CMFCAutoHideButton ::OnDrawBorder	L'infrastructure appelle cette méthode au moment de dessiner la bordure d'un bouton masquer automatiquement.
CMFCAutoHideButton ::OnFillBackground	L'infrastructure appelle cette méthode au moment de remplir l'arrière-plan d'un bouton masquer automatiquement.
CMFCAutoHideButton ::ReplacePane
CMFCAutoHideButton ::ShowAttachedWindow	Affiche ou masque la classe CDockablePane associée.
CMFCAutoHideButton ::ShowButton	Affiche ou masque le bouton masquer automatiquement.
CMFCAutoHideButton ::UnSetAutoHideMode

Notes

Lors de la création, l’objet CMFCAutoHideButton est attaché à une classe CDockablePane. L'objet CDockablePane est masqué ou affiché quand l'utilisateur interagit avec l'objet CMFCAutoHideButton.

Par défaut, l'infrastructure crée automatiquement un CMFCAutoHideButton quand l'utilisateur active le bouton masquer automatiquement. L'infrastructure peut créer un élément d'une classe d'interface utilisateur personnalisée à la place de la classe CMFCAutoHideButton. Pour spécifier la classe d'interface utilisateur personnalisée que l'infrastructure doit utiliser, attribuez à la variable de membre statique CMFCAutoHideBar::m_pAutoHideButtonRTS la même valeur que la classe d'interface utilisateur personnalisée. Par défaut, cette variable a la valeur CMFCAutoHideButton.

Exemple

L'exemple suivant montre comment construire un objet CMFCAutoHideButton et utiliser différentes méthodes de la classe CMFCAutoHideButton. L'exemple montre comment initialiser un objet CMFCAutoHideButton en utilisant sa méthode Create, afficher la classe CDockablePane associée et afficher le bouton masquer automatiquement.

CMFCAutoHideButton *autoHideButton = new CMFCAutoHideButton();
CDockablePane cPane;
// CMFCAutoHideBar* pParentBar
if (!autoHideButton->Create(pParentBar, &cPane, CBRS_ALIGN_LEFT))
{
   return 0;
}
autoHideButton->ShowAttachedWindow(true);
autoHideButton->ShowButton(true);

Hiérarchie d'héritage

CObject

CMFCAutoHideButton

Spécifications

En-tête : afxautohidebutton.h

CMFCAutoHideButton ::BringToTop

void BringToTop();

Notes

CMFCAutoHideButton ::Create

Crée et initialise un bouton masquer automatiquement.

virtual BOOL Create(
    CMFCAutoHideBar* pParentBar,
    CDockablePane* pAutoHideWnd,
    DWORD dwAlignment);

Paramètres

pParentBar
[in] Pointeur vers la barre d’outils parente.

pAutoHideWnd
[in] Pointeur vers un objet CDockablePane . Ce bouton de masquage automatique masque et montre que CDockablePane.

dwAlignment
[in] Valeur qui spécifie l’alignement du bouton avec la fenêtre de cadre principale.

Valeur de retour

Valeur différente de zéro cas de réussite ; sinon, 0.

Notes

Lorsque vous créez un CMFCAutoHideButton objet, vous devez associer le bouton masquer automatiquement à un objet spécifique CDockablePane. L’utilisateur peut utiliser le bouton masquer automatiquement pour masquer et afficher l’objet associé CDockablePane.

Le paramètre dwAlignment indique où réside le bouton masquer automatiquement dans l’application. Le paramètre peut avoir l’une des valeurs suivantes :

• CBRS_ALIGN_LEFT

• CBRS_ALIGN_RIGHT

• CBRS_ALIGN_TOP

• CBRS_ALIGN_BOTTOM

CMFCAutoHideButton ::GetAlignment

Récupère l'alignement du bouton masquer automatiquement.

DWORD GetAlignment() const;

Valeur de retour

Valeur DWORD qui contient l’alignement actuel du bouton masquer automatiquement.

Notes

L’alignement du bouton masquer automatiquement indique l’emplacement où se trouve le bouton sur l’application. Il peut s’agir de l’une des valeurs suivantes :

• CBRS_ALIGN_LEFT

• CBRS_ALIGN_RIGHT

• CRBS_ALIGN_TOP

• CBRS_ALIGN_BOTTOM

CMFCAutoHideButton ::GetAutoHideWindow

Renvoie l’objet CDockablePane associé au bouton masquer automatiquement.

CDockablePane* GetAutoHideWindow() const;

Valeur de retour

Pointeur vers l’objet associé CDockablePane .

Notes

Pour associer un bouton de masquage automatique à un CDockablePane, passez le CDockablePane paramètre à la méthode CMFCAutoHideButton ::Create .

CMFCAutoHideButton ::GetParentToolBar

CMFCAutoHideBar* GetParentToolBar();

Valeur de retour

Notes

CMFCAutoHideButton ::GetRect

CRect GetRect() const;

Valeur de retour

Notes

CMFCAutoHideButton ::GetSize

Détermine la taille du bouton masquer automatiquement.

CSize GetSize() const;

Valeur de retour

Objet CSize qui contient la taille du bouton.

Notes

La taille calculée inclut la taille de la bordure du bouton masquer automatiquement.

CMFCAutoHideButton ::GetTextSize

Retourne la taille de l'étiquette de texte du bouton masquer automatiquement.

virtual CSize GetTextSize() const;

Valeur de retour

Objet CSize qui contient la taille du texte pour le bouton masquer automatiquement.

CMFCAutoHideButton ::IsActive

Indique si le bouton masquer automatiquement est actif.

BOOL IsActive() const;

Valeur de retour

TRUE si le bouton masquer automatiquement est actif ; FALSE dans le cas contraire.

Notes

Un bouton de masquage automatique est actif lorsque la fenêtre de classe CDockablePane associée est affichée.

CMFCAutoHideButton ::IsHorizontal

Détermine si le bouton masquer automatiquement est horizontal ou vertical.

BOOL IsHorizontal() const;

Valeur de retour

Différent de zéro si le bouton est horizontal ; Sinon, 0.

Notes

L’infrastructure définit l’orientation d’un objet CMFCAutoHideButton lorsque vous le créez. Vous pouvez contrôler l’orientation à l’aide du paramètre dwAlignment dans la méthode CMFCAutoHideButton ::Create .

CMFCAutoHideButton ::IsTop

BOOL IsTop() const;

Valeur de retour

Notes

CMFCAutoHideButton ::IsVisible

Indique si le bouton masquer automatiquement est visible.

virtual BOOL IsVisible() const;

Valeur de retour

TRUE si le bouton est visible ; FALSE dans le cas contraire.

CMFCAutoHideButton ::OnDraw

L'infrastructure appelle cette méthode au moment de dessiner le bouton masquer automatiquement.

virtual void OnDraw(CDC* pDC);

Paramètres

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

Notes

Si vous souhaitez personnaliser l’apparence des boutons de masquage automatique dans votre application, créez une classe dérivée de CMFCAutoHideButton. Dans votre classe dérivée, remplacez cette méthode.

CMFCAutoHideButton ::OnDrawBorder

L'infrastructure appelle cette méthode au moment de dessiner la bordure d'un bouton masquer automatiquement.

virtual void OnDrawBorder(
    CDC* pDC,
    CRect rectBounds,
    CRect rectBorderSize);

Paramètres

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

rectBounds
[in] Rectangle englobant du bouton masquer automatiquement.

rectBorderSize
[in] Épaisseur de bordure pour chaque côté du bouton masquer automatiquement.

Notes

Si vous souhaitez personnaliser la bordure de chaque bouton de masquage automatique dans votre application, créez une classe dérivée du CMFCAutoHideButton. Dans votre classe dérivée, remplacez cette méthode.

CMFCAutoHideButton ::OnFillBackground

L'infrastructure appelle cette méthode au moment de remplir l'arrière-plan d'un bouton masquer automatiquement.

virtual void OnFillBackground(
    CDC* pDC,
    CRect rect);

Paramètres

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

rect
[in] Rectangle englobant du bouton masquer automatiquement.

Notes

Si vous souhaitez personnaliser l’arrière-plan pour les boutons de masquage automatique dans votre application, créez une classe dérivée du CMFCAutoHideButton. Dans votre classe dérivée, remplacez cette méthode.

CMFCAutoHideButton ::ShowAttachedWindow

Affiche ou masque la classe CDockablePane associée.

void ShowAttachedWindow(BOOL bShow);

Paramètres

bShow
[in] Valeur booléenne qui spécifie si cette méthode affiche l’élément attaché CDockablePane.

CMFCAutoHideButton ::ShowButton

Affiche ou masque le bouton masquer automatiquement.

virtual void ShowButton(BOOL bShow);

Paramètres

bShow
[in] Boolean qui spécifie s’il faut afficher le bouton masquer automatiquement.

CMFCAutoHideButton ::Move

void Move(int nOffset);

Paramètres

[in] nOffset

Notes

CMFCAutoHideButton ::ReplacePane

void ReplacePane(CDockablePane* pNewBar);

Paramètres

[in] pNewBar

Notes

CMFCAutoHideButton ::UnSetAutoHideMode

Désactivez le mode de masquage automatique.

virtual void UnSetAutoHideMode(CDockablePane* pFirstBarInGroup);

Paramètres

pFirstBarInGroup
[in] Pointeur vers la première barre du groupe.

Notes

CMFCAutoHideButton ::HighlightButton

Met en surbrillance le bouton masquer automatiquement.

virtual void HighlightButton(BOOL bHighlight);

Paramètres

bHighlight
Spécifie le nouvel état du bouton masquer automatiquement. TRUE indique que le bouton est mis en surbrillance, FALSE indique que le bouton n’est pas mis en surbrillance.

Notes

CMFCAutoHideButton ::IsHighlighted

Retourne l’état de surbrillance du bouton masquer automatiquement.

virtual BOOL IsHighlighted() const;

Valeur de retour

Retourne TRUE si le bouton masquer automatiquement est mis en surbrillance ; sinon FALSE.

Notes

Voir aussi

Graphique hiérarchique
Classes
CMFCAutoHideBar, classe
CAutoHideDockSite, classe