CUserToolsManager osztály

Megjegyzés:

A Microsoft Foundation Classes (MFC) könyvtár továbbra is támogatott. A továbbiakban azonban nem adunk hozzá funkciókat, és nem frissítjük a dokumentációt.

Fenntartja a CUserTool osztályobjektumok gyűjteményét egy alkalmazásban. A felhasználói eszköz egy külső alkalmazást futtató menüelem. Az CUserToolsManager objektum lehetővé teszi, hogy a felhasználó vagy a fejlesztő új felhasználói eszközöket adjon hozzá az alkalmazáshoz. Támogatja a felhasználói eszközökhöz társított parancsok végrehajtását, és a Felhasználói eszközökkel kapcsolatos információkat is menti a Windows beállításjegyzékében.

Szemantika

class CUserToolsManager : public CObject

Tagok

Nyilvános konstruktorok

Név	Description
CUserToolsManager::CUserToolsManager	Létrehoz egy CUserToolsManager-t.

Nyilvános módszerek

Név	Description
CUserToolsManager::CreateNewTool	Új felhasználói eszközt hoz létre.
CUserToolsManager::FindTool	A megadott parancsazonosítóhoz társított objektumra mutató mutatót CMFCUserTool adja vissza.
CUserToolsManager::GetArgumentsMenuID	A Testreszabás párbeszédpanel Eszközök lapján található Argumentumok menühöz társított erőforrás-azonosítót adja vissza.
CUserToolsManager::GetDefExt	A Fájlmegnyitás párbeszédpanel (CFileDialog) által használt alapértelmezett bővítményt adja vissza a Testreszabás párbeszédpanel Eszközök lapjának Parancs mezőjében.
CUserToolsManager::GetFilter	Azt a fájlszűrőt adja vissza, amelyet a Fájlmegnyitás párbeszédpanel (CFileDialog Osztály) a Testreszabás párbeszédpanel Eszközök lapJának Parancs mezőjében használ.
CUserToolsManager::GetInitialDirMenuID	A Testreszabás párbeszédpanel Eszközök lapján található Kezdeti könyvtár menühöz társított erőforrás-azonosítót adja vissza.
CUserToolsManager::GetMaxTools	Az alkalmazásban lefoglalható felhasználói eszközök maximális számát adja vissza.
CUserToolsManager::GetToolsEntryCmd	A felhasználói eszközök menüelem-helyőrzőjének parancsazonosítóját adja vissza.
CUserToolsManager::GetUserTools	A felhasználói eszközök listájára mutató hivatkozást ad vissza.
CUserToolsManager::InvokeTool	A megadott parancsazonosítóval rendelkező felhasználói eszközhöz társított alkalmazást hajt végre.
CUserToolsManager::IsUserToolCmd	Meghatározza, hogy a parancsazonosító egy felhasználói eszközhöz van-e társítva.
CUserToolsManager::LoadState	Betölti a felhasználói eszközökkel kapcsolatos információkat a Windows beállításjegyzékéből.
CUserToolsManager::MoveToolDown	A megadott felhasználói eszközt lejjebb helyezi a felhasználói eszközök listájában.
CUserToolsManager::MoveToolUp	A megadott felhasználói eszközt feljebb helyezi a felhasználói eszközök listájában.
CUserToolsManager::RemoveTool	Eltávolítja a megadott felhasználói eszközt az alkalmazásból.
CUserToolsManager::SaveState	A felhasználói eszközökkel kapcsolatos információkat a Windows beállításjegyzékében tárolja.
CUserToolsManager::SetDefExt	A Fájlmegnyitás párbeszédpanel (CFileDialog Osztály) által használt alapértelmezett bővítményt adja meg a Testreszabás párbeszédpanel Eszközök lapjának Parancs mezőjében.
CUserToolsManager::SetFilter	Megadja a Fájlmegnyitás párbeszédpanel (CFileDialog Osztály) által a Testreszabás párbeszédpanel Eszközök lapjának Parancs mezőjében használt fájlszűrőt.

Megjegyzések

Ha felhasználói eszközöket szeretne beépíteni az alkalmazásba, a következőt kell tennie:

1. Foglaljon le egy menüelemet és egy hozzá tartozó parancsazonosítót egy felhasználói eszköz menübejegyzéséhez.

2. Foglaljon le egy szekvenciális parancsazonosítót minden olyan felhasználói eszközhöz, amelyet a felhasználó definiálhat az alkalmazásban.

3. Hívja meg a CWinAppEx::EnableUserTools metódust, és adja meg a következő paramétereket: menüparancs azonosítója, első felhasználói eszköz parancsazonosítója és utolsó felhasználói eszköz parancsazonosítója.

Alkalmazásonként csak egy globális CUserToolsManager objektumnak kell lennie.

