Kelas CDockingManager

  • Artikel

Menerapkan fungsionalitas inti yang mengontrol tata letak docking di jendela bingkai utama.

Sintaks

class CDockingManager : public CObject

Anggota

Metode Publik

Nama Deskripsi
CDockingManager::AddDockSite Membuat panel dock dan menambahkannya ke daftar bilah kontrol.
CDockingManager::AddHiddenMDITabbedBar Menambahkan handel ke panel bilah ke daftar panel bilah bertab MDI tersembunyi.
CDockingManager::AddMiniFrame Menambahkan bingkai ke daftar bingkai mini.
CDockingManager::AddPane Mendaftarkan panel dengan manajer docking.
CDockingManager::AdjustDockingLayout Menghitung ulang dan menyesuaikan tata letak semua panel dalam jendela bingkai.
CDockingManager::AdjustPaneFrames Menyebabkan pesan WM_NCCALCSIZE dikirim ke semua panel dan CPaneFrameWnd jendela.
CDockingManager::AdjustRectToClientArea Menyesuaikan perataan persegi panjang.
CDockingManager::AlignAutoHidePane Mengubah ukuran panel docking dalam mode autohide sehingga dibutuhkan lebar penuh atau tinggi area klien bingkai yang dikelilingi oleh situs dock.
CDockingManager::AutoHidePane Membuat toolbar autohide.
CDockingManager::BringBarsToTop Membawa bilah bertampel yang memiliki perataan yang ditentukan ke bagian atas.
CDockingManager::BuildPanesMenu Menambahkan nama panel docking dan toolbar ke menu.
CDockingManager::CalcExpectedDockedRect Menghitung persegi panjang yang diharapkan dari jendela yang ditambakan.
CDockingManager::Create Membuat manajer docking.
CDockingManager::D eterminePaneAndStatus Menentukan panel yang berisi titik tertentu dan status docking-nya.
CDockingManager::D isableRestoreDockState Mengaktifkan atau menonaktifkan pemuatan tata letak docking dari registri.
CDockingManager::D ockPane Menambungkan panel ke panel lain atau ke jendela bingkai.
CDockingManager::D ockPaneLeftOf Menambungkan panel di sebelah kiri panel lain.
CDockingManager::EnableAutoHidePanes Mengaktifkan docking panel ke bingkai utama, membuat panel dock, dan menambahkannya ke daftar bilah kontrol.
CDockingManager::EnableDocking Membuat panel dock dan memungkinkan docking panel ke bingkai utama.
CDockingManager::EnableDockSiteMenu Menampilkan tombol tambahan yang membuka menu pop-up pada keterangan semua panel docking.
CDockingManager::EnablePaneContextMenu Memberi tahu pustaka untuk menampilkan menu konteks khusus yang memiliki daftar bilah alat aplikasi dan panel docking saat pengguna mengklik tombol kanan mouse dan pustaka sedang memproses pesan WM_CONTEXTMENU.
CDockingManager::FindDockSite Mengambil panel bilah yang berada pada posisi yang ditentukan dan yang memiliki perataan yang ditentukan.
CDockingManager::FindDockSiteByPane Mengembalikan panel bilah yang memiliki id panel bilah target.
CDockingManager::FindPaneByID Menemukan panel menurut ID kontrol yang ditentukan.
CDockingManager::FixupVirtualRects Menerapkan semua posisi bilah alat saat ini ke persegi virtual.
CDockingManager::FrameFromPoint Mengembalikan bingkai yang berisi titik yang diberikan.
CDockingManager::GetClientAreaBounds Mendapatkan persegi panjang yang berisi batas area klien.
CDockingManager::GetDockingMode Mengembalikan mode docking saat ini.
CDockingManager::GetDockSiteFrameWnd Mendapatkan penunjuk ke bingkai jendela induk.
CDockingManager::GetEnabledAutoHideAlignment Mengembalikan perataan panel yang diaktifkan.
CDockingManager::GetMiniFrames Mendapatkan daftar miniframe.
CDockingManager::GetOuterEdgeBounds Mendapatkan persegi panjang yang berisi tepi luar bingkai.
CDockingManager::GetPaneList Mengembalikan daftar panel milik manajer docking. Ini termasuk semua panel mengambang.
CDockingManager::GetSmartDockingManager Mengambil penunjuk ke manajer docking pintar.
CDockingManager::GetSmartDockingManagerPermanent Mengambil penunjuk ke manajer docking pintar.
CDockingManager::GetSmartDockingParams Mengembalikan parameter docking pintar untuk manajer docking.
CDockingManager::GetSmartDockingTheme Metode statis yang mengembalikan tema yang digunakan untuk menampilkan penanda docking pintar.
CDockingManager::HideAutoHidePanes Menyembunyikan panel yang dalam mode autohide.
CDockingManager::InsertDockSite Membuat panel dock dan menyisipkannya ke dalam daftar bilah kontrol.
CDockingManager::InsertPane Menyisipkan panel kontrol ke dalam daftar bilah kontrol.
CDockingManager::IsDockSiteMenu Menentukan apakah menu pop-up ditampilkan pada keterangan semua panel.
CDockingManager::IsInAdjustLayout Menentukan apakah tata letak semua panel disesuaikan.
CDockingManager::IsOLEContainerMode Menentukan apakah manajer docking berada dalam mode kontainer OLE.
CDockingManager::IsPointNearDockSite Menentukan apakah titik yang ditentukan berada di dekat situs dok.
CDockingManager::IsPrintPreviewValid Menentukan apakah mode pratinjau cetak diatur.
CDockingManager::LoadState Memuat status manajer docking dari registri.
CDockingManager::LockUpdate Mengunci jendela yang diberikan.
CDockingManager::OnActivateFrame Dipanggil oleh kerangka kerja ketika jendela bingkai dibuat aktif atau dinonaktifkan.
CDockingManager::OnClosePopupMenu Dipanggil oleh kerangka kerja saat menu pop-up aktif memproses pesan WM_DESTROY.
CDockingManager::OnMoveMiniFrame Dipanggil oleh kerangka kerja untuk memindahkan jendela bingkai mini.
CDockingManager::OnPaneContextMenu Dipanggil oleh kerangka kerja saat membangun menu yang memiliki daftar panel.
CDockingManager::P aneFromPoint Mengembalikan panel yang berisi titik yang diberikan.
CDockingManager::P rocessPaneContextMenuCommand Dipanggil oleh kerangka kerja untuk memilih atau menghapus kotak centang untuk perintah yang ditentukan dan menghitung ulang tata letak panel yang diperlihatkan.
CDockingManager::RecalcLayout Menghitung ulang tata letak internal kontrol yang ada dalam daftar kontrol.
CDockingManager::ReleaseEmptyPaneContainers Merilis kontainer panel kosong.
CDockingManager::RemoveHiddenMDITabbedBar Menghapus panel bilah tersembunyi yang ditentukan.
CDockingManager::RemoveMiniFrame Menghapus bingkai tertentu dari daftar bingkai mini.
CDockingManager::RemovePaneFromDockManager Membatalkan pendaftaran panel dan menghapusnya dari daftar di manajer docking.
CDockingManager::ReplacePane Mengganti satu panel dengan panel lainnya.
CDockingManager::ResortMiniFramesForZOrder Menggunakan bingkai dalam daftar bingkai mini.
CDockingManager::SaveState Menyimpan status manajer docking ke registri.
CDockingManager::SendMessageToMiniFrames Mengirim pesan yang ditentukan ke semua bingkai mini.
CDockingManager::Serialize Menulis manajer docking ke arsip. (Penimpaan CObject::Serialize.)
CDockingManager::SetAutohideZOrder Mengatur ukuran, lebar, dan tinggi bilah kontrol dan panel yang ditentukan.
CDockingManager::SetDockingMode Mengatur mode docking.
CDockingManager::SetDockState Mengatur status docking bilah kontrol, bingkai mini, dan bilah autohide.
CDockingManager::SetPrintPreviewMode Mengatur mode pratinjau cetak bilah yang ditampilkan dalam pratinjau cetak.
CDockingManager::SetSmartDockingParams Mengatur parameter yang menentukan perilaku docking pintar.
CDockingManager::ShowDelayShowMiniFrames Menampilkan atau menyembunyikan jendela bingkai mini.
CDockingManager::ShowPanes Memperlihatkan atau menyembunyikan panel bilah kontrol dan autohide.
CDockingManager::StartSDocking Memulai docking pintar dari jendela yang ditentukan sesuai dengan penyelarasan manajer docking pintar.
CDockingManager::StopsDocking Berhenti docking pintar.

