Sdílet prostřednictvím

CDockingManager – třída

  • Článek

Implementuje základní funkce, které řídí ukotvení rozložení v okně hlavního rámce.

Syntaxe

class CDockingManager : public CObject

Členové

Veřejné metody

Jméno popis
CDockingManager::AddDockSite Vytvoří podokno ukotvení a přidá ho do seznamu ovládacích panelů.
CDockingManager::AddHiddenMDITabbedBar Přidá úchyt do podokna pruhu do seznamu skrytých panelů s kartami MDI.
CDockingManager::AddMiniFrame Přidá rámeček do seznamu mini snímků.
CDockingManager::AddPane Zaregistruje podokno ve správci ukotvení.
CDockingManager::AdjustDockingLayout Přepočítá a upraví rozložení všech podoken v okně rámečku.
CDockingManager::AdjustPaneFrames Způsobí odeslání WM_NCCALCSIZE zprávy do všech podoken a CPaneFrameWnd oken.
CDockingManager::AdjustRectToClientArea Upraví zarovnání obdélníku.
CDockingManager::AlignAutoHidePane Změní velikost ukotveného podokna v režimu automatického skrytí tak, aby trvalo plnou šířku nebo výšku klientské oblasti rámečku obklopené lokalitami doku.
CDockingManager::AutoHidePane Vytvoří automaticky skrytý panel nástrojů.
CDockingManager::BringBarsToTop Vrátí ukotvené pruhy, které mají zadané zarovnání na začátek.
CDockingManager::BuildPanesMenu Přidá názvy dokovacích podoken a panelů nástrojů do nabídky.
CDockingManager::CalcExpectedDockedRect Vypočítá očekávaný obdélník ukotveného okna.
CDockingManager::Create Vytvoří správce ukotvení.
CDockingManager::D eterminePaneAndStatus Určuje podokno, které obsahuje daný bod a stav ukotvení.
CDockingManager::D isableRestoreDockState Povolí nebo zakáže načítání rozložení ukotvení z registru.
CDockingManager::D ockPane Ukotví podokno do jiného podokna nebo do okna rámečku.
CDockingManager::D ockPaneLeftOf Ukotví podokno vlevo od jiného podokna.
CDockingManager::EnableAutoHidePanes Umožňuje ukotvení podokna k hlavnímu rámečku, vytvoří dokovací podokno a přidá ho do seznamu ovládacích pruhů.
CDockingManager::EnableDocking Vytvoří dokovací podokno a povolí ukotvení podokna k hlavnímu rámu.
CDockingManager::EnableDockSiteMenu Zobrazí další tlačítko, které otevře místní nabídku v popis všech ukotvených podoken.
CDockingManager::EnablePaneContextMenu Informuje knihovnu, aby zobrazila speciální místní nabídku, která obsahuje seznam panelů nástrojů aplikací a ukotvení podoken, když uživatel klikne na pravé tlačítko myši a knihovna zpracovává zprávu WM_CONTEXTMENU.
CDockingManager::FindDockSite Načte podokno pruhu, které je na zadané pozici a které má zadané zarovnání.
CDockingManager::FindDockSiteByPane Vrátí podokno pruhu s ID cílového podokna pruhu.
CDockingManager::FindPaneByID Vyhledá podokno podle zadaného ID ovládacího prvku.
CDockingManager::FixupVirtualRects Potvrdí všechny aktuální pozice panelu nástrojů do virtuálních obdélníků.
CDockingManager::FrameFromPoint Vrátí rámec, který obsahuje daný bod.
CDockingManager::GetClientAreaBounds Získá obdélník, který obsahuje hranice klientské oblasti.
CDockingManager::GetDockingMode Vrátí aktuální dokovací režim.
CDockingManager::GetDockSiteFrameWnd Získá ukazatel na nadřazený rámec okna.
CDockingManager::GetEnabledAutoHideAlignment Vrátí povolené zarovnání podoken.
CDockingManager::GetMiniFrames Získá seznam miniframeů.
CDockingManager::GetOuterEdgeBounds Získá obdélník, který obsahuje vnější okraje rámce.
CDockingManager::GetPaneList Vrátí seznam podoken, které patří správci ukotvení. To zahrnuje všechna plovoucí podokna.
CDockingManager::GetSmartDockingManager Načte ukazatel na správce inteligentního ukotvení.
CDockingManager::GetSmartDockingManagerPermanent Načte ukazatel na správce inteligentního ukotvení.
CDockingManager::GetSmartDockingParams Vrátí inteligentní dokovací parametry správce dokování.
CDockingManager::GetSmartDockingTheme Statická metoda, která vrací motiv použitý k zobrazení inteligentních dokovacích značek.
CDockingManager::HideAutoHidePanes Skryje podokno, které je v režimu automatického skrytí.
CDockingManager::InsertDockSite Vytvoří dokovací podokno a vloží ho do seznamu ovládacích panelů.
CDockingManager::InsertPane Vloží podokno ovládacích prvků do seznamu ovládacích pruhů.
CDockingManager::IsDockSiteMenu Určuje, jestli se v popis všech podoken zobrazí místní nabídka.
CDockingManager::IsInAdjustLayout Určuje, zda jsou upravena rozložení všech podoken.
CDockingManager::IsOLEContainerMode Určuje, zda je správce dokování v režimu kontejneru OLE.
CDockingManager::IsPointNearDockSite Určuje, zda je zadaný bod blízko doku.
CDockingManager::IsPrintPreviewValid Určuje, jestli je nastavený režim náhledu tisku.
CDockingManager::LoadState Načte stav dokovacího manažera z registru.
CDockingManager::LockUpdate Uzamkne dané okno.
CDockingManager::OnActivateFrame Volá se rozhraním, když je okno rámečku aktivní nebo je deaktivováno.
CDockingManager::OnClosePopupMenu Volá se rozhraním, když aktivní místní nabídka zpracuje WM_DESTROY zprávu.
CDockingManager::OnmoveMiniFrame Volá se rozhraním pro přesunutí okna s mini rámečkem.
CDockingManager::OnPaneContextMenu Volá se rozhraním, když sestaví nabídku se seznamem podoken.
CDockingManager::P aneFromPoint Vrátí podokno, které obsahuje daný bod.
CDockingManager::P rocessPaneContextMenuCommand Volá se rozhraním, které má zaškrtnout nebo zrušit zaškrtnutí políčka pro zadaný příkaz a přepočítat rozložení zobrazeného podokna.
CDockingManager::RecalcLayout Přepočítá vnitřní rozložení ovládacích prvků, které jsou přítomné v seznamu ovládacích prvků.
CDockingManager::ReleaseEmptyPaneContainers Uvolní prázdné kontejnery podokna.
CDockingManager::RemoveHiddenMDITabbedBar Odebere zadané skryté podokno pruhu.
CDockingManager::RemoveMiniFrame Odebere zadaný rámec ze seznamu mini snímků.
CDockingManager::RemovePaneFromDockManager Zruší registraci podokna a odebere ho ze seznamu ve správci ukotvení.
CDockingManager::ReplacePane Nahradí jedno podokno jiným.
CDockingManager::ResortMiniFramesForZOrder Resorts the frames in the list of mini frames.
CDockingManager::SaveState Uloží stav dokovacího manažera do registru.
CDockingManager::SendMessageToMiniFrames Odešle zadanou zprávu do všech mini snímků.
CDockingManager::Serialize Zapíše dokovacího manažera do archivu. (Přepsání CObject::Serialize.)
CDockingManager::SetAutohideZOrder Nastaví velikost, šířku a výšku ovládacích panelů a zadaného podokna.
CDockingManager::SetDockingMode Nastaví dokovací režim.
CDockingManager::SetDockState Nastaví dokovací stav řídicích pruhů, mini rámečků a automaticky skrytých pruhů.
CDockingManager::SetPrintPreviewMode Nastaví režim náhledu tisku pruhů zobrazených v náhledu tisku.
CDockingManager::SetSmartDockingParams Nastaví parametry, které definují chování inteligentního ukotvení.
CDockingManager::ShowDelayShowMiniFrames Zobrazí nebo skryje okna mini rámečků.
CDockingManager::ShowPanes Zobrazí nebo skryje podokna ovládacího prvku a automaticky se zobrazí pruhy.
CDockingManager::StartSDocking Spustí inteligentní dokování zadaného okna podle zarovnání správce inteligentního dokování.
CDockingManager::StopSDocking Zastaví inteligentní dokování.

