CMFCCmdUsageCount, classe

Suit le nombre d’utilisations des messages Windows, par exemple lorsque l’utilisateur sélectionne un élément dans un menu.

Syntaxe

class CMFCCmdUsageCount : public CObject

Membres

Constructeurs publics

Nom Description
CMFCCmdUsageCount::CMFCCmdUsageCount Constructeur par défaut.
CMFCCmdUsageCount::~CMFCCmdUsageCount Destructeur.

Méthodes publiques

Nom Description
CMFCCmdUsageCount ::AddCmd Incrémente par un compteur associé à la commande donnée.
CMFCCmdUsageCount ::GetCount Récupère le nombre d’utilisations associé à l’ID de commande donné.
CMFCCmdUsageCount ::HasEnoughInformation Détermine si cet objet a collecté la quantité minimale de données de suivi.
CMFCCmdUsageCount ::IsFreqeuntlyUsedCmd Détermine si la commande donnée est fréquemment utilisée.
CMFCCmdUsageCount ::Reset Efface le nombre d’utilisations de toutes les commandes.
CMFCCmdUsageCount ::Serialize Lit cet objet à partir d’une archive ou l’écrit dans une archive. (Substitue CObject::Serialize.)
CMFCCmdUsageCount ::SetOptions Définit les valeurs des membres de données de classe partagée CMFCCmdUsageCount .

Données membres

Nom Description
m_CmdUsage Objet CMap qui mappe les commandes à leur nombre d’utilisations.
m_nMinUsagePercentage Pourcentage minimal d’utilisation d’une commande à utiliser fréquemment.
m_nStartCount Compteur de démarrage utilisé pour déterminer si cet objet a collecté la quantité minimale de données de suivi.
m_nTotalUsage Nombre de toutes les commandes suivies.

Notes

La CMFCCmdUsageCount classe mappe chaque identificateur de message Windows numérique à un compteur entier non signé 32 bits. CMFCToolBar utilise cette classe pour afficher les éléments de barre d’outils fréquemment utilisés. Pour plus d’informations sur CMFCToolBarla classe CMFCToolBar.

Vous pouvez conserver CMFCCmdUsageCount les données de classe entre les exécutions de votre programme. Utilisez la méthode CMFCCmdUsageCount ::Serialize pour sérialiser les données membres de classe et la méthode CMFCCmdUsageCount ::SetOptions pour définir les données de membre partagées.

Hiérarchie d'héritage

CObject

CMFCCmdUsageCount

Spécifications

En-tête : afxcmdusagecount.h

CMFCCmdUsageCount ::AddCmd

Incrémente par un compteur associé à la commande donnée.

void AddCmd(UINT uiCmd);

Paramètres

uiCmd
[in] Spécifie le compteur de commandes à incrémenter.

Notes

Cette méthode ajoute une nouvelle entrée à la structure cartographique du nombre de commandes, m_CmdUsagesi l’entrée n’existe pas déjà.

Cette méthode ne fait rien dans les cas suivants :

  • L’infrastructure de barre d’outils est en mode de personnalisation (la méthode CMFCToolBar ::IsCustomizeMode retourne une valeur différente de zéro).

  • La commande fait référence à un sous-menu ou un séparateur de menu ( uiCmd est égal à 0 ou -1).

  • uiCmd fait référence à une commande standard (la fonction globale IsStandardCommand retourne une valeur différente de zéro).

CMFCCmdUsageCount ::GetCount

Récupère le nombre d’utilisations associé à l’ID de commande donné.

UINT GetCount(UINT uiCmd) const;

Paramètres

uiCmd
[in] ID du compteur de commandes à récupérer.

Valeur de retour

Nombre d’utilisations associé à l’ID de commande donné.

CMFCCmdUsageCount ::HasEnoughInformation

Détermine si cet objet a reçu la quantité minimale de données de suivi.

BOOL HasEnoughInformation() const;

Valeur de retour

Différent de zéro si cet objet a reçu la quantité minimale de données de suivi ; sinon 0.