Anggota Data

Nama Deskripsi
CDockingManager::m_bHideDockingBarsInContainerMode Menentukan apakah manajer docking menyembunyikan panel dalam mode kontainer OLE.
CDockingManager::m_dockModeGlobal Menentukan mode docking global.
CDockingManager::m_nDockSensitivity Menentukan sensitivitas docking.
CDockingManager::m_nTimeOutBeforeDockingBarDock Menentukan waktu, dalam milidetik, sebelum panel docking ditautkan dalam mode docking langsung.
CDockingManager::m_nTimeOutBeforeToolBarDock Menentukan waktu, dalam milidetik, sebelum toolbar ditambatkan ke jendela bingkai utama.

Keterangan

Jendela bingkai utama membuat dan menginisialisasi kelas ini secara otomatis.

Objek manajer docking menyimpan daftar semua panel yang berada di tata letak docking, dan juga daftar semua jendela CPaneFrameWnd yang termasuk dalam jendela bingkai utama.

Kelas CDockingManager mengimplementasikan beberapa layanan yang dapat Anda gunakan untuk menemukan panel atau CPaneFrameWnd jendela. Anda biasanya tidak memanggil layanan ini secara langsung karena dibungkus dalam objek jendela bingkai utama. Untuk informasi selengkapnya, lihat Kelas CPaneFrameWnd.

Tips Kustomisasi

Tips berikut berlaku untuk CDockingManager objek:

Contoh

Contoh berikut menunjukkan cara menggunakan berbagai metode di CDockingManager kelas untuk mengonfigurasi CDockingManager objek. Contoh menunjukkan cara menampilkan tombol tambahan yang membuka menu pop-up pada keterangan semua panel docking dan cara mengatur mode docking objek. Cuplikan kode ini adalah bagian dari sampel Demo Visual Studio.

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

Hierarki Warisan

CObject

CDockingManager

Persyaratan

Header: afxDockingManager.h

CDockingManager::AddDockSite

Membuat panel dock dan menambahkannya ke daftar bilah kontrol.

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

Parameter

info
[di] Referensi ke struktur info yang berisi perataan panel dok.

ppDockBar
[out] Penunjuk ke penunjuk ke panel dock baru.

Tampilkan Nilai

TRUE jika panel dock berhasil dibuat; FALSE jika tidak.

CDockingManager::AddHiddenMDITabbedBar

Menambahkan handel ke panel bilah ke daftar panel bilah bertab MDI tersembunyi.

void AddHiddenMDITabbedBar(CDockablePane* pBar);

Parameter

pBar
[di] Penunjuk ke panel bilah

CDockingManager::AddPane

Mendaftarkan panel dengan manajer docking.

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

Parameter

pWnd
[masuk, keluar] Menentukan panel untuk ditambahkan ke manajer docking.