Datové členy

Jméno popis
CDockingManager::m_bHideDockingBarsInContainerMode Určuje, zda správce dokování skryje podokna v režimu kontejneru OLE.
CDockingManager::m_dockModeGlobal Určuje globální režim ukotvení.
CDockingManager::m_nDockSensitivity Určuje dokovací citlivost.
CDockingManager::m_nTimeOutBeforeDockingBarDock Určuje čas v milisekundách před ukotvením podokna v okamžitém dokovacím režimu.
CDockingManager::m_nTimeOutBeforeToolBarDock Určuje čas v milisekundách před ukotveným panelem nástrojů do okna hlavního rámce.

Poznámky

Okno hlavního rámce vytvoří a inicializuje tuto třídu automaticky.

Objekt správce ukotvení obsahuje seznam všech podoken, které jsou v ukotvení rozložení, a také seznam všech oken CPaneFrameWnd , která patří do okna hlavního rámce.

Třída CDockingManager implementuje některé služby, které můžete použít k vyhledání podokna CPaneFrameWnd nebo okna. Tyto služby obvykle nevoláte přímo, protože jsou zabalené v objektu okna hlavního rámce. Další informace naleznete v tématu CPaneFrameWnd – třída.

Tipy přizpůsobení

Následující tipy platí pro CDockingManager objekty:

Příklad

Následující příklad ukazuje použití různých metod ve CDockingManager třídě ke konfiguraci objektu CDockingManager . Příklad ukazuje, jak zobrazit další tlačítko, které otevře místní nabídku na popis všech ukotvených podoken a jak nastavit dokovací režim objektu. Tento fragment kódu je součástí ukázky sady Visual Studio Demo.

CDockingManager *pDockManager = GetDockingManager();
ASSERT_VALID(pDockManager);
pDockManager->AdjustPaneFrames();
pDockManager->EnableDockSiteMenu();
pDockManager->SetDockingMode(DT_STANDARD);

Hierarchie dědičnosti

Objekt CObject

CDockingManager

Požadavky

Hlavička: afxDockingManager.h

CDockingManager::AddDockSite

Vytvoří podokno ukotvení a přidá ho do seznamu ovládacích panelů.

BOOL AddDockSite(
    const AFX_DOCKSITE_INFO& info,
    CDockSite** ppDockBar = NULL);

Parametry

Info
[v] Odkaz na informační strukturu, která obsahuje zarovnání podokna ukotvení.

ppDockBar
[ven] Ukazatel na ukazatel na nové podokno ukotvení.

Vrácená hodnota

TRUE, pokud se podokno ukotvení úspěšně vytvořilo; JINAK NEPRAVDA.

CDockingManager::AddHiddenMDITabbedBar

Přidá úchyt do podokna pruhu do seznamu skrytých panelů s kartami MDI.

void AddHiddenMDITabbedBar(CDockablePane* pBar);

Parametry

pBar
[v] Ukazatel na podokno pruhu

CDockingManager::AddPane

Zaregistruje podokno ve správci ukotvení.

BOOL AddPane(
    CBasePane* pWnd,
    BOOL bTail = TRUE,
    BOOL bAutoHide = FALSE,
    BOOL bInsertForOuterEdge = FALSE);

Parametry

pWnd
[in, out] Určuje podokno, které se má přidat do dokovacího správce.

bTail
[v] TRUE pro přidání podokna na konec seznamu podoken pro dokovací správce; jinak NEPRAVDA.

bAutoHide
[v] Pouze pro interní použití. Vždy používejte výchozí hodnotu FALSE.

bInsertForOuterEdge
[v] Pouze pro interní použití. Vždy používejte výchozí hodnotu FALSE.

Vrácená hodnota

TRUE, pokud podokno bylo úspěšně zaregistrováno u dokovací správce; jinak NEPRAVDA.

Poznámky

Voláním této metody zaregistrujte ne plovoucí, nesložitelná podokna pomocí správce ukotvení. Pokud podokna nezaregistrujete, nezobrazí se správně, jakmile je správce ukotvení rozložen.

CDockingManager::AdjustDockingLayout

Přepočítá a upraví rozložení všech podoken v okně rámečku.

virtual void AdjustDockingLayout(HDWP hdwp = NULL);