Notes

Cette méthode retourne une valeur différente de zéro si le nombre total, m_nTotalUsagede toutes les commandes suivies est égal ou supérieur au nombre initial. m_nStartCount Par défaut, l’infrastructure définit le nombre initial 0. Vous pouvez remplacer cette valeur à l’aide de la méthode CMFCCmdUsageCount ::SetOptions .

Cette méthode est utilisée par CMFCMenuBar ::IsShowAllCommands pour déterminer s’il faut afficher toutes les commandes de menu disponibles.

CMFCCmdUsageCount ::IsFreqeuntlyUsedCmd

Détermine si la commande donnée est fréquemment utilisée.

BOOL IsFreqeuntlyUsedCmd(UINT uiCmd) const;

Paramètres

uiCmd
[in] Spécifie la commande à vérifier.

Valeur de retour

Différent de zéro si la commande est fréquemment utilisée ; sinon 0.

Notes

Cette méthode retourne 0 si l’utilisation totale des commandes est m_nTotalUsage0. Sinon, cette méthode retourne une valeur différente de zéro si le pourcentage dont la commande spécifiée est utilisée est supérieur au pourcentage minimal. m_nMinUsagePercentage Par défaut, l’infrastructure définit le pourcentage minimal sur 5. Vous pouvez remplacer cette valeur à l’aide de la méthode CMFCCmdUsageCount ::SetOptions . Si le pourcentage minimal est égal à 0, cette méthode retourne une valeur différente de zéro si le nombre de commandes spécifié est supérieur à 0.

CMFCToolBar ::IsCommandRarelyUsed utilise cette méthode pour déterminer si une commande est rarement utilisée.

CMFCCmdUsageCount ::Reset

Efface le nombre d’utilisations de toutes les commandes.

void Reset();

Notes

Appelez cette méthode pour effacer toutes les entrées de la structure cartographique des nombres de commandes, m_CmdUsageet pour réinitialiser l’utilisation totale des commandes, compteur m_nTotalUsagesur 0.

CMFCCmdUsageCount ::Serialize

Lit cet objet à partir d’une archive ou l’écrit dans une archive.

virtual void Serialize(CArchive& ar);

Paramètres

Ar
[in] Objet CArchive à sérialiser depuis ou vers.

Notes

Cette méthode sérialise la structure cartographique du nombre de commandes, m_CmdUsageainsi que l’utilisation totale des commandes, le m_nTotalUsagecompteur depuis ou vers l’archive spécifiée.

Pour obtenir des exemples de sérialisation, consultez Sérialisation : Sérialisation d’un objet.

CMFCCmdUsageCount ::SetOptions

Définit les valeurs des membres de données de classe partagée CMFCCmdUsageCount .

static BOOL __stdcall SetOptions(
    UINT nStartCount,
    UINT nMinUsagePercentage);

Paramètres

nStartCount
[in] Nouveau nombre initial de toutes les commandes suivies.

nMinUsagePercentage
[in] Nouveau pourcentage d’utilisation minimale.

Valeur de retour

TRUE si la méthode réussit, FALSE si le paramètre nMinUsagePercentage est supérieur ou égal à 100.

Notes

Cette méthode définit les membres m_nStartCount de données de classe partagée CMFCCmdUsageCount et m_nMinUsagePercentage sur nStartCount et nMinUsagePercentage, respectivement. m_nStartCount est utilisé par la méthode CMFCCmdUsageCount ::HasEnoughInformation pour déterminer si cet objet a collecté la quantité minimale de données de suivi. m_nMinUsagePercentage est utilisé par la méthode CMFCCmdUsageCount ::IsFreqeuntlyUsedCmd pour déterminer si une commande donnée est fréquemment utilisée.

Dans Debug, cette méthode génère un échec d’assertion si le paramètre nMinUsagePercentage est supérieur ou égal à 100.

Voir aussi

Graphique hiérarchique
Classes
CMFCToolBar, classe