bTail
[di] TRUE untuk menambahkan panel ke akhir daftar panel untuk manajer docking; jika tidak, FALSE.

bAutoHide
[di] Hanya untuk penggunaan internal. Selalu gunakan nilai default FALSE.

bInsertForOuterEdge
[di] Hanya untuk penggunaan internal. Selalu gunakan nilai default FALSE.

Tampilkan Nilai

TRUE jika panel berhasil didaftarkan dengan manajer docking; jika tidak, FALSE.

Keterangan

Panggil metode ini untuk mendaftarkan panel yang tidak mengambang dan tidak dapat diubah namanya dengan manajer docking. Jika Anda tidak mendaftarkan panel, panel tersebut tidak akan muncul dengan benar saat manajer docking ditata.

CDockingManager::AdjustDockingLayout

Menghitung ulang dan menyesuaikan tata letak semua panel dalam jendela bingkai.

virtual void AdjustDockingLayout(HDWP hdwp = NULL);

Parameter

hdwp
[di] Menentukan struktur posisi jendela yang ditangguhkan. Untuk informasi selengkapnya, lihat Jenis Data Windows.

Keterangan

CDockingManager::AddMiniFrame

Menambahkan bingkai ke daftar bingkai mini.

virtual BOOL AddMiniFrame(CPaneFrameWnd* pWnd);

Parameter

pWnd
[di] Penunjuk ke bingkai.

Tampilkan Nilai

TRUE jika bingkai tidak ada dalam daftar bingkai mini dan berhasil ditambahkan; FALSE jika tidak.

CDockingManager::AdjustPaneFrames

Menyebabkan pesan WM_NCCALCSIZE dikirim ke semua panel dan CPaneFrameWnd jendela.

virtual void AdjustPaneFrames();

Keterangan

CDockingManager::AdjustRectToClientArea

Menyesuaikan perataan persegi panjang.

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

Parameter

rectResult
[di] Referensi ke CRect objek

dwAlignment
[di] Perataan CRect objek

Tampilkan Nilai

TRUE jika perataan CRect objek disesuaikan; FALSE jika tidak.

Keterangan

Parameter dwAlignment dapat memiliki salah satu nilai berikut:

  • CBRS_ALIGN_TOP

  • CBRS_ALIGN_BOTTOM

  • CBRS_ALIGN_LEFT

  • CBRS_ALIGN_RIGHT

CDockingManager::AlignAutoHidePane

Mengubah ukuran panel docking dalam mode autohide sehingga dibutuhkan lebar penuh atau tinggi area klien bingkai yang dikelilingi oleh situs dock.

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

Parameter

pDefaultSlider
[di] Panel slider docking.

bIsVisible
[di] TRUE jika panel docking terlihat; FALSE jika tidak.

CDockingManager::AutoHidePane

Membuat toolbar autohide.

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

Parameter

pBar
[di] Penunjuk ke panel bilah.

pCurrAutoHideToolBar
[di] Penunjuk ke bilah alat sembunyi otomatis.

Tampilkan Nilai

NULL jika bilah alat sembunyi otomatis tidak dibuat; jika tidak, penunjuk ke toolbar baru.

CDockingManager::BringBarsToTop

Membawa bilah bertampel yang memiliki perataan yang ditentukan ke bagian atas.

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

Parameter

dwAlignment
[di] Penyelarasan bilah dermaga yang dibawa ke bagian atas jendela lain.

bExcludeDockedBars
[di] TRUE untuk mengecualikan bilah yang ditambatkan agar tidak berada di atas; jika tidak FALSE.

CDockingManager::BuildPanesMenu

Menambahkan nama panel docking dan toolbar ke menu.

void BuildPanesMenu(
    CMenu& menu,
    BOOL bToolbarsOnly);

Parameter

menu
[di] Menu untuk menambahkan nama panel docking dan toolbar.

bToolbarsOnly
[di] TRUE untuk menambahkan hanya nama toolbar ke menu; FALSE jika tidak.

CDockingManager::CalcExpectedDockedRect

Menghitung persegi panjang yang diharapkan dari jendela yang ditambakan.

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

Parameter

pWnd
[di] Penunjuk ke jendela untuk menambungkan.

ptMouse
[di] Lokasi mouse.

rectResult
[out] Persegi panjang terhitung.

bDrawTab
[di] TRUE untuk menggambar tab; jika tidak FALSE.

ppTargetBar
[out] Penunjuk ke penunjuk ke panel target.

Keterangan

Metode ini menghitung persegi panjang yang akan ditempati oleh jendela jika pengguna menyeret jendela ke titik yang ditentukan oleh ptMouse dan menambatkannya di sana.

CDockingManager::Create

Membuat manajer docking.

BOOL Create(CFrameWnd* pParentWnd);

Parameter

pParentWnd
[di] Penunjuk ke bingkai induk manajer docking. Nilai ini tidak boleh NULL.

Tampilkan Nilai

TRUE selalu.

CDockingManager::D eterminePaneAndStatus

Menentukan panel yang berisi titik tertentu dan status docking-nya.

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

Parameter

Pt
[di] Lokasi panel untuk diperiksa.

nSensitivitas
[di] Nilai untuk meningkatkan persegi panjang jendela dari setiap panel yang dicentang. Panel memenuhi kriteria pencarian jika titik yang diberikan berada di wilayah yang ditingkatkan ini.

dwEnabledAlignment
[di] Perataan panel docking.

ppTargetBar
[out] Penunjuk ke penunjuk ke panel target.

pBarToIgnore
[di] Panel yang diabaikan metode.

pBarToDock
[di] Panel yang ditampung.

Tampilkan Nilai

Status docking.

Keterangan

Status docking bisa menjadi salah satu nilai berikut:

nilai AFX_CS_STATUS Makna
CS_NOTHING Penunjuk tidak melebihi situs dok. Oleh karena itu, buat panel tetap mengambang.
CS_DOCK_IMMEDIATELY Penunjuk berada di atas situs dock dalam mode langsung (gaya DT_IMMEDIATE diaktifkan), sehingga panel harus segera ditampung.
CS_DELAY_DOCK Penunjuk berada di atas situs dock yang merupakan panel docking lain atau merupakan tepi bingkai utama.
CS_DELAY_DOCK_TO_TAB Penunjuk berada di atas situs dock yang menyebabkan panel ditautkan di jendela bertab. Ini terjadi ketika mouse melebihi keterangan panel docking lain atau di atas area tab panel bertab.

CDockingManager::D isableRestoreDockState

Mengaktifkan atau menonaktifkan pemuatan tata letak docking dari registri.

void DisableRestoreDockState(BOOL bDisable = TRUE);

Parameter

bDisable
[di] TRUE untuk menonaktifkan pemuatan tata letak docking dari registri; jika tidak, FALSE.

Keterangan

Panggil metode ini saat Anda harus mempertahankan tata letak panel dan toolbar docking saat status aplikasi dimuat.

CDockingManager::D ockPane

Menambungkan panel ke panel lain atau ke jendela bingkai.

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

Parameter

pBar
[di] Penunjuk ke panel bilah untuk ditampung.

nDockBarID
[di] Id bilah untuk berlabuh.

lpRect
[di] Persegi panjang tujuan.

CDockingManager::D ockPaneLeftOf

Menambungkan panel di sebelah kiri panel lain.

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

Parameter

pBarToDock
[di] Penunjuk ke panel yang akan ditambatkan ke sebelah kiri pTargetBar.

pTargetBar
[di] Penunjuk ke panel target.

Tampilkan Nilai

TRUE jika panel berhasil di-dock; jika tidak, FALSE.

CDockingManager::EnableAutoHidePanes

Mengaktifkan docking panel ke bingkai utama, membuat panel dock, dan menambahkannya ke daftar bilah kontrol.

BOOL EnableAutoHidePanes(DWORD dwStyle);

Parameter

dwStyle
[di] Perataan docking.

Tampilkan Nilai

TRUE jika panel dock berhasil dibuat; FALSE jika tidak.

CDockingManager::EnableDocking

Membuat panel dock dan memungkinkan docking panel ke bingkai utama.

BOOL EnableDocking(DWORD dwStyle);

Parameter

dwStyle
[di] Perataan docking.

Tampilkan Nilai

TRUE jika panel dock berhasil dibuat; FALSE jika tidak.

CDockingManager::EnableDockSiteMenu

Menampilkan tombol tambahan yang membuka menu pop-up pada keterangan semua panel docking.

static void EnableDockSiteMenu(BOOL bEnable = TRUE);

Parameter

bEnable
[di] TRUE untuk mengaktifkan menu situs dok; jika tidak, FALSE.

Keterangan

Menu situs dok menampilkan opsi berikut untuk mengubah status dok panel:

  • Floating - Mengambangkan panel

  • Docking - Menambak panel di bingkai utama di lokasi tempat panel terakhir ditambatkan

  • AutoHide - Mengalihkan panel ke mode autohide

  • Hide - Menyembunyikan panel

Secara default, menu ini tidak ditampilkan.

CDockingManager::EnablePaneContextMenu

Memberi tahu pustaka untuk menampilkan menu konteks khusus yang memiliki daftar bilah alat aplikasi dan panel docking saat pengguna mengklik tombol kanan mouse dan pustaka sedang memproses pesan WM_CONTEXTMENU.

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

Parameter

bEnable
[di] Jika TRUE, pustaka akan mengaktifkan dukungan untuk menu konteks otomatis; jika FALSE, pustaka menonaktifkan dukungan untuk menu konteks otomatis.

uiCustomizeCmd
[di] Id perintah untuk item Kustomisasi di menu.

strCustomizeText
[di] Teks item Kustomisasi .

bToolbarsOnly
[di] Jika TRUE, menu hanya menampilkan daftar toolbar aplikasi; jika FALSE, pustaka menambahkan panel docking aplikasi ke daftar ini.

CDockingManager::FindDockSite

Mengambil panel bilah yang berada pada posisi yang ditentukan dan yang memiliki perataan yang ditentukan.

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

Parameter

dwAlignment
[di] Perataan panel bilah.

bOuter
[di] Jika TRUE, ambil bilah di posisi kepala dalam daftar bilah kontrol. Jika tidak, ambil bilah di posisi ekor dalam daftar bilah kontrol.

Tampilkan Nilai

Panel docking yang memiliki perataan yang ditentukan; NULL sebaliknya.

CDockingManager::FindPaneByID

Menemukan panel menurut ID kontrol yang ditentukan.

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

Parameter

uBarID
[di] Menentukan ID kontrol panel yang akan ditemukan.

bSearchMiniFrames
[di] TRUE untuk menyertakan semua panel mengambang dalam pencarian. FALSE untuk hanya menyertakan panel yang ditampar.

Tampilkan Nilai

Objek CBasePane yang memiliki ID kontrol yang ditentukan, atau NULL jika panel yang ditentukan tidak dapat ditemukan.

Keterangan

CDockingManager::FindDockSiteByPane

Mengembalikan panel bilah yang memiliki id panel bilah target.

virtual CDockSite* FindDockSiteByPane(CPane* pTargetBar);

Parameter

pTargetBar
[di] Penunjuk ke panel bilah target.

Tampilkan Nilai

Panel bilah yang memiliki id panel bilah target; NULL jika tidak ada panel bilah tersebut.

CDockingManager::FixupVirtualRects

Menerapkan semua posisi bilah alat saat ini ke persegi virtual.