Parametry

hdwp
[v] Určuje odloženou strukturu pozice okna. Další informace naleznete v tématu Datové typy Systému Windows.

Poznámky

CDockingManager::AddMiniFrame

Přidá rámeček do seznamu mini snímků.

virtual BOOL AddMiniFrame(CPaneFrameWnd* pWnd);

Parametry

pWnd
[v] Ukazatel na rámeček.

Vrácená hodnota

TRUE, pokud rámec není v seznamu mini snímků a byl úspěšně přidán; JINAK NEPRAVDA.

CDockingManager::AdjustPaneFrames

Způsobí odeslání WM_NCCALCSIZE zprávy do všech podoken a CPaneFrameWnd oken.

virtual void AdjustPaneFrames();

Poznámky

CDockingManager::AdjustRectToClientArea

Upraví zarovnání obdélníku.

virtual BOOL AdjustRectToClientArea(
    CRect& rectResult,
    DWORD dwAlignment);

Parametry

rectResult
[v] Odkaz na CRect objekt

dwAlignment
[v] Zarovnání objektu CRect

Vrácená hodnota

TRUE, pokud bylo upraveno zarovnání objektu CRect ; JINAK NEPRAVDA.

Poznámky

Parametr dwAlignment může mít jednu z následujících hodnot:

  • CBRS_ALIGN_TOP

  • CBRS_ALIGN_BOTTOM

  • CBRS_ALIGN_LEFT

  • CBRS_ALIGN_RIGHT

CDockingManager::AlignAutoHidePane

Změní velikost ukotveného podokna v režimu automatického skrytí tak, aby trvalo plnou šířku nebo výšku klientské oblasti rámečku obklopené lokalitami doku.

void AlignAutoHidePane(
    CPaneDivider* pDefaultSlider,
    BOOL bIsVisible = TRUE);

Parametry

pDefaultSlider
[v] Podokno ukotvení posuvníku.

bIsVisible
[v] TRUE, pokud je ukotvení podokno viditelné; JINAK NEPRAVDA.

CDockingManager::AutoHidePane

Vytvoří automaticky skrytý panel nástrojů.

CMFCAutoHideToolBar* AutoHidePane(
    CDockablePane* pBar,
    CMFCAutoHideToolBar* pCurrAutoHideToolBar = NULL);

Parametry

pBar
[v] Ukazatel na podokno pruhu.

pCurrAutoHideToolBar
[v] Ukazatel na panel nástrojů automatického skrytí

Vrácená hodnota

NULL pokud nebyl vytvořen panel nástrojů automatického skrytí; v opačném případě ukazatel na nový panel nástrojů.

CDockingManager::BringBarsToTop

Vrátí ukotvené pruhy, které mají zadané zarovnání na začátek.

void BringBarsToTop(
    DWORD dwAlignment = 0,
    BOOL bExcludeDockedBars = TRUE);

Parametry

dwAlignment
[v] Zarovnání dokovacích pruhů, které jsou přeneseny na začátek ostatních oken.

bExcludeDockedBars
[v] PRAVDA vyloučit ukotvené pruhy, aby byly nahoře; jinak NEPRAVDA.

CDockingManager::BuildPanesMenu

Přidá názvy dokovacích podoken a panelů nástrojů do nabídky.

void BuildPanesMenu(
    CMenu& menu,
    BOOL bToolbarsOnly);

Parametry

Nabídky
[v] Nabídka pro přidání názvů dokovacích podoken a panelů nástrojů

bToolbarsOnly
[v] TRUE pro přidání pouze názvů panelů nástrojů do nabídky; JINAK NEPRAVDA.

CDockingManager::CalcExpectedDockedRect

Vypočítá očekávaný obdélník ukotveného okna.

void CalcExpectedDockedRect(
    CWnd* pWnd,
    CPoint ptMouse,
    CRect& rectResult,
    BOOL& bDrawTab,
    CDockablePane** ppTargetBar);

Parametry

pWnd
[v] Ukazatel na okno pro ukotvení.

ptMouse
[v] Umístění myši.

rectResult
[ven] Počítaný obdélník.

bDrawTab
[v] TRUE pro kreslení tabulátoru; jinak NEPRAVDA.

ppTargetBar
[ven] Ukazatel na ukazatel na cílové podokno.

Poznámky

Tato metoda vypočítá obdélník, který by okno zabíralo, pokud uživatel přetáhl okno do bodu určeného ptMouse a ukotvil ho tam.

CDockingManager::Create

Vytvoří správce ukotvení.

BOOL Create(CFrameWnd* pParentWnd);

Parametry

pParentWnd
[v] Ukazatel na nadřazený rámec správce ukotvení. Tato hodnota nesmí být NULL.

Vrácená hodnota

Pravda vždy.

CDockingManager::D eterminePaneAndStatus

Určuje podokno, které obsahuje daný bod a stav ukotvení.

virtual AFX_CS_STATUS DeterminePaneAndStatus(
    CPoint pt,
    int nSensitivity,
    DWORD dwEnabledAlignment,
    CBasePane** ppTargetBar,
    const CBasePane* pBarToIgnore,
    const CBasePane* pBarToDock);

Parametry

Pt
[v] Umístění podokna, které chcete zkontrolovat.

NSensitivity
[v] Hodnota pro zvýšení obdélníku okna každého zaškrtnutého podokna. Podokno splňuje kritéria hledání, pokud je daný bod v této zvýšené oblasti.

dwEnabledAlignment
[v] Zarovnání ukotveného podokna

ppTargetBar
[ven] Ukazatel na ukazatel na cílové podokno.

pBarToIgnore
[v] Podokno, které metoda ignoruje.

pBarToDock
[v] Podokno, které je ukotvené.

Vrácená hodnota

Stav ukotvení.

Poznámky

Stav ukotvení může být jedna z následujících hodnot:

hodnota AFX_CS_STATUS Význam
CS_NOTHING Ukazatel není přes web docku. Proto nechte podokno plovoucí.
CS_DOCK_IMMEDIATELY Ukazatel se nachází na webu docku v okamžitém režimu (DT_IMMEDIATE styl je povolený), takže podokno musí být ukotveno okamžitě.
CS_DELAY_DOCK Ukazatel je nad webem docku, který je dalším ukotvením podokna nebo je hranou hlavního rámce.
CS_DELAY_DOCK_TO_TAB Ukazatel je na webu docku, který způsobí ukotvení podokna v okně s kartami. K tomu dochází, když je myš nad popis jiného ukotveného podokna nebo přes oblast karty v podokně s kartami.