A felhasználói eszközökre példaként tekintse meg a VisualStudioDemo mintaprojektet.

Example

Az alábbi példa bemutatja, hogyan kérhető le egy CUserToolsManager objektumra mutató hivatkozás, és hogyan hozhat létre új felhasználói eszközöket. Ez a kódrészlet a Visual Studio Demo-minta része.

CUserToolsManager* pUserToolsManager = theApp.GetUserToolsManager();
if (pUserToolsManager != NULL && pUserToolsManager->GetUserTools().IsEmpty())
{
   // CUserToolsManager* pUserToolsManager
   CUserTool* pTool1 = pUserToolsManager->CreateNewTool();
   pTool1->m_strLabel = _T("&Notepad");
   pTool1->SetCommand(_T("notepad.exe"));

   CUserTool* pTool2 = pUserToolsManager->CreateNewTool();
   pTool2->m_strLabel = _T("Paint &Brush");
   pTool2->SetCommand(_T("mspaint.exe"));

   CUserTool* pTool3 = pUserToolsManager->CreateNewTool();
   pTool3->m_strLabel = _T("&Windows Explorer");
   pTool3->SetCommand(_T("explorer.exe"));

   CUserTool* pTool4 = pUserToolsManager->CreateNewTool();
   pTool4->m_strLabel = _T("Microsoft On-&Line");
   pTool4->SetCommand(_T("http://www.microsoft.com"));
}

Öröklési hierarchia

CObject

CUserToolsManager

Requirements

Fejléc: afxusertoolsmanager.h

CUserToolsManager::CreateNewTool

Új felhasználói eszközt hoz létre.

CUserTool* CreateNewTool();

Visszaadott érték

Mutató az újonnan létrehozott felhasználói eszközre vagy NULL értékre, ha a felhasználói eszközök száma túllépte a maximális értéket. A visszaadott típus ugyanaz, mint a pToolRTC paraméternek CWinAppEx::EnableUserTools átadott típus.

Megjegyzések

Ez a metódus megkeresi a CWinAppEx::EnableUserTools hívásban megadott tartomány első elérhető menüparancs-azonosítóját, és hozzárendeli a felhasználói eszközt ehhez az azonosítóhoz.

A metódus meghiúsul, ha az eszközök száma elérte a maximális értéket. Ez akkor fordul elő, ha a tartományon belüli összes parancsazonosító hozzá van rendelve a felhasználói eszközökhöz. A CUserToolsManager::GetMaxTools hívásával lekérheti az eszközök maximális számát. Az eszközök listájához a CUserToolsManager::GetUserTools metódus meghívásával férhet hozzá.

CUserToolsManager::CUserToolsManager

Létrehoz egy CUserToolsManager-t. Minden alkalmazásnak legfeljebb egy felhasználóieszköz-kezelővel kell rendelkeznie.

CUserToolsManager();

CUserToolsManager(
    const UINT uiCmdToolsDummy,
    const UINT uiCmdFirst,
    const UINT uiCmdLast,
    CRuntimeClass* pToolRTC=RUNTIME_CLASS(CUserTool),
    UINT uArgMenuID=0,
    UINT uInitDirMenuID=0);

Paraméterek

uiCmdToolsDummy
[in] Egy aláíratlan egész szám, amelyet a keretrendszer a felhasználói eszközök menü parancsazonosítójának helyőrzőjeként használ.

uiCmdFirst
[in] Az első felhasználói eszköz parancsának parancsazonosítója.

uiCmdLast
[in] Az utolsó felhasználói eszköz parancsának parancsazonosítója.

pToolRTC
[in] A CUserToolsManager::CreateNewTool által létrehozott osztály. Az osztály használatával az alapértelmezett implementáció helyett a CUserTool osztály származtatott típusát használhatja.

uArgMenuID
[in] Az argumentumok előugró menüjének menüerőforrás-azonosítója.

uInitDirMenuID
[in] A kezdeti könyvtár előugró menüjének menüerőforrás-azonosítója.

Megjegyzések

Ne hívja ezt a konstruktort. Ehelyett hívja meg a CWinAppEx::EnableUserTools parancsot a felhasználói eszközök engedélyezéséhez, és hívja meg a CWinAppEx::GetUserToolsManager parancsot, CUserToolsManagerhogy a . További információ: Felhasználó által definiált eszközök.

CUserToolsManager::FindTool

A megadott parancsazonosítóhoz társított CUserTool osztályobjektumra mutató mutatót adja vissza.

CUserTool* FindTool(UINT uiCmdId) const;

Paraméterek

uiCmdId
[in] Menüparancs azonosítója.

Visszaadott érték

A CUserTool osztályra vagy CUserTool-származtatott objektumra mutató mutató, ha sikeres; egyébként NULL.

Megjegyzések