virtual void FixupVirtualRects();

Keterangan

Ketika pengguna mulai menyeret toolbar, aplikasi mengingat posisi aslinya di persegi panjang virtual. Ketika pengguna memindahkan toolbar di seluruh situs dock-nya, toolbar dapat menggeser bilah alat lain. Posisi asli toolbar lain disimpan dalam persegi panjang virtual yang sesuai.

CDockingManager::FrameFromPoint

Mengembalikan bingkai yang berisi titik yang diberikan.

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

Parameter

Pt
[di] Menentukan titik, dalam koordinat layar, untuk memeriksa.

pFrameToExclude
[di] Penunjuk ke bingkai untuk dikecualikan.

bFloatMultiOnly
[di] TRUE untuk mengecualikan bingkai yang bukan instans ; CMultiPaneFrameWnd FALSE jika tidak.

Tampilkan Nilai

Bingkai yang berisi titik yang diberikan; NULL sebaliknya.

CDockingManager::GetClientAreaBounds

Mendapatkan persegi panjang yang berisi batas area klien.

CRect GetClientAreaBounds() const;

void GetClientAreaBounds(CRect& rcClient);

Parameter

rcClient
[out] Referensi ke persegi panjang yang berisi batas area klien.

Tampilkan Nilai

Persegi panjang yang berisi batas area klien.

CDockingManager::GetDockingMode

Mengembalikan mode docking saat ini.

static AFX_DOCK_TYPE GetDockingMode();

Tampilkan Nilai

Nilai enumerator yang mewakili mode docking saat ini. Jenis dapat berupa salah satu dari nilai berikut:

  • DT_STANDARD

  • DT_IMMEDIATE

  • DT_SMART

Keterangan

Untuk mengatur mode docking, panggil CDockingManager::SetDockingMode.

CDockingManager::GetDockSiteFrameWnd

Mendapatkan penunjuk ke bingkai jendela induk.

CFrameWnd* GetDockSiteFrameWnd() const;

Tampilkan Nilai

Penunjuk ke bingkai jendela induk.

CDockingManager::GetEnabledAutoHideAlignment

Mengembalikan perataan panel yang diaktifkan.

DWORD GetEnabledAutoHideAlignment() const;

Tampilkan Nilai

Kombinasi bitwise dari bendera CBRS_ALIGN_, atau 0 jika panel autohide tidak diaktifkan. Untuk informasi selengkapnya, lihat CFrameWnd::EnableDocking.

Keterangan

Metode mengembalikan perataan yang diaktifkan untuk bilah kontrol autohide. Untuk mengaktifkan bilah autohide, panggil CFrameWndEx::EnableAutoHidePanes.

CDockingManager::GetMiniFrames

Mendapatkan daftar miniframe.

const CObList& GetMiniFrames() const;

Tampilkan Nilai

Daftar miniframe yang berisi bilah kontrol milik manajer docking.

CDockingManager::GetOuterEdgeBounds

Mendapatkan persegi panjang yang berisi tepi luar bingkai.

CRect GetOuterEdgeBounds() const;

Tampilkan Nilai

Persegi panjang yang berisi tepi luar bingkai.

CDockingManager::GetPaneList

Mengembalikan daftar panel milik manajer docking. Ini termasuk semua panel mengambang.

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

Parameter

lstBars
[masuk, keluar] Berisi semua panel manajer docking saat ini.

bIncludeAutohide
[di] TRUE untuk menyertakan panel yang berada dalam mode autohide; jika tidak, FALSE.

pRTCFilter
[di] Jika bukan NULL, daftar yang dikembalikan hanya berisi panel dari kelas runtime yang ditentukan.

bIncludeTabs
[di] TRUE untuk menyertakan tab; jika tidak, FALSE.

Keterangan

Jika ada panel bertab di manajer docking, metode mengembalikan penunjuk ke objek Kelas CBaseTabbedPane dan Anda harus menghitung tab secara eksplisit.

Gunakan pRTCFilter untuk mendapatkan kelas panel tertentu. Misalnya, Anda hanya dapat memperoleh toolbar dengan mengatur nilai ini dengan tepat.

CDockingManager::GetSmartDockingManager

Mengambil penunjuk ke manajer docking pintar.

CSmartDockingManager* GetSmartDockingManager();

Tampilkan Nilai

Penunjuk ke manajer docking pintar.

CDockingManager::GetSmartDockingManagerPermanent

Mengambil penunjuk ke manajer docking pintar.

CSmartDockingManager* GetSmartDockingManagerPermanent() const;

Tampilkan Nilai

Penunjuk ke manajer docking pintar.

CDockingManager::GetSmartDockingParams

Mengembalikan parameter docking pintar untuk manajer docking.

static CSmartDockingInfo& GetSmartDockingParams();

Tampilkan Nilai

Kelas yang berisi parameter docking pintar untuk manajer docking saat ini. Untuk informasi selengkapnya, lihat Kelas CSmartDockingInfo.

Keterangan

CDockingManager::HideAutoHidePanes

Menyembunyikan panel yang dalam mode autohide.

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

Parameter

pBarToExclude
[di] Penunjuk ke bilah untuk dikecualikan dari persembunyian.

bImmediately
[di] TRUE untuk segera menyembunyikan panel; FALSE untuk menyembunyikan panel dengan efek autohide.

CDockingManager::InsertDockSite

Membuat panel dock dan menyisipkannya ke dalam daftar bilah kontrol.

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

Parameter

info
[di] Struktur yang berisi informasi perataan tentang panel dock.

dwAlignToInsertAfter
[di] Perataan panel dock.

ppDockBar
[out] Penunjuk ke penunjuk ke panel dock.

Tampilkan Nilai