CDockingManager::D isableRestoreDockState

Povolí nebo zakáže načítání rozložení ukotvení z registru.

void DisableRestoreDockState(BOOL bDisable = TRUE);

Parametry

bDisable
[v] TRUE zakázat načítání rozložení ukotvení z registru; jinak NEPRAVDA.

Poznámky

Volání této metody, pokud je nutné zachovat aktuální rozložení ukotvených podoken a panelů nástrojů při načítání stavu aplikace.

CDockingManager::D ockPane

Ukotví podokno do jiného podokna nebo do okna rámečku.

void DockPane(
    CBasePane* pBar,
    UINT nDockBarID = 0,
    LPCRECT lpRect = NULL);

Parametry

pBar
[v] Ukazatel na podokno pruhu pro ukotvení.

nDockBarID
[v] ID panelu, který se má ukotvit.

lpRect
[v] Cílový obdélník.

CDockingManager::D ockPaneLeftOf

Ukotví podokno vlevo od jiného podokna.

BOOL DockPaneLeftOf(
    CPane* pBarToDock,
    CPane* pTargetBar);

Parametry

pBarToDock
[v] Ukazatel na podokno, které se má ukotvit nalevo od pTargetBar.

pTargetBar
[v] Ukazatel na cílové podokno.

Vrácená hodnota

TRUE, pokud bylo podokno úspěšně ukotveno; jinak NEPRAVDA.

CDockingManager::EnableAutoHidePanes

Umožňuje ukotvení podokna k hlavnímu rámečku, vytvoří dokovací podokno a přidá ho do seznamu ovládacích pruhů.

BOOL EnableAutoHidePanes(DWORD dwStyle);

Parametry

dwStyle
[v] Dokovací zarovnání.

Vrácená hodnota

TRUE, pokud se podokno ukotvení úspěšně vytvořilo; JINAK NEPRAVDA.

CDockingManager::EnableDocking

Vytvoří dokovací podokno a povolí ukotvení podokna k hlavnímu rámu.

BOOL EnableDocking(DWORD dwStyle);

Parametry

dwStyle
[v] Dokovací zarovnání.

Vrácená hodnota

TRUE, pokud se podokno ukotvení úspěšně vytvořilo; JINAK NEPRAVDA.

CDockingManager::EnableDockSiteMenu

Zobrazí další tlačítko, které otevře místní nabídku v popis všech ukotvených podoken.

static void EnableDockSiteMenu(BOOL bEnable = TRUE);

Parametry

bEnable
[v] TRUE pro povolení nabídky dokovací lokality; jinak NEPRAVDA.

Poznámky

V nabídce webu docku se zobrazí následující možnosti pro změnu stavu ukotvení podokna:

  • Floating – Plovoucí podokno

  • Docking - Ukotví podokno v hlavním rámečku v umístění, kde bylo podokno naposledy ukotveno.

  • AutoHide - Přepne podokno do režimu automatického skrytí.

  • Hide – Skryje podokno.

Ve výchozím nastavení se tato nabídka nezobrazí.

CDockingManager::EnablePaneContextMenu

Informuje knihovnu, aby zobrazila speciální místní nabídku, která obsahuje seznam panelů nástrojů aplikací a ukotvení podoken, když uživatel klikne na pravé tlačítko myši a knihovna zpracovává zprávu WM_CONTEXTMENU.

void EnablePaneContextMenu(
    BOOL bEnable,
    UINT uiCustomizeCmd,
    const CString& strCustomizeText,
    BOOL bToolbarsOnly = FALSE);

Parametry

bEnable
[v] Pokud je pravda, knihovna zapne podporu pro automatickou místní nabídku; Pokud je hodnota FALSE, knihovna vypne podporu pro automatickou místní nabídku.

uiCustomizeCmd
[v] ID příkazu pro položku Přizpůsobit v nabídce.

strCustomizeText
[v] Text položky Přizpůsobit

bToolbarsOnly
[v] Pokud je pravda, nabídka zobrazí pouze seznam panelů nástrojů aplikace; Pokud je hodnota FALSE, knihovna přidá dokovací podokna aplikace do tohoto seznamu.

CDockingManager::FindDockSite

Načte podokno pruhu, které je na zadané pozici a které má zadané zarovnání.

virtual CDockSite* FindDockSite(
    DWORD dwAlignment,
    BOOL bOuter);

Parametry

dwAlignment
[v] Zarovnání podokna pruhu

bOuter
[v] Pokud je pravda, načtěte pruh v pozici hlavy v seznamu ovládacích pruhů. V opačném případě načtěte pruh v koncové pozici v seznamu ovládacích pruhů.

Vrácená hodnota

Ukotvené podokno se zadaným zarovnáním; V opačném případě hodnota NULL.

CDockingManager::FindPaneByID

Vyhledá podokno podle zadaného ID ovládacího prvku.

virtual CBasePane* FindPaneByID(
    UINT uBarID,
    BOOL bSearchMiniFrames = FALSE);

Parametry

uBarID
[v] Určuje ID ovládacího prvku podokna, které se má najít.

bSearchMiniFrames
[v] PRAVDA, pokud chcete do hledání zahrnout všechna plovoucí podokna. NEPRAVDA, pokud chcete zahrnout pouze ukotvená podokna.

Vrácená hodnota

CBasePane objekt, který má zadané ID ovládacího prvku nebo NULL, pokud zadané podokno nelze najít.

Poznámky

CDockingManager::FindDockSiteByPane

Vrátí podokno pruhu s ID cílového podokna pruhu.

virtual CDockSite* FindDockSiteByPane(CPane* pTargetBar);

Parametry

pTargetBar
[v] Ukazatel na podokno cílového panelu

Vrácená hodnota

Podokno pruhu s ID cílového podokna pruhu; Null pokud neexistuje žádné takové podokno pruhu.

CDockingManager::FixupVirtualRects

Potvrdí všechny aktuální pozice panelu nástrojů do virtuálních obdélníků.

virtual void FixupVirtualRects();

Poznámky