Ha FindTool sikeres, a visszaadott típus megegyezik a CWinAppEx::EnableUserToolspToolRTC paraméter típusával.

CUserToolsManager::GetArgumentsMenuID

A Testreszabás párbeszédpanel Eszközök lapján található Argumentumok menühöz társított erőforrás-azonosítót adja vissza.

UINT GetArgumentsMenuID() const;

Visszaadott érték

Egy menüerőforrás azonosítója.

Megjegyzések

A CWinAppEx uArgMenuID paramétere ::EnableUserTools az erőforrás azonosítóját adja meg.

CUserToolsManager::GetDefExt

A Fájlmegnyitás párbeszédpanel (CFileDialog) által használt alapértelmezett bővítményt adja vissza a Testreszabás párbeszédpanel Eszközök lapjának Parancs mezőjében.

const CString& GetDefExt() const;

Visszaadott érték

Hivatkozás a CString bővítményt tartalmazó objektumra.

CUserToolsManager::GetFilter

Azt a fájlszűrőt adja vissza, amelyet a Fájlmegnyitás párbeszédpanel (CFileDialog Osztály) a Testreszabás párbeszédpanel Eszközök lapJának Parancs mezőjében használ.

const CString& GetFilter() const;

Visszaadott érték

Hivatkozás a CString szűrőt tartalmazó objektumra.

CUserToolsManager::GetInitialDirMenuID

A Testreszabás párbeszédpanel Eszközök lapján található Kezdeti könyvtár menühöz társított erőforrás-azonosítót adja vissza.

UINT GetInitialDirMenuID() const;

Visszaadott érték

Egy menüerőforrás-azonosító.

Megjegyzések

A visszaadott azonosító a CWinAppEx::EnableUserToolsuInitDirMenuID paraméterében van megadva.

CUserToolsManager::GetMaxTools

Az alkalmazásban lefoglalható felhasználói eszközök maximális számát adja vissza.

int GetMaxTools() const;

Visszaadott érték

A lefoglalható felhasználói eszközök maximális száma.

Megjegyzések

Hívja meg ezt a metódust az alkalmazásban lefoglalható eszközök maximális számának lekéréséhez. Ez a szám az uiCmdFirstés aCWinAppEx::EnableUserTools közötti tartomány azonosítóinak száma.

CUserToolsManager::GetToolsEntryCmd

A felhasználói eszközök menüelem-helyőrzőjének parancsazonosítóját adja vissza.

UINT GetToolsEntryCmd() const;

Visszaadott érték

A helyőrző parancsazonosítója.

Megjegyzések

A felhasználói eszközök engedélyezéséhez hívja meg a CWinAppEx::EnableUserTools parancsot. Az uiCmdToolsDummy paraméter megadja az eszközök belépési parancsának parancsazonosítóját. Ez a metódus az eszközök bejegyzési parancsazonosítóját adja vissza. Bárhol is használja az azonosítót egy menüben, a menü megjelenésekor a felhasználói eszközök listája váltja fel.

CUserToolsManager::GetUserTools

A felhasználói eszközök listájára mutató hivatkozást ad vissza.

const CObList& GetUserTools() const;

Visszaadott érték

A felhasználói eszközök listáját tartalmazó CObList-osztályobjektumra mutató const-hivatkozás.

Megjegyzések

Hívja meg ezt a metódust a CUserToolsManager objektum által karbantartott felhasználói eszközök listájának lekéréséhez. Az egyes felhasználói eszközöket egy CUserTool osztály típusú vagy a forrásból CUserToolszármaztatott típusú objektum jelöli. A típust a pToolRTC paraméter adja meg, amikor meghívja a CWinAppEx::EnableUserTools parancsot a felhasználói eszközök engedélyezéséhez.

CUserToolsManager::InvokeTool

A megadott parancsazonosítóval rendelkező felhasználói eszközhöz társított alkalmazást hajt végre.

BOOL InvokeTool(UINT uiCmdId);

Paraméterek

uiCmdId
[in] A felhasználói eszközhöz társított menüparancs azonosítója.

Visszaadott érték

Nem kötelező, ha a felhasználói eszközhöz társított parancs végrehajtása sikeresen megtörtént; egyéb esetben 0.

Megjegyzések

Hívja meg ezt a metódust egy, az uiCmdId által megadott parancsazonosítóval rendelkező felhasználói eszközhöz társított alkalmazás végrehajtásához.

CUserToolsManager::IsUserToolCmd

Meghatározza, hogy a parancsazonosító egy felhasználói eszközhöz van-e társítva.

BOOL IsUserToolCmd(UINT uiCmdId) const;

Paraméterek

uiCmdId
[in] A menüelem parancsazonosítója.

Visszaadott érték