TRUE jika panel dock berhasil dibuat; FALSE jika tidak.

CDockingManager::InsertPane

Menyisipkan panel kontrol ke dalam daftar bilah kontrol.

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

Parameter

pControlBar
[di] Penunjuk ke panel kontrol.

pTarget
[di] Penunjuk ke panel target.

bAfter
[di] TRUE untuk menyisipkan panel setelah posisi panel target; FALSE jika tidak.

Tampilkan Nilai

TRUE jika panel kontrol berhasil ditambahkan ke daftar bilah kontrol; FALSE jika tidak.

Keterangan

Metode ini mengembalikan false jika panel kontrol sudah ada dalam daftar bilah kontrol atau jika panel target tidak ada dalam daftar bilah kontrol.

CDockingManager::IsDockSiteMenu

Menentukan apakah menu pop-up ditampilkan pada keterangan semua panel.

static BOOL IsDockSiteMenu();

Tampilkan Nilai

TRUE jika menu situs dok ditampilkan pada keterangan semua panel docking; jika tidak FALSE.

Keterangan

Anda dapat mengaktifkan menu situs dock dengan memanggil CDockingManager::EnableDockSiteMenu.

CDockingManager::IsInAdjustLayout

Menentukan apakah tata letak semua panel disesuaikan.

BOOL IsInAdjustLayout() const;

Tampilkan Nilai

TRUE jika tata letak semua panel disesuaikan; FALSE jika tidak.

CDockingManager::IsOLEContainerMode

Menentukan apakah manajer docking berada dalam mode kontainer OLE.

BOOL IsOLEContainerMode() const;

Tampilkan Nilai

TRUE jika manajer docking berada dalam mode kontainer OLE; jika tidak, FALSE.

Keterangan

Dalam mode kontainer OLE, semua panel docking dan toolbar aplikasi disembunyikan. Panel juga disembunyikan dalam mode ini jika Anda telah mengatur CDockingManager::m_bHideDockingBarsInContainerMode ke TRUE.

CDockingManager::IsPointNearDockSite

Menentukan apakah titik yang ditentukan berada di dekat situs dok.

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

Parameter

Titik
[di] Titik yang ditentukan.

dwBarAlignment
[out] Menentukan tepi mana yang titiknya dekat. Nilai yang mungkin CBRS_ALIGN_LEFT, CBRS_ALIGN_RIGHT, CBRS_ALIGN_TOP, dan CBRS_ALIGN_BOTTOM.

bOuterEdge
[out] TRUE jika titik berada di dekat batas luar situs dok; FALSE jika tidak.

Tampilkan Nilai

TRUE jika titik berada di dekat situs dok; jika tidak FALSE.

CDockingManager::IsPrintPreviewValid

Menentukan apakah mode pratinjau cetak diatur.

BOOL IsPrintPreviewValid() const;

Tampilkan Nilai

TRUE jika mode pratinjau cetak diatur; FALSE jika tidak.

CDockingManager::LoadState

Memuat status manajer docking dari registri.

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

Parameter

lpszProfileName
[di] Nama profil.

uiID
[di] Id manajer docking.

Tampilkan Nilai

TRUE jika status manajer docking berhasil dimuat; jika tidak FALSE.

CDockingManager::LockUpdate

Mengunci jendela yang diberikan.

void LockUpdate(BOOL bLock);

Parameter

Blok
[di] TRUE jika jendela dikunci; FALSE jika tidak.

Keterangan

Ketika jendela dikunci, jendela tidak dapat dipindahkan dan tidak dapat digambar ulang.

CDockingManager::m_bHideDockingBarsInContainerMode

Menentukan apakah manajer docking menyembunyikan panel dalam mode kontainer OLE.

AFX_IMPORT_DATA static BOOL m_bHideDockingBarsInContainerMode;

Keterangan

Atur nilai ini ke FALSE jika Anda ingin menyimpan semua panel yang ditambatkan ke bingkai utama yang terlihat saat aplikasi berada dalam mode kontainer OLE. Secara default, nilai ini ADALAH TRUE.

CDockingManager::m_dockModeGlobal

Menentukan mode docking global.

AFX_IMPORT_DATA static AFX_DOCK_TYPE m_dockModeGlobal;

Keterangan

Secara default, setiap panel docking menggunakan mode docking ini. Untuk informasi selengkapnya tentang nilai yang dapat diatur ke bidang ini, lihat CBasePane::GetDockingMode.

CDockingManager::m_nDockSensitivity

Menentukan sensitivitas docking.

AFX_IMPORT_DATA static int m_nDockSensitivity;

Keterangan

Sensitivitas docking menentukan seberapa dekat panel mengambang dapat mendekati panel docking, situs docking, atau panel lain sebelum kerangka kerja mengubah statusnya untuk ditambatkan.

CDockingManager::m_nTimeOutBeforeDockingBarDock

Menentukan waktu, dalam milidetik, sebelum panel docking ditautkan dalam mode docking langsung.

static UINT m_nTimeOutBeforeDockingBarDock;

Keterangan

Sebelum panel ditambatkan, kerangka kerja menunggu lama waktu yang ditentukan. Ini mencegah panel ditampar secara tidak sengaja ke lokasi saat pengguna masih menyeretnya.

CDockingManager::m_nTimeOutBeforeToolBarDock

Menentukan waktu, dalam milidetik, sebelum toolbar ditambatkan ke jendela bingkai utama.

static UINT m_nTimeOutBeforeToolBarDock;

Keterangan

Sebelum toolbar ditambatkan, kerangka kerja menunggu durasi waktu yang ditentukan. Ini mencegah toolbar ditampar secara tidak sengaja ke lokasi saat pengguna masih menyeretnya.

CDockingManager::OnActivateFrame