Když uživatel začne přetahovat panel nástrojů, aplikace si zapamatuje původní pozici ve virtuálním obdélníku. Když uživatel přesune panel nástrojů přes svůj dok webu, může panel nástrojů posunout jiné panely nástrojů. Původní pozice ostatních panelů nástrojů jsou uloženy v odpovídajících virtuálních obdélníkech.

CDockingManager::FrameFromPoint

Vrátí rámec, který obsahuje daný bod.

virtual CPaneFrameWnd* FrameFromPoint(
    CPoint pt,
    CPaneFrameWnd* pFrameToExclude,
    BOOL bFloatMultiOnly) const;

Parametry

Pt
[v] Určuje bod, který se má zkontrolovat, v souřadnicích obrazovky.

pFrameToExclude
[v] Ukazatel na rámec, který chcete vyloučit.

bFloatMultiOnly
[v] PRAVDA vyloučit rámce, které nejsou instancemi CMultiPaneFrameWnd; JINAK NEPRAVDA.

Vrácená hodnota

Rámec, který obsahuje daný bod; V opačném případě hodnota NULL.

CDockingManager::GetClientAreaBounds

Získá obdélník, který obsahuje hranice klientské oblasti.

CRect GetClientAreaBounds() const;

void GetClientAreaBounds(CRect& rcClient);

Parametry

RcClient
[ven] Odkaz na obdélník, který obsahuje hranice klientské oblasti.

Vrácená hodnota

Obdélník, který obsahuje hranice klientské oblasti.

CDockingManager::GetDockingMode

Vrátí aktuální dokovací režim.

static AFX_DOCK_TYPE GetDockingMode();

Vrácená hodnota

Hodnota enumerátoru, která představuje aktuální režim ukotvení. Může to být jedna z následujících hodnot:

  • DT_STANDARD

  • DT_IMMEDIATE

  • DT_SMART

Poznámky

Chcete-li nastavit dokovací režim, zavolejte CDockingManager::SetDockingMode.

CDockingManager::GetDockSiteFrameWnd

Získá ukazatel na nadřazený rámec okna.

CFrameWnd* GetDockSiteFrameWnd() const;

Vrácená hodnota

Ukazatel na nadřazený rámec okna.

CDockingManager::GetEnabledAutoHideAlignment

Vrátí povolené zarovnání podoken.

DWORD GetEnabledAutoHideAlignment() const;

Vrácená hodnota

Bitová kombinace příznaků CBRS_ALIGN_ nebo 0, pokud nejsou povolena automaticky skrytá podokna. Další informace naleznete v tématu CFrameWnd::EnableDocking.

Poznámky

Metoda vrátí povolené zarovnání pro automatické skrytí ovládacích pruhů. Chcete-li povolit automatické skryté pruhy, zavolejte CFrameWndEx::EnableAutoHidePanes.

CDockingManager::GetMiniFrames

Získá seznam miniframeů.

const CObList& GetMiniFrames() const;

Vrácená hodnota

Seznam miniframeů, které obsahují řídicí panely, které patří dokovacímu správci.

CDockingManager::GetOuterEdgeBounds

Získá obdélník, který obsahuje vnější okraje rámce.

CRect GetOuterEdgeBounds() const;

Vrácená hodnota

Obdélník, který obsahuje vnější okraje rámečku.

CDockingManager::GetPaneList

Vrátí seznam podoken, které patří správci ukotvení. To zahrnuje všechna plovoucí podokna.

void GetPaneList(
    CObList& lstBars,
    BOOL bIncludeAutohide = FALSE,
    CRuntimeClass* pRTCFilter = NULL,
    BOOL bIncludeTabs = FALSE);

Parametry

LstBars
[in, out] Obsahuje všechna podokna aktuálního správce ukotvení.

bIncludeAutohide
[v] PRAVDA, pokud chcete zahrnout podokna, která jsou v režimu automatického skrytí; jinak NEPRAVDA.

pRTCFilter
[v] Pokud není null, vrácený seznam obsahuje pouze podokna zadané třídy modulu runtime.

bIncludeTabs
[v] PRAVDA pro zahrnutí karet; jinak NEPRAVDA.

Poznámky

Pokud jsou v dokovacím správci nějaké podokna s kartami, metoda vrátí ukazatele na CBaseTabbedPane Třídy a je nutné vytvořit výčet karet explicitně.

K získání konkrétní třídy podoken použijte pRTCFilter . Můžete například získat pouze panely nástrojů tak, že tuto hodnotu nastavíte odpovídajícím způsobem.

CDockingManager::GetSmartDockingManager

Načte ukazatel na správce inteligentního ukotvení.

CSmartDockingManager* GetSmartDockingManager();

Vrácená hodnota

Ukazatel na správce inteligentního dokování

CDockingManager::GetSmartDockingManagerPermanent

Načte ukazatel na správce inteligentního ukotvení.

CSmartDockingManager* GetSmartDockingManagerPermanent() const;

Vrácená hodnota

Ukazatel na správce inteligentního dokování

CDockingManager::GetSmartDockingParams

Vrátí inteligentní dokovací parametry správce dokování.

static CSmartDockingInfo& GetSmartDockingParams();

Vrácená hodnota

Třída, která obsahuje parametry inteligentního dokování pro aktuálního správce ukotvení. Další informace naleznete v CSmartDockingInfo – třída.

Poznámky

CDockingManager::HideAutoHidePanes

Skryje podokno, které je v režimu automatického skrytí.

void HideAutoHidePanes(
    CDockablePane* pBarToExclude = NULL,
    BOOL bImmediately = FALSE);

Parametry

pBarToExclude
[v] Ukazatel na pruh, který chcete vyloučit z skrytí.

bImmediately
[v] TRUE pro skrytí podokna okamžitě; NEPRAVDA pro skrytí podokna s automaticky skrytým efektem.

CDockingManager::InsertDockSite

Vytvoří dokovací podokno a vloží ho do seznamu ovládacích panelů.

BOOL InsertDockSite(
    const AFX_DOCKSITE_INFO& info,
    DWORD dwAlignToInsertAfter,
    CDockSite** ppDockBar = NULL);

Parametry

Info
[v] Struktura, která obsahuje informace o zarovnání podokna ukotvení.

dwAlignToInsertAfter
[v] Zarovnání podokna ukotvení

ppDockBar
[ven] Ukazatel na ukazatel na podokno ukotvení.

Vrácená hodnota

TRUE, pokud se podokno ukotvení úspěšně vytvořilo; JINAK NEPRAVDA.