Nonzero, ha egy adott parancsazonosító egy felhasználói eszközhöz van társítva; egyéb esetben 0.

Megjegyzések

Ez a metódus ellenőrzi, hogy a megadott parancsazonosító szerepel-e a parancsazonosító tartományában. A CWinAppEx::EnableUserTools hívásához adja meg a tartományt a felhasználói eszközök engedélyezéséhez.

CUserToolsManager::LoadState

Betölti a felhasználói eszközökkel kapcsolatos információkat a Windows beállításjegyzékéből.

BOOL LoadState(LPCTSTR lpszProfileName=NULL);

Paraméterek

lpszProfileName
[in] A Windows beállításkulcs elérési útja.

Visszaadott érték

Nem aero, ha az állapot betöltése sikeresen megtörtént; egyéb esetben 0.

Megjegyzések

Ez a metódus betölti az CUserToolsManager objektum állapotát a Windows beállításjegyzékéből.

Ezt a metódust általában nem hívhatja meg közvetlenül. CWinAppEx::LoadState a munkaterület inicializálási folyamatának részeként hívja meg.

CUserToolsManager::MoveToolDown

A megadott felhasználói eszközt lejjebb helyezi a felhasználói eszközök listájában.

BOOL MoveToolDown(CUserTool* pTool);

Paraméterek

pTool
[in] Megadja az áthelyezni kívánt felhasználói eszközt.

Visszaadott érték

Nonzero, ha a felhasználói eszköz sikeresen le lett helyezve; egyéb esetben 0.

Megjegyzések

A metódus meghiúsul, ha a pTool által megadott eszköz nem szerepel a belső listában, vagy ha az eszköz utolsó a listában.

CUserToolsManager::MoveToolUp

A megadott felhasználói eszközt feljebb helyezi a felhasználói eszközök listájában.

BOOL MoveToolUp(CUserTool* pTool);

Paraméterek

pTool
[in] Megadja az áthelyezni kívánt felhasználói eszközt.

Visszaadott érték

Nonzero, ha a felhasználói eszköz sikeresen fel lett helyezve; egyéb esetben 0.

Megjegyzések

A metódus meghiúsul, ha a pTool paraméter által megadott eszköz nem szerepel a belső listában, vagy ha az eszköz a lista első eszközeleme.

CUserToolsManager::RemoveTool

Eltávolítja a megadott felhasználói eszközt az alkalmazásból.

BOOL RemoveTool(CUserTool* pTool);

Paraméterek

pTool
[be, ki] Egy eltávolítandó felhasználói eszközre mutató mutató.

Visszaadott érték

IGAZ, ha az eszköz sikeresen el lett távolítva. Ellenkező esetben az érték FALSE (HAMIS).

Megjegyzések

Ha az eszköz sikeresen el lett távolítva, ez a metódus törli a pTool-t.

CUserToolsManager::SaveState

A felhasználói eszközökkel kapcsolatos információkat a Windows beállításjegyzékében tárolja.

BOOL SaveState(LPCTSTR lpszProfileName=NULL);

Paraméterek

lpszProfileName
[in] A Windows beállításkulcs elérési útja.

Visszaadott érték

Nemzero, ha az állapot mentése sikeresen megtörtént; egyéb esetben 0.

Megjegyzések

A metódus az objektum aktuális állapotát CUserToolsManager a Windows beállításjegyzékben tárolja.

Ezt a metódust általában nem kell közvetlenül meghívnia, a CWinAppEx::SaveState automatikusan meghívja az alkalmazás munkaterület-szerializálási folyamatának részeként.

CUserToolsManager::SetDefExt

A Fájlmegnyitás párbeszédpanel (CFileDialog Osztály) által használt alapértelmezett bővítményt adja meg a Testreszabás párbeszédpanel Eszközök lapjának Parancs mezőjében.

void SetDefExt(const CString& strDefExt);

Paraméterek

strDefExt
[in] Az alapértelmezett fájlnévkiterjesztést tartalmazó szöveges sztring.

Megjegyzések

Hívja meg ezt a metódust, hogy adjon meg egy alapértelmezett fájlnévkiterjesztést a Fájl megnyitása párbeszédpanelen, amely akkor jelenik meg, amikor a felhasználó kiválaszt egy alkalmazást, amelyet társítani szeretne a felhasználói eszközzel. Az alapértelmezett érték az "exe".

CUserToolsManager::SetFilter

Megadja a Fájlmegnyitás párbeszédpanel (CFileDialog Osztály) által a Testreszabás párbeszédpanel Eszközök lapjának Parancs mezőjében használt fájlszűrőt.

void SetFilter(const CString& strFilter);

Paraméterek

strFilter
[in] Megadja a szűrőt.

Lásd még

hierarchiadiagram
osztályok
CWinAppEx osztály
CUserTool osztály