Dipanggil oleh kerangka kerja ketika jendela bingkai dibuat aktif atau dinonaktifkan.

virtual void OnActivateFrame(BOOL bActivate);

Parameter

bActivate
[di] Jika TRUE, jendela bingkai dibuat aktif; jika FALSE, jendela bingkai dinonaktifkan.

CDockingManager::OnClosePopupMenu

Dipanggil oleh kerangka kerja saat menu pop-up aktif memproses pesan WM_DESTROY.

void OnClosePopupMenu();

Keterangan

Kerangka kerja mengirim pesan WM_DESTROY ketika akan menutup jendela utama saat ini. Ambil alih metode ini untuk menangani pemberitahuan dari CMFCPopupMenu objek yang termasuk dalam jendela bingkai saat CMFCPopupMenu objek memproses pesan WM_DESTROY.

CDockingManager::OnMoveMiniFrame

Dipanggil oleh kerangka kerja untuk memindahkan jendela bingkai mini.

virtual BOOL OnMoveMiniFrame(CWnd* pFrame);

Parameter

pFrame
[di] Penunjuk ke jendela bingkai mini.

Tampilkan Nilai

TRUE jika metode berhasil; jika tidak FALSE.

CDockingManager::OnPaneContextMenu

Dipanggil oleh kerangka kerja saat membangun menu yang memiliki daftar panel.

void OnPaneContextMenu(CPoint point);

Parameter

Titik
[di] Menentukan lokasi menu.

CDockingManager::P aneFromPoint

Mengembalikan panel yang berisi titik yang diberikan.

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;

Parameter

Titik
[di] Menentukan titik, dalam koordinat layar, untuk memeriksa.

nSensitivitas
[di] Nilai untuk melambungkan persegi jendela dari setiap panel yang dicentang. Panel memenuhi kriteria pencarian jika titik yang diberikan berada di wilayah yang dilambungkan ini.

bExactBar
[di] TRUE untuk mengabaikan parameter nSensitivitas ; jika tidak, FALSE.

pRTCBarType
[di] Jika bukan NULL, metode hanya mencari panel dari jenis yang ditentukan.

bCheckVisibility
[di] TRUE untuk memeriksa hanya panel yang terlihat; jika tidak, FALSE.

dwAlignment
[out] Jika panel ditemukan pada titik yang ditentukan, parameter ini berisi sisi panel yang paling dekat dengan titik yang ditentukan. Untuk informasi lebih lanjut, lihat bagian Keterangan.

pBarToIgnore
[di] Jika bukan NULL, metode mengabaikan panel yang ditentukan oleh parameter ini.

Tampilkan Nilai

Objek turunan CBasePane yang berisi titik tertentu, atau NULL jika tidak ada panel yang ditemukan.

Keterangan

Saat fungsi kembali dan panel ditemukan, dwAlignment berisi perataan titik yang ditentukan. Misalnya, jika titik paling dekat dengan bagian atas panel, dwAlignment diatur ke CBRS_ALIGN_TOP.

CDockingManager::P rocessPaneContextMenuCommand

Dipanggil oleh kerangka kerja untuk memilih atau menghapus kotak centang untuk perintah yang ditentukan dan menghitung ulang tata letak panel yang diperlihatkan.

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

Parameter

Nid
[di] Id bilah kontrol di menu.

nCode
[di] Kode pemberitahuan perintah.

pExtra
[di] Pointer ke void yang ditransmisikan ke pointer ke CCmdUI jika nCode CN_UPDATE_COMMAND_UI.

pHandlerInfo
[di] Penunjuk ke struktur info. Parameter ini tidak digunakan.

Tampilkan Nilai

TRUE jika pEXtra bukan NULL dan nCode sama dengan CN_UPDATE_COMMAND_UI, atau jika ada bilah kontrol dengan nID yang ditentukan.

CDockingManager::RecalcLayout

Menghitung ulang tata letak internal kontrol yang ada dalam daftar kontrol.

virtual void RecalcLayout(BOOL bNotify = TRUE);

Parameter

bNotify
[di] Parameter ini tidak digunakan.

CDockingManager::ReleaseEmptyPaneContainers

Merilis kontainer panel kosong.

void ReleaseEmptyPaneContainers();

CDockingManager::RemoveHiddenMDITabbedBar

Menghapus panel bilah tersembunyi yang ditentukan.

void RemoveHiddenMDITabbedBar(CDockablePane* pBar);

Parameter

pBar
[di] Penunjuk ke panel bilah untuk dihapus.

CDockingManager::RemoveMiniFrame

Menghapus bingkai tertentu dari daftar bingkai mini.

virtual BOOL RemoveMiniFrame(CPaneFrameWnd* pWnd);

Parameter

pWnd
[di] Penunjuk ke bingkai untuk dihapus.

Tampilkan Nilai

TRUE jika bingkai yang ditentukan dihapus; FALSE jika tidak.

CDockingManager::RemovePaneFromDockManager

Membatalkan pendaftaran panel dan menghapusnya dari daftar di manajer docking.

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

Parameter

pWnd
[di] Penunjuk ke panel yang akan dihapus.

bDestroy
[di] Jika TRUE, panel yang dihapus akan dihancurkan.

bAdjustLayout
[di] Jika TRUE, segera sesuaikan tata letak docking.

bAutoHide
[di] Jika TRUE, panel dihapus dari daftar bilah autohide. Jika FALSE, panel dihapus dari daftar panel reguler.

pBarReplacement
[di] Penunjuk ke panel yang menggantikan panel yang dihapus.

CDockingManager::ReplacePane

Mengganti satu panel dengan panel lainnya.

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

Parameter

pOriginalBar
[di] Penunjuk ke panel asli.

pNewBar
[di] Penunjuk ke panel yang menggantikan panel asli.