CDockingManager::InsertPane

Vloží podokno ovládacích prvků do seznamu ovládacích pruhů.

BOOL InsertPane(
    CBasePane* pControlBar,
    CBasePane* pTarget,
    BOOL bAfter = TRUE);

Parametry

pControlBar
[v] Ukazatel na podokno ovládacích prvků.

pTarget
[v] Ukazatel na cílové podokno

bAfter
[v] TRUE pro vložení podokna za pozici cílového podokna; JINAK NEPRAVDA.

Vrácená hodnota

TRUE, pokud je podokno ovládacích prvků úspěšně přidáno do seznamu ovládacích pruhů; JINAK NEPRAVDA.

Poznámky

Tato metoda vrátí hodnotu false, pokud je podokno ovládacích prvků již v seznamu řídicích pruhů nebo pokud cílové podokno v seznamu ovládacích pruhů neexistuje.

CDockingManager::IsDockSiteMenu

Určuje, jestli se v popis všech podoken zobrazí místní nabídka.

static BOOL IsDockSiteMenu();

Vrácená hodnota

TRUE, pokud je v popis všech ukotvených podoken zobrazena nabídka webu docku; jinak NEPRAVDA.

Poznámky

Nabídku webu docku můžete povolit voláním CDockingManager::EnableDockSiteMenu.

CDockingManager::IsInAdjustLayout

Určuje, zda jsou upravena rozložení všech podoken.

BOOL IsInAdjustLayout() const;

Vrácená hodnota

TRUE, pokud jsou upravena rozložení všech podoken; JINAK NEPRAVDA.

CDockingManager::IsOLEContainerMode

Určuje, zda je správce dokování v režimu kontejneru OLE.

BOOL IsOLEContainerMode() const;

Vrácená hodnota

TRUE, pokud je správce dokování v režimu kontejneru OLE; jinak NEPRAVDA.

Poznámky

V režimu kontejneru OLE jsou všechna ukotvená podokna a panely nástrojů aplikace skryté. Podokna jsou v tomto režimu také skrytá, pokud jste nastavili CDockingManager::m_bHideDockingBarsInContainerMode na HODNOTU TRUE.

CDockingManager::IsPointNearDockSite

Určuje, zda je zadaný bod blízko doku.

BOOL IsPointNearDockSite(
    CPoint point,
    DWORD& dwBarAlignment,
    BOOL& bOuterEdge) const;

Parametry

Bod
[v] Zadaný bod.

dwBarAlignment
[ven] Určuje, který okraj je bod blízko. Možné hodnoty jsou CBRS_ALIGN_LEFT, CBRS_ALIGN_RIGHT, CBRS_ALIGN_TOP a CBRS_ALIGN_BOTTOM.

bOuterEdge
[ven] PRAVDA, pokud je bod blízko vnějšího okraje dokovací lokality; JINAK NEPRAVDA.

Vrácená hodnota

TRUE, pokud je bod blízko dokovací lokality; jinak NEPRAVDA.

CDockingManager::IsPrintPreviewValid

Určuje, jestli je nastavený režim náhledu tisku.

BOOL IsPrintPreviewValid() const;

Vrácená hodnota

TRUE, pokud je nastaven režim náhledu tisku; JINAK NEPRAVDA.

CDockingManager::LoadState

Načte stav dokovacího manažera z registru.

virtual BOOL LoadState(
    LPCTSTR lpszProfileName = NULL,
    UINT uiID = (UINT) -1);

Parametry

lpszProfileName
[v] Název profilu

UIID
[v] ID správce dokování.

Vrácená hodnota

TRUE, pokud byl stav správce ukotvení úspěšně načten; jinak NEPRAVDA.

CDockingManager::LockUpdate

Uzamkne dané okno.

void LockUpdate(BOOL bLock);

Parametry

Blok
[v] TRUE, pokud je okno uzamčeno; JINAK NEPRAVDA.

Poznámky

Když je okno zamknuté, nelze ho přesunout a nelze ho překreslit.

CDockingManager::m_bHideDockingBarsInContainerMode

Určuje, zda správce dokování skryje podokna v režimu kontejneru OLE.

AFX_IMPORT_DATA static BOOL m_bHideDockingBarsInContainerMode;

Poznámky

Tuto hodnotu nastavte na HODNOTU FALSE, pokud chcete zachovat všechna podokna ukotvená k hlavnímu rámečku, když je aplikace v režimu kontejneru OLE. Ve výchozím nastavení má tato hodnota hodnotu TRUE.

CDockingManager::m_dockModeGlobal

Určuje globální režim ukotvení.

AFX_IMPORT_DATA static AFX_DOCK_TYPE m_dockModeGlobal;

Poznámky

Ve výchozím nastavení používá každé ukotvení tento režim ukotvení. Další informace o hodnotách, na které lze toto pole nastavit, naleznete v tématu CBasePane::GetDockingMode.

CDockingManager::m_nDockSensitivity

Určuje dokovací citlivost.

AFX_IMPORT_DATA static int m_nDockSensitivity;

Poznámky

Citlivost ukotvení definuje, jak blízko plovoucí podokno může přistupovat k dokovacímu podoknu, ukotvení webu nebo jinému podoknu před tím, než architektura změní stav ukotvení.

CDockingManager::m_nTimeOutBeforeDockingBarDock

Určuje čas v milisekundách před ukotvením podokna v okamžitém dokovacím režimu.

static UINT m_nTimeOutBeforeDockingBarDock;

Poznámky

Před ukotveným podoknem rozhraní počká zadanou dobu. Tím zabráníte náhodnému ukotvení podokna na místo, zatímco uživatel ho stále přetahuje.

CDockingManager::m_nTimeOutBeforeToolBarDock

Určuje čas v milisekundách před ukotveným panelem nástrojů do okna hlavního rámce.

static UINT m_nTimeOutBeforeToolBarDock;

Poznámky

Před ukotveným panelem nástrojů rozhraní počká zadanou dobu. Tím zabráníte náhodnému ukotvení panelu nástrojů na místo, zatímco uživatel ho stále přetahuje.

CDockingManager::OnActivateFrame

Volá se rozhraním, když je okno rámečku aktivní nebo je deaktivováno.

virtual void OnActivateFrame(BOOL bActivate);

Parametry

