CUserTool, classe
Un outil utilisateur est un élément de menu qui exécute une application externe. L’onglet Outils de la boîte de dialogue Personnaliser ( classe CMFCToolBarsCustomizeDialog) permet à l’utilisateur d’ajouter des outils utilisateur et de spécifier le nom, la commande, les arguments et le répertoire initial de chaque outil utilisateur.
Syntaxe
class CUserTool : public CObject
Membres
Méthodes publiques
| Nom | Description |
|---|---|
| CUserTool ::CopyIconToClipboard | |
| CUserTool ::D rawToolIcon | Dessine l’icône de l’outil utilisateur dans un rectangle spécifié. |
| CUserTool ::GetCommand | Retourne une chaîne qui contient le texte de la commande associée à l’outil utilisateur. |
| CUserTool ::GetCommandId | Retourne l’ID de commande de l’élément de menu de l’outil utilisateur. |
| CUserTool ::Invoke | Exécute la commande associée à l’outil utilisateur. |
| CUserTool ::Serialize | Lit ou écrit cet objet dans une archive. (Substitue CObject::Serialize.) |
| CUserTool ::SetCommand | Définit la commande associée à l’outil utilisateur. |
| CUserTool ::SetToolIcon | Charge l’icône de l’outil utilisateur à partir de l’application associée à l’outil. |
Méthodes protégées
| Nom | Description |
|---|---|
| CUserTool ::LoadDefaultIcon | Charge l’icône par défaut d’un outil utilisateur. |
Données membres
| Nom | Description |
|---|---|
| CUserTool ::m_strArguments | Arguments de ligne de commande pour l’outil utilisateur. |
| CUserTool ::m_strInitialDirectory | Répertoire initial de l’outil utilisateur. |
| CUserTool ::m_strLabel | Nom de l’outil affiché dans l’élément de menu de l’outil. |
Notes
Pour plus d’informations sur l’activation des outils utilisateur dans votre application, consultez CUserToolsManager, classe.
Exemple
L’exemple suivant montre comment créer un outil à partir d’un CUserToolsManager objet, définir la m_strLabel variable membre et définir l’application que l’outil utilisateur exécute. Cet extrait de code fait partie de l’exemple de démonstration Visual Studio.
// CUserToolsManager* pUserToolsManager
CUserTool* pTool1 = pUserToolsManager->CreateNewTool();
pTool1->m_strLabel = _T("&Notepad");
pTool1->SetCommand(_T("notepad.exe"));
Hiérarchie d'héritage
Spécifications
En-tête : afxusertool.h
CUserTool ::CopyIconToClipboard
Pour plus d’informations, consultez le code source situé dans le dossier VC\atlmfc\src\mfc de votre installation de Visual Studio.
BOOL CopyIconToClipboard();
Valeur de retour
Notes
CUserTool ::D rawToolIcon
Dessine l’icône de l’outil utilisateur au centre d’un rectangle spécifié.
void DrawToolIcon(
CDC* pDC,
const CRect& rectImage);
Paramètres
pDC
[in] Pointeur vers un contexte d’appareil.
rectImage
[in] Spécifie les coordonnées de la zone à afficher.
CUserTool ::GetCommand
Retourne une chaîne qui contient le texte de la commande associée à l’outil utilisateur.
const CString& GetCommand() const;
Valeur de retour
Référence à l’objet CString qui contient le texte de la commande associée à l’outil utilisateur.
CUserTool ::GetCommandId
Retourne l’ID de commande de l’outil utilisateur.
UINT GetCommandId() const;
Valeur de retour
ID de commande de cet outil utilisateur.
CUserTool ::Invoke
Exécute la commande associée à l’outil utilisateur.
virtual BOOL Invoke();
Valeur de retour
Différent de zéro si la commande a été exécutée avec succès ; sinon 0.
Notes
Appelle ShellExecute pour exécuter une commande associée à l’outil utilisateur. La fonction échoue si la commande est vide ou si ShellExecute échoue.
CUserTool ::LoadDefaultIcon
Charge l’icône par défaut d’un outil utilisateur.
virtual HICON LoadDefaultIcon();
Valeur de retour
Handle vers l’icône chargée (HICON) ou NULL si l’icône par défaut ne peut pas être chargée.
Notes
L’infrastructure appelle cette méthode lorsqu’elle ne peut pas charger une icône pour un outil défini par l’utilisateur à partir du fichier exécutable de l’outil.
Remplacez cette méthode pour fournir votre propre icône d’outil par défaut.
CUserTool ::m_strArguments
Arguments de ligne de commande pour l’outil utilisateur.
CString m_strArguments;
Notes
Cette chaîne est transmise à l’outil lorsque vous appelez CUserTool ::Invoke ou lorsqu’un utilisateur clique sur la commande associée à cet outil.
CUserTool ::m_strInitialDirectory
Spécifie le répertoire initial de l’outil utilisateur.
CString m_strInitialDirectory;
Notes
Cette variable spécifie le répertoire initial dans lequel l’outil s’exécute lorsque vous appelez CUserTool ::Invoke ou lorsqu’un utilisateur clique sur la commande associée à cet outil.
CUserTool ::m_strLabel
Étiquette affichée dans l’élément de menu de l’outil.
CString m_strLabel;
CUserTool ::Serialize
Pour plus d’informations, consultez le code source situé dans le dossier VC\atlmfc\src\mfc de votre installation de Visual Studio.
virtual void Serialize(CArchive& ar);
Paramètres
[in] ar
Notes
CUserTool ::SetCommand
Définit l’application exécutée par l’outil utilisateur.
void SetCommand(LPCTSTR lpszCmd);
Paramètres
lpszCmd
[in] Spécifie la nouvelle application à associer à l’outil utilisateur.
Notes
Appelez cette méthode pour définir une nouvelle application que l’outil utilisateur exécute. La méthode détruit l’ancienne icône et charge une nouvelle icône à partir de l’application donnée. S’il ne peut pas charger une icône à partir de l’application, il charge l’icône par défaut pour un outil utilisateur en appelant CUserTool ::LoadDefaultIcon.
CUserTool ::SetToolIcon
Charge l’icône de l’outil utilisateur à partir de l’application utilisée par l’outil.
virtual HICON SetToolIcon();
Valeur de retour
Handle de l’icône chargée.
Notes
Appelez cette méthode pour charger l’icône à afficher sur l’élément de menu. Cette méthode recherche l’icône dans le fichier exécutable utilisé par l’outil. S’il n’a pas d’icône par défaut, l’icône fournie par CUserTool ::LoadDefaultIcon est utilisée à la place.
Voir aussi
Graphique hiérarchique
Classes
CWinAppEx, classe
CUserToolsManager, classe