Tampilkan Nilai

TRUE jika panel berhasil diganti; FALSE jika tidak.

CDockingManager::ResortMiniFramesForZOrder

Menggunakan bingkai dalam daftar bingkai mini.

void ResortMiniFramesForZOrder();

CDockingManager::SaveState

Menyimpan status manajer docking ke registri.

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

Parameter

lpszProfileName
[di] Jalur ke kunci registri.

uiID
[di] ID manajer docking.

Tampilkan Nilai

TRUE jika status berhasil disimpan; jika tidak FALSE.

Keterangan

Menyimpan status manajer docking ke registri melibatkan penyimpanan status bilah kontrol, status bilah autohide, dan status bingkai mini yang ada di manajer docking.

CDockingManager::SendMessageToMiniFrames

Mengirim pesan yang ditentukan ke semua bingkai mini.

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

Parameter

uMessage
[di] Pesan yang akan dikirim.

wParam
[di] Informasi dependen pesan tambahan.

lParam
[di] Informasi dependen pesan tambahan.

Tampilkan Nilai

TRUE selalu.

CDockingManager::Serialize

Menulis manajer docking ke arsip.

void Serialize(CArchive& ar);

Parameter

Ar
[di] Referensi ke objek arsip.

Keterangan

Menulis manajer docking ke arsip melibatkan penentuan jumlah bilah kontrol docking dan slider, dan menulis bilah kontrol, bingkai mini, bilah autohide, dan bilah tab MDI ke arsip.

CDockingManager::SetAutohideZOrder

Mengatur ukuran, lebar, dan tinggi bilah kontrol dan panel yang ditentukan.

void SetAutohideZOrder(CDockablePane* pAHDockingBar);

Parameter

pAHDockingBar
[di] Penunjuk ke panel yang dapat di-dok.

CDockingManager::SetDockingMode

Mengatur mode docking.

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

Parameter

dockMode
Menentukan mode docking baru. Untuk informasi lebih lanjut, lihat bagian Keterangan.

Tema
Menentukan tema yang akan digunakan untuk penanda docking pintar. Ini bisa menjadi salah satu nilai enumerasi berikut: AFX_SDT_DEFAULT, AFX_SDT_VS2005, AFX_SDT_VS2008.

Keterangan

Panggil metode statis ini untuk mengatur mode docking.

dockMode bisa menjadi salah satu nilai berikut:

  • DT_STANDARD - Mode docking standar seperti yang diimplementasikan di Visual Studio .NET 2003. Panel diseret tanpa konteks seret.

  • DT_IMMEDIATE - Mode docking langsung seperti yang diimplementasikan di Microsoft Visio. Panel diseret dengan konteks seret, tetapi tidak ada penanda yang ditampilkan.

  • DT_SMART - Mode docking cerdas seperti yang diimplementasikan di Visual Studio 2005. Panel diseret dengan konteks seret dan penanda pintar ditampilkan yang memperlihatkan di mana panel dapat ditampung.

CDockingManager::SetDockState

Mengatur status docking bilah kontrol, bingkai mini, dan bilah autohide.

virtual void SetDockState();

CDockingManager::SetPrintPreviewMode

Mengatur mode pratinjau cetak bilah yang ditampilkan dalam pratinjau cetak.

void SetPrintPreviewMode(
    BOOL bPreview,
    CPrintPreviewState* pState);

Parameter

bPreview
[di] TRUE jika mode pratinjau cetak diatur; FALSE jika tidak.

pState
[di] Penunjuk ke status pratinjau. Parameter ini tidak digunakan.

CDockingManager::SetSmartDockingParams

Mengatur parameter yang menentukan perilaku docking pintar.

static void SetSmartDockingParams(CSmartDockingInfo& params);

Parameter

params
[masuk, keluar] Menentukan parameter untuk docking pintar.

Keterangan

Panggil metode ini jika Anda ingin menyesuaikan tampilan, warna, atau bentuk penanda docking pintar.

Untuk menggunakan tampilan default untuk penanda docking pintar, berikan instans kelas CSmartDockingInfo yang tidak diinisialisasi ke param.

CDockingManager::ShowDelayShowMiniFrames

Menampilkan atau menyembunyikan jendela bingkai mini.

void ShowDelayShowMiniFrames(BOOL bshow);

Parameter

bShow
[di] TRUE untuk membuat jendela bingkai yang ditampilkan aktif; FALSE untuk menyembunyikan jendela bingkai.

CDockingManager::ShowPanes

Memperlihatkan atau menyembunyikan panel bilah kontrol dan autohide.

virtual BOOL ShowPanes(BOOL bShow);

Parameter

bShow
[di] TRUE untuk memperlihatkan panel; FALSE untuk menyembunyikan panel.

Tampilkan Nilai

Selalu FALSE.

CDockingManager::StartSDocking

Memulai docking pintar dari jendela yang ditentukan sesuai dengan penyelarasan manajer docking pintar.

void StartSDocking(CWnd* pDockingWnd);

Parameter

pDockingWnd
[di] Penunjuk ke jendela untuk menambah.

CDockingManager::StopsDocking

Berhenti docking pintar.

void StopSDocking();

CDockingManager::GetSmartDockingTheme

Metode statis yang mengembalikan tema yang digunakan untuk menampilkan penanda docking pintar.

static AFX_SMARTDOCK_THEME __stdcall GetSmartDockingTheme();

Tampilkan Nilai

Mengembalikan salah satu nilai enumerasi berikut: AFX_SDT_DEFAULT, AFX_SDT_VS2005, AFX_SDT_VS2008.

Keterangan

Baca juga

Bagan Hierarki
Kelas
Kelas CObject
Kelas CFrameWndEx
Kelas CDockablePane
Kelas CPaneFrameWnd