bActivate
[v] Je-li pravda, okno rámečku je aktivní; pokud JE NEPRAVDA, okno rámečku se deaktivuje.

CDockingManager::OnClosePopupMenu

Volá se rozhraním, když aktivní místní nabídka zpracuje WM_DESTROY zprávu.

void OnClosePopupMenu();

Poznámky

Rozhraní odešle WM_DESTROY zprávu, když se chystá zavřít aktuální hlavní okno. Tuto metodu přepište tak, aby zpracovávala oznámení z CMFCPopupMenu objektů, které patří do okna rámce, když CMFCPopupMenu objekt zpracuje WM_DESTROY zprávu.

CDockingManager::OnmoveMiniFrame

Volá se rozhraním pro přesunutí okna s mini rámečkem.

virtual BOOL OnMoveMiniFrame(CWnd* pFrame);

Parametry

pFrame
[v] Ukazatel na okno s mini rámečkem

Vrácená hodnota

TRUE, pokud metoda uspěje; jinak NEPRAVDA.

CDockingManager::OnPaneContextMenu

Volá se rozhraním, když sestaví nabídku se seznamem podoken.

void OnPaneContextMenu(CPoint point);

Parametry

Bod
[v] Určuje umístění nabídky.

CDockingManager::P aneFromPoint

Vrátí podokno, které obsahuje daný bod.

virtual CBasePane* PaneFromPoint(
    CPoint point,
    int nSensitivity,
    bool bExactBar = false,
    CRuntimeClass* pRTCBarType = NULL,
    BOOL bCheckVisibility = FALSE,
    const CBasePane* pBarToIgnore = NULL) const;

virtual CBasePane* PaneFromPoint(
    CPoint point,
    int nSensitivity,
    DWORD& dwAlignment,
    CRuntimeClass* pRTCBarType = NULL,
    const CBasePane* pBarToIgnore = NULL) const;

Parametry

Bod
[v] Určuje bod, který se má zkontrolovat, v souřadnicích obrazovky.

NSensitivity
[v] Hodnota, která má nafouknout obdélník okna každého zaškrtnutého podokna. Podokno splňuje kritéria hledání, pokud je daný bod v této nafukované oblasti.

bExactBar
[v] Hodnota TRUE ignoruje parametr nSensitivity , jinak NEPRAVDA.

pRTCBarType
[v] Pokud není null, metoda hledá pouze podokna zadaného typu.

bCheckVisibility
[v] PRAVDA pro kontrolu pouze viditelných podoken; jinak NEPRAVDA.

dwAlignment
[ven] Pokud se v zadaném bodě najde podokno, tento parametr obsahuje stranu podokna, které bylo nejblíže zadanému bodu. Další informace najdete v části Poznámky.

pBarToIgnore
[v] Pokud není null, metoda ignoruje podokna určená tímto parametrem.

Vrácená hodnota

CBasePane odvozený objekt, který obsahuje daný bod, nebo NULL pokud nebyl nalezen žádný podokno.

Poznámky

Když funkce vrátí hodnotu a bylo nalezeno podokno, dwAlignment obsahuje zarovnání zadaného bodu. Pokud byl například bod nejblíže horní části podokna, je hodnota dwAlignment nastavená na CBRS_ALIGN_TOP.

CDockingManager::P rocessPaneContextMenuCommand

Volá se rozhraním, které má zaškrtnout nebo zrušit zaškrtnutí políčka pro zadaný příkaz a přepočítat rozložení zobrazeného podokna.

BOOL ProcessPaneContextMenuCommand(
    UINT nID,
    int nCode,
    void* pExtra,
    AFX_CMDHANDLERINFO* pHandlerInfo);

Parametry

Nid
[v] ID řídicího panelu v nabídce.

nCode
[v] Kód oznámení příkazu.

pExtra
[v] Ukazatel na void, který je přetypován na ukazatel, na CCmdUI pokud nCode je CN_UPDATE_COMMAND_UI.

pHandlerInfo
[v] Ukazatel na informační strukturu. Tento parametr není používán.

Vrácená hodnota

TRUE, pokud pEXtra není NULL a nCode se rovná CN_UPDATE_COMMAND_UI, nebo pokud je řídicí panel se zadaným nID.

CDockingManager::RecalcLayout

Přepočítá vnitřní rozložení ovládacích prvků, které jsou přítomné v seznamu ovládacích prvků.

virtual void RecalcLayout(BOOL bNotify = TRUE);

Parametry

bNotify
[v] Tento parametr se nepoužívá.

CDockingManager::ReleaseEmptyPaneContainers

Uvolní prázdné kontejnery podokna.

void ReleaseEmptyPaneContainers();

CDockingManager::RemoveHiddenMDITabbedBar

Odebere zadané skryté podokno pruhu.

void RemoveHiddenMDITabbedBar(CDockablePane* pBar);

Parametry

pBar
[v] Ukazatel na podokno pruhu, které chcete odebrat.

CDockingManager::RemoveMiniFrame

Odebere zadaný rámec ze seznamu mini snímků.

virtual BOOL RemoveMiniFrame(CPaneFrameWnd* pWnd);

Parametry

pWnd
[v] Ukazatel na rámeček, který chcete odebrat.

Vrácená hodnota

TRUE, pokud je zadaný rámec odebrán; JINAK NEPRAVDA.

CDockingManager::RemovePaneFromDockManager

Zruší registraci podokna a odebere ho ze seznamu ve správci ukotvení.

void RemovePaneFromDockManager(
    CBasePane* pWnd,
    BOOL bDestroy,
    BOOL bAdjustLayout,
    BOOL bAutoHide = FALSE,
    CBasePane* pBarReplacement = NULL);

Parametry

pWnd
[v] Ukazatel na podokno, které chcete odebrat.

bDestroy
[v] Pokud je hodnota TRUE, odstraní se odebrané podokno.

bAdjustLayout
[v] Pokud je hodnota TRUE, upravte rozložení ukotvení okamžitě.

bAutoHide
[v] Pokud je hodnota TRUE, podokno se odebere ze seznamu automaticky skrytých pruhů. Pokud je hodnota FALSE, podokno se odebere ze seznamu běžných podoken.

pBarReplacement
[v] Ukazatel na podokno, které nahrazuje odebrané podokno.

CDockingManager::ReplacePane

Nahradí jedno podokno jiným.

BOOL ReplacePane(
    CDockablePane* pOriginalBar,
    CDockablePane* pNewBar);

Parametry

pOriginalBar
[v] Ukazatel na původní podokno

pNewBar
[v] Ukazatel na podokno, které nahrazuje původní podokno.

Vrácená hodnota

TRUE, pokud je podokno úspěšně nahrazeno; JINAK NEPRAVDA.

CDockingManager::ResortMiniFramesForZOrder

Resorts the frames in the list of mini frames.

void ResortMiniFramesForZOrder();

CDockingManager::SaveState

Uloží stav dokovacího manažera do registru.

virtual BOOL SaveState(
    LPCTSTR lpszProfileName = NULL,
    UINT uiID = (UINT) -1);

Parametry

lpszProfileName
[v] Cesta k klíči registru.

UIID
[v] ID správce ukotvení.

Vrácená hodnota

TRUE, pokud byl stav úspěšně uložen; jinak NEPRAVDA.

Poznámky

Uložení stavu dokujícího manažera do registru zahrnuje uložení stavů ovládacích pruhů, stavů automaticky skrytých pruhů a stavů mini rámců, které jsou přítomné ve správci ukotvení.

CDockingManager::SendMessageToMiniFrames

Odešle zadanou zprávu do všech mini snímků.

BOOL SendMessageToMiniFrames(
    UINT uMessage,
    WPARAM wParam = 0,
    LPARAM lParam = 0);

Parametry

uMessage
[v] Zpráva, která se má odeslat.

wParam
[v] Další informace závislé na zprávě

Lparam
[v] Další informace závislé na zprávě

Vrácená hodnota

Pravda vždy.

CDockingManager::Serialize

Zapíše dokovacího manažera do archivu.

void Serialize(CArchive& ar);

Parametry

ar
[v] Odkaz na archivní objekt.

Poznámky

Zápis správce dokování do archivu zahrnuje určení počtu dokovacích ovládacích pruhů a posuvníků a zápis řídicích pruhů, mini rámců, automaticky skrytých pruhů a panelů karet MDI do archivu.

CDockingManager::SetAutohideZOrder

Nastaví velikost, šířku a výšku ovládacích panelů a zadaného podokna.

void SetAutohideZOrder(CDockablePane* pAHDockingBar);

Parametry

pAHDockingBar
[v] Ukazatel na ukotvené podokno.

CDockingManager::SetDockingMode

Nastaví dokovací režim.

static void SetDockingMode(
    AFX_DOCK_TYPE dockMode,
    AFX_SMARTDOCK_THEME theme = AFX_SDT_DEFAULT);

Parametry

dockMode
Určuje nový režim ukotvení. Další informace najdete v části Poznámky.

Téma
Určuje motiv, který se má použít pro inteligentní dokovací značky. Může to být jedna z následujících výčtových hodnot: AFX_SDT_DEFAULT, AFX_SDT_VS2005, AFX_SDT_VS2008.

Poznámky

Voláním této statické metody nastavíte režim ukotvení.

dockMode může být jedna z následujících hodnot:

  • DT_STANDARD – standardní dokovací režim, jak je implementovaný v sadě Visual Studio .NET 2003. Podokna se přetahují bez přetahování kontextu.

  • DT_IMMEDIATE – režim okamžitého ukotvení, jak je implementovaný v aplikaci Microsoft Visio. Podokna se přetahují s kontextem přetažení, ale nezobrazují se žádné značky.

  • DT_SMART – inteligentní dokovací režim, jak je implementovaný v sadě Visual Studio 2005. Podokna se přetahují s kontextem přetažení a inteligentními značkami se zobrazují, kde se dá podokno ukotvit.

CDockingManager::SetDockState

Nastaví dokovací stav řídicích pruhů, mini rámečků a automaticky skrytých pruhů.

virtual void SetDockState();

CDockingManager::SetPrintPreviewMode

Nastaví režim náhledu tisku pruhů zobrazených v náhledu tisku.

void SetPrintPreviewMode(
    BOOL bPreview,
    CPrintPreviewState* pState);

Parametry

bPreview
[v] TRUE, pokud je nastaven režim náhledu tisku; JINAK NEPRAVDA.

pState
[v] Ukazatel na stav náhledu Tento parametr není používán.

CDockingManager::SetSmartDockingParams

Nastaví parametry, které definují chování inteligentního ukotvení.

static void SetSmartDockingParams(CSmartDockingInfo& params);

Parametry

params
[in, out] Definuje parametry pro inteligentní dokování.

Poznámky

Tuto metodu zavolejte, pokud chcete přizpůsobit vzhled, barvu nebo tvar inteligentních dokovacích značek.

Pokud chcete použít výchozí vyhledávání inteligentních dokovacích značek, předejte neinicializovanou instanci CSmartDockingInfo Třídy params.

CDockingManager::ShowDelayShowMiniFrames

Zobrazí nebo skryje okna mini rámečků.

void ShowDelayShowMiniFrames(BOOL bshow);

Parametry

BShow
[v] TRUE, aby okno zobrazeného rámečku aktivní; NEPRAVDA pro skrytí okna rámečku

CDockingManager::ShowPanes

Zobrazí nebo skryje podokna ovládacího prvku a automaticky se zobrazí pruhy.

virtual BOOL ShowPanes(BOOL bShow);

Parametry

BShow
[v] TRUE pro zobrazení podoken; NEPRAVDA pro skrytí podoken.

Vrácená hodnota

Vždy NEPRAVDA.

CDockingManager::StartSDocking

Spustí inteligentní dokování zadaného okna podle zarovnání správce inteligentního dokování.

void StartSDocking(CWnd* pDockingWnd);

Parametry

pDockingWnd
[v] Ukazatel na okno pro ukotvení

CDockingManager::StopSDocking

Zastaví inteligentní dokování.

void StopSDocking();

CDockingManager::GetSmartDockingTheme

Statická metoda, která vrací motiv použitý k zobrazení inteligentních dokovacích značek.

static AFX_SMARTDOCK_THEME __stdcall GetSmartDockingTheme();

Vrácená hodnota

Vrátí jednu z následujících výčtových hodnot: AFX_SDT_DEFAULT, AFX_SDT_VS2005, AFX_SDT_VS2008.

Poznámky

Viz také

Graf hierarchie
Třídy
CObject – třída
CFrameWndEx – třída
CDockablePane – třída
CPaneFrameWnd – třída