Klasa CBaseTabbedPane

Rozszerza funkcjonalność klasy CDockablePane w celu obsługi tworzenia okien z kartami.

Składnia

class CBaseTabbedPane : public CDockablePane

Elementy członkowskie

Konstruktory publiczne

Nazwa/nazwisko	opis
CBaseTabbedPane::CBaseTabbedPane	Konstruktor domyślny.

Metody publiczne

Nazwa/nazwisko	opis
CBaseTabbedPane::AddTab	Dodaje nową kartę do okienka z kartami.
CBaseTabbedPane::AllowDestroyEmptyTabbedPane	Określa, czy można zniszczyć puste okienko z kartami.
CBaseTabbedPane::ApplyRestoredTabInfo	Stosuje ustawienia kart, które są ładowane z rejestru do okienka z kartami.
CBaseTabbedPane::CanFloat	Określa, czy okienko może upłynąć zmiennoprzecinkowe. (Przesłonięcia) CBasePane::CanFloat).
CBaseTabbedPane::CanSetCaptionTextToTabName	Określa, czy podpis okienka z kartami powinien wyświetlać ten sam tekst co aktywna karta.
CBaseTabbedPane::ConvertToTabbedDocument	(Przesłonięcia) CDockablePane::ConvertToTabbedDocument.
CBaseTabbedPane::D etachPane	Konwertuje co najmniej jedno okienko z możliwością dokowania do dokumentów z kartami MDI.
CBaseTabbedPane::EnableSetCaptionTextToTabName	Włącza lub wyłącza możliwość synchronizowania tekstu transkryplacji z tekstem etykiety na aktywnej karcie.
CBaseTabbedPane::FillDefaultTabsOrderArray	Przywraca kolejność karty wewnętrznej do stanu domyślnego.
CBaseTabbedPane::FindBarByTabNumber	Zwraca okienko, które znajduje się na karcie, gdy karta jest identyfikowana przez indeks tabulacji zero.
CBaseTabbedPane::FindPaneByID	Zwraca okienko, które jest identyfikowane przez identyfikator okienka.
CBaseTabbedPane::FloatTab	Unosi okienko, ale tylko wtedy, gdy okienko znajduje się obecnie na karcie odłączanej.
CBaseTabbedPane::GetDefaultTabsOrder	Zwraca domyślną kolejność kart w okienku.
CBaseTabbedPane::GetFirstVisibleTab	Pobiera wskaźnik do pierwszej wyświetlonej karty.
CBaseTabbedPane::GetMinSize	Pobiera minimalny dozwolony rozmiar okienka. (Przesłonięcia) CPane::GetMinSize.)
CBaseTabbedPane::GetPaneIcon	Zwraca uchwyt do ikony okienka. (Przesłonięcia) CBasePane::GetPaneIcon).
CBaseTabbedPane::GetPaneList	Zwraca listę okienek zawartych w okienku z kartami.
CBaseTabbedPane::GetTabArea	Zwraca prostokąty ograniczenia dla obszarów górnej i dolnej karty.
CBaseTabbedPane::GetTabsNum	Zwraca liczbę kart w oknie karty.
CBaseTabbedPane::GetUnderlyingWindow	Pobiera podstawowe (opakowane) okno karty.
CBaseTabbedPane::GetVisibleTabsNum	Zwraca liczbę wyświetlanych kart.
CBaseTabbedPane::HasAutoHideMode	Określa, czy okienko z kartami można przełączyć do trybu automatycznego ukrywania.
CBaseTabbedPane::IsHideSingleTab	Określa, czy okienko z kartami jest ukryte, jeśli jest wyświetlana tylko jedna karta.
CBaseTabbedPane::LoadSiblingPaneIDs	Używane wewnętrznie podczas serializacji.
CBaseTabbedPane::RecalcLayout	Oblicza ponownie informacje o układzie okienka. (Przesłonięcia) CPane::RecalcLayout).
CBaseTabbedPane::RemovePane	Usuwa okienko z okienka z kartami.
CBaseTabbedPane::SaveSiblingBarIDs	Używane wewnętrznie podczas serializacji.
CBaseTabbedPane::Serialize	(Przesłonięcia) CDockablePane::Serialize.)
CBaseTabbedPane::SerializeTabWindow	Używane wewnętrznie podczas serializacji.
CBaseTabbedPane::SetAutoDestroy	Określa, czy pasek sterowania z kartami zostanie automatycznie zniszczony.
CBaseTabbedPane::SetAutoHideMode	Przełącza okienko dokowania między wyświetlanym i automatycznym trybem ukrywania. (Przesłonięcia) CDockablePane::SetAutoHideMode.)
CBaseTabbedPane::ShowTab	Pokazuje lub ukrywa kartę.

Uwagi

Ta klasa jest klasą abstrakcyjną i nie można utworzyć jej wystąpienia. Implementuje usługi wspólne dla wszystkich rodzajów okienek z kartami.

Obecnie biblioteka zawiera dwie pochodne klasy okienka z kartami: Klasa CTabbedPane i KLASA CMFCOutlookBar.

Obiekt CBaseTabbedPane opakowuje wskaźnik do obiektu klasy CMFCBaseTabCtrl. Klasa CMFCBaseTabCtrl staje się oknem podrzędnym okienka z kartami.

Aby uzyskać więcej informacji na temat tworzenia okienek z kartami, zobacz Klasa CDockablePane, Klasa CTabbedPane i Klasa CMFCOutlookBar.

Hierarchia dziedziczenia

Obiekt CObject

CCmdTarget

CWnd

CBasePane

CPane

CDockablePane

CBaseTabbedPane

Wymagania

Nagłówek: afxBaseTabbedPane.h

CBaseTabbedPane::AddTab

Dodaje nową kartę do okienka z kartami.

virtual BOOL AddTab(
    CWnd* pNewBar,
    BOOL bVisible = TRUE,
    BOOL bSetActive = TRUE,
    BOOL bDetachable = TRUE);

Parametry

pNewBar
[in, out] Wskaźnik do okienka do dodania. Ten wskaźnik może stać się nieprawidłowy po wywołaniu tej metody. Aby uzyskać więcej informacji, zobacz sekcję: Uwagi.

bVisible
[in] WARTOŚĆ TRUE, aby uwidocznić kartę; w przeciwnym razie, FAŁSZ.

bSetActive
[in] WARTOŚĆ TRUE, aby ustawić kartę na aktywnej karcie; w przeciwnym razie, FAŁSZ.

Element bDetachable
[in] WARTOŚĆ TRUE, aby karta jest odłączana; w przeciwnym razie, FAŁSZ.

Wartość zwracana

Wartość TRUE, jeśli okienko zostało pomyślnie dodane jako karta i nie zostało zniszczone w procesie. FAŁSZ, jeśli dodawane okienko jest obiektem typu CBaseTabbedPane. Aby uzyskać więcej informacji, zobacz sekcję: Uwagi.

Uwagi

Wywołaj tę metodę, aby dodać okienko jako nową kartę w okienku z kartami. Jeśli pNewBar wskazuje obiekt typu CBaseTabbedPane, wszystkie jego karty zostaną skopiowane do okienka z kartami, a następnie pNewBar zostanie zniszczony. W związku z tym pNewBar staje się nieprawidłowym wskaźnikiem i nie powinien być używany.

CBaseTabbedPane::AllowDestroyEmptyTabbedPane

Określa, czy można zniszczyć puste okienko z kartami.

virtual BOOL AllowDestroyEmptyTabbedPane() const;

Wartość zwracana

WARTOŚĆ TRUE, jeśli można zniszczyć puste okienko z kartami; w przeciwnym razie, FAŁSZ. Domyślna implementacja zawsze zwraca wartość TRUE.

Uwagi

Jeśli puste okienko z kartami nie może zostać zniszczone, zamiast tego struktura ukrywa okienko.

CBaseTabbedPane::ApplyRestoredTabInfo

Ładuje ustawienia karty z rejestru i stosuje je do okienka z kartami.

virtual void ApplyRestoredTabInfo(BOOL bUseTabIndexes = FALSE);

Parametry

bUseTabIndexes
[in] Ten parametr jest używany wewnętrznie przez platformę.

Uwagi

Ta metoda jest wywoływana przez platformę podczas ponownego ładowania informacji o stanie dokowania z rejestru. Metoda uzyskuje informacje o kolejności tabulacji i nazwach kart dla okienka z kartami.

CBaseTabbedPane::CanFloat

Określa, czy okienko z kartami może unosić się zmiennoprzecinkowe.

virtual BOOL CanFloat() const;

Wartość zwracana

WARTOŚĆ TRUE, jeśli okienko może upłynąć zmiennoprzecinkowe; w przeciwnym razie, FAŁSZ.

CBaseTabbedPane::CanSetCaptionTextToTabName

Określa, czy podpis okienka z kartami powinien wyświetlać ten sam tekst co aktywna karta.

virtual BOOL CanSetCaptionTextToTabName() const;

Wartość zwracana

WARTOŚĆ TRUE, jeśli tekst podpisu okienka z kartami jest ustawiony na tekst aktywnej karty; w przeciwnym razie, FAŁSZ.

Uwagi

Metoda służy do określania, czy tekst wyświetlany w podpisie okienka z kartami duplikuje etykietę aktywnej karty. Tę funkcję można włączyć lub wyłączyć, wywołując funkcję CBaseTabbedPane::EnableSetCaptionTextToTabName.

CBaseTabbedPane::ConvertToTabbedDocument

Konwertuje co najmniej jedno okienko z możliwością dokowania do dokumentów z kartami MDI.

virtual void ConvertToTabbedDocument(BOOL bActiveTabOnly = TRUE);

Parametry

bActiveTabOnly
[in] Podczas konwertowania okienka z kartami określ wartość TRUE, aby przekonwertować tylko aktywną kartę. Określ wartość FALSE, aby przekonwertować wszystkie karty w okienku.

CBaseTabbedPane::D etachPane

Odłącza okienko od okienka z kartami.

virtual BOOL DetachPane(
    CWnd* pBar,
    BOOL bHide = FALSE);

Parametry

Pasek p
[in] Wskaźnik do okienka, aby odłączyć.

bHide
[in] Parametr logiczny określający, czy struktura ukrywa okienko po odłączeniu.

Wartość zwracana

Wartość TRUE, jeśli platforma pomyślnie odłącza okienko; FAŁSZ, jeśli pasek pBar ma wartość NULL lub odwołuje się do okienka, które nie znajduje się w okienku z kartami.

Uwagi

Jeśli to możliwe, struktura unosi się w odłączonym okienku. Aby uzyskać więcej informacji, zobacz CBasePane::CanFloat.

CBaseTabbedPane::EnableSetCaptionTextToTabName

Włącza lub wyłącza możliwość synchronizowania tekstu transkryplacji z tekstem etykiety na aktywnej karcie.

virtual void EnableSetCaptionTextToTabName(BOOL bEnable);

Parametry

bEnable
[in] WARTOŚĆ TRUE, aby zsynchronizować podpis okienka z kartą z aktywnym podpisem karty; w przeciwnym razie, FAŁSZ.

CBaseTabbedPane::FillDefaultTabsOrderArray

Przywraca kolejność karty wewnętrznej do stanu domyślnego.

void FillDefaultTabsOrderArray();

Uwagi

Ta metoda jest wywoływana, gdy platforma przywraca pasek programu Outlook do stanu początkowego.

CBaseTabbedPane::FindPaneByID

Zwraca okienko zidentyfikowane przez identyfikator okienka.

virtual CWnd* FindPaneByID(UINT uBarID);

Parametry

uBarID
[in] Określa identyfikator okienka do znalezienia.

Wartość zwracana

Wskaźnik do okienka, jeśli został znaleziony; w przeciwnym razie wartość NULL.

Uwagi

Ta metoda porównuje wszystkie karty w okienku i zwraca tę z identyfikatorem określonym przez parametr uBarID .

CBaseTabbedPane::FindBarByTabNumber

Zwraca okienko, które znajduje się na karcie.

virtual CWnd* FindBarByTabNumber(
    int nTabNum,
    BOOL bGetWrappedBar = FALSE);

Parametry

nTabNum
[in] Określa indeks zerowy karty do pobrania.

bGetWrappedBar
[in] WARTOŚĆ TRUE, aby zwrócić bazowe (opakowane) okno okienka zamiast samego okienka; w przeciwnym razie FAŁSZ. Dotyczy to tylko okienek pochodzących z CDockablePaneAdapter.

Wartość zwracana

Jeśli okienko zostanie znalezione, zostanie zwrócony prawidłowy wskaźnik do wyszukiwanego okienka; w przeciwnym razie wartość NULL.

Uwagi

Wywołaj tę metodę, aby pobrać okienko znajdujące się na karcie określonej przez parametr nTabNum .

CBaseTabbedPane::FloatTab

Unosi okienko, ale tylko wtedy, gdy okienko znajduje się obecnie na karcie odłączanej.

virtual BOOL FloatTab(
    CWnd* pBar,
    int nTabID,
    AFX_DOCK_METHOD dockMethod,
    BOOL bHide = FALSE);

Parametry

Pasek p
[in, out] Wskaźnik do okienka, aby upłynąć zmiennoprzecinkowy.

nTabID
[in] Określa indeks zerowy karty do zmiennoprzecinkowej.

dockMethod
[in] Określa metodę używaną do upłynięcia okienka. Aby uzyskać więcej informacji, zobacz sekcję: Uwagi.

bHide
[in] PRAWDA, aby ukryć okienko przed przestawnym; w przeciwnym razie, FAŁSZ.

Wartość zwracana

WARTOŚĆ TRUE, jeśli okienko unosiło się; w przeciwnym razie, FAŁSZ.

Uwagi

Wywołaj tę metodę, aby unosić okienko, które obecnie znajduje się na karcie odłączanej.

Jeśli chcesz programowo odłączyć okienko, określ DM_SHOW parametru dockMethod . Jeśli chcesz umieścić okienko w tej samej pozycji, w której wcześniej upłynął, określ DM_DBL_CLICK jako parametr dockMethod .

CBaseTabbedPane::GetDefaultTabsOrder

Zwraca domyślną kolejność kart w okienku.

const CArray<int,int>& GetDefaultTabsOrder();

Wartość zwracana

CArray Obiekt określający domyślną kolejność kart w okienku.

Uwagi

Platforma wywołuje tę metodę, gdy pasek programu Outlook jest resetowany do stanu początkowego.

CBaseTabbedPane::GetFirstVisibleTab

Pobiera wskaźnik do pierwszej wyświetlonej karty.

virtual CWnd* GetFirstVisibleTab(int& iTabNum);

Parametry

iTabNum
[in] Odwołanie do liczby całkowitej. Ta metoda zapisuje indeks na podstawie zera pierwszej wyświetlonej karty do tego parametru lub -1, jeśli nie znaleziono wyświetlanej karty.

Wartość zwracana

Jeśli to się powiedzie, wskaźnik do pierwszej wyświetlonej karty; w przeciwnym razie wartość NULL.

CBaseTabbedPane::GetMinSize

Pobiera minimalny dozwolony rozmiar okienka.

virtual void GetMinSize(CSize& size) const;

Parametry

rozmiar
[out] CSize Obiekt wypełniony minimalnym dozwolonym rozmiarem.

Uwagi

Jeśli spójna obsługa minimalnych rozmiarów okienka jest aktywna ( CPane::m_bHandleMinSize), rozmiar jest wypełniony minimalnym dozwolonym rozmiarem dla aktywnej karty. W przeciwnym razie rozmiar jest wypełniony wartością zwracaną CPane::GetMinSize.

CBaseTabbedPane::GetPaneIcon

Pobiera minimalny dozwolony rozmiar okienka.

virtual void GetMinSize(CSize& size) const;

Parametry

rozmiar
[out] CSize Obiekt wypełniony minimalnym dozwolonym rozmiarem.

Uwagi

Jeśli spójna obsługa minimalnych rozmiarów okienka jest aktywna ( CPane::m_bHandleMinSize), rozmiar jest wypełniony minimalnym dozwolonym rozmiarem dla aktywnej karty. W przeciwnym razie rozmiar jest wypełniony wartością zwracaną CPane::GetMinSize.

CBaseTabbedPane::GetPaneList

Zwraca listę okienek zawartych w okienku z kartami.

virtual void GetPaneList(
    CObList& lst,
    CRuntimeClass* pRTCFilter = NULL);

Parametry

Lst
[out] Element CObList wypełniony okienkami znajdującymi się w okienku z kartami.

pRTCFilter
[in] Jeśli nie ma wartości NULL, zwracana lista zawiera tylko okienka z określonej klasy środowiska uruchomieniowego.

CBaseTabbedPane::GetTabArea

Zwraca prostokąty ograniczenia dla obszarów górnej i dolnej karty.

virtual void GetTabArea(
    CRect& rectTabAreaTop,
    CRect& rectTabAreaBottom) const = 0;

Parametry

rectTabAreaTop
[out] Odbiera współrzędne ekranu górnej karty.

rectTabAreaBottom
[out] Odbiera współrzędne ekranu w dolnym obszarze karty.

Uwagi

Wywołaj tę metodę, aby określić prostokąty ograniczenia we współrzędnych ekranu dla obszarów górnej i dolnej karty.

CBaseTabbedPane::GetTabsNum

Zwraca liczbę kart w oknie karty.

virtual int GetTabsNum() const;

Wartość zwracana

Liczba kart w okienku z kartami.

CBaseTabbedPane::GetUnderlyingWindow

Pobiera podstawowe (opakowane) okno karty.

virtual CMFCBaseTabCtrl* GetUnderlyingWindow();

Wartość zwracana

Wskaźnik do okna karty bazowej.

CBaseTabbedPane::GetVisibleTabsNum

Zwraca liczbę widocznych kart.

virtual int GetVisibleTabsNum() const;

Wartość zwracana

Liczba widocznych kart, które będą większe lub równe zero.

Uwagi

Wywołaj tę metodę, aby określić liczbę widocznych kart w okienku z kartami.

CBaseTabbedPane::HasAutoHideMode

Określa, czy okienko z kartami można przełączyć do trybu automatycznego ukrywania.

virtual BOOL HasAutoHideMode() const;

Wartość zwracana

WARTOŚĆ TRUE, jeśli okienko można przełączyć do trybu automatycznego ukrywania; w przeciwnym razie, FAŁSZ.

Uwagi

Jeśli tryb automatycznego ukrywania jest wyłączony, w podpisie okienka z kartami nie jest wyświetlany przycisk pinezki.

CBaseTabbedPane::IsHideSingleTab

Określa, czy okienko z kartami jest ukryte, jeśli jest wyświetlana tylko jedna karta.

virtual BOOL IsHideSingleTab() const;

Wartość zwracana

WARTOŚĆ TRUE, jeśli okno karty nie jest wyświetlane, gdy istnieje tylko jedna widoczna karta; w przeciwnym razie, FAŁSZ.

Uwagi

Jeśli okienko nie jest wyświetlane, ponieważ jest otwarta tylko jedna karta, możesz wywołać tę metodę, aby określić, czy okienko z kartami działa prawidłowo.

CBaseTabbedPane::RemovePane

Usuwa okienko z okienka z kartami.

virtual BOOL RemovePane(CWnd* pBar);

Parametry

Pasek p
[in, out] Wskaźnik do okienka do usunięcia z okienka z kartami.

Wartość zwracana

Wartość TRUE, jeśli okienko zostało pomyślnie usunięte z okienka z kartami i jeśli okienko z kartami jest nadal prawidłowe. FAŁSZ, jeśli ostatnie okienko zostało usunięte z okienka z kartami, a okienko z kartami zostanie zniszczone. Jeśli zwracana wartość to FALSE, nie używaj więcej okienka z kartami.

Uwagi

Wywołaj tę metodę, aby usunąć okienko określone przez parametr pBar z okienka z kartami.

CBaseTabbedPane::SetAutoDestroy

Określa, czy pasek sterowania z kartami zostanie automatycznie zniszczony.

void SetAutoDestroy(BOOL bAutoDestroy = TRUE);

Parametry

bAutoDestroy
[in] WARTOŚĆ TRUE, jeśli okienko z kartami zostało utworzone dynamicznie i nie kontrolujesz jego okresu istnienia; w przeciwnym razie, FAŁSZ.

Uwagi

Ustaw tryb automatycznego niszczenia na wartość TRUE, jeśli dynamicznie utworzysz okienko z kartami i jeśli nie kontrolujesz jego okresu istnienia. Jeśli tryb automatycznego niszczenia ma wartość TRUE, okienko z kartami zostanie automatycznie zniszczone przez strukturę.

CBaseTabbedPane::ShowTab

Pokazuje lub ukrywa kartę.

virtual BOOL ShowTab(
    CWnd* pBar,
    BOOL bShow,
    BOOL bDelay,
    BOOL bActivate);

Parametry

Pasek p
[in] Wskaźnik do okienka w celu wyświetlenia lub ukrycia.

bShow
[in] WARTOŚĆ TRUE, aby wyświetlić okienko; FAŁSZ, aby ukryć okienko.

bDelay
[in] WARTOŚĆ TRUE, aby opóźnić dostosowanie układu karty; w przeciwnym razie, FAŁSZ.

bActivate
[in] WARTOŚĆ TRUE, aby ustawić kartę na aktywnej karcie; w przeciwnym razie, FAŁSZ.

Wartość zwracana

WARTOŚĆ TRUE, jeśli karta została wyświetlona lub ukryta pomyślnie; w przeciwnym razie, FAŁSZ.

Uwagi

Po wywołaniu tej metody zostanie wyświetlone lub ukryte okienko w zależności od wartości parametru bShow . Jeśli ukrywasz kartę i jest to ostatnia widoczna karta w oknie karty bazowej, okienko z kartą jest ukryte. Jeśli pokażesz kartę, gdy wcześniej nie było żadnych widocznych kart, zostanie wyświetlone okienko z kartami.

CBaseTabbedPane::RecalcLayout

Oblicza ponownie informacje o układzie okienka.

virtual void RecalcLayout();

Uwagi

Jeśli okienko jest przestawne, ta metoda powiadamia platformę o zmianie rozmiaru okienka na bieżący rozmiar mini-ramki.

Jeśli okienko jest zadokowane, ta metoda nic nie robi.

CBaseTabbedPane::SetAutoHideMode

Ustawia tryb automatycznego ukrywania dla odłączanych okienek w okienku z kartami.

virtual CMFCAutoHideToolBar* SetAutoHideMode(
    BOOL bMode,
    DWORD dwAlignment,
    CMFCAutoHideToolBar* pCurrAutoHideBar = NULL,
    BOOL bUseTimer = TRUE);

Parametry

bMode
[in] WARTOŚĆ TRUE, aby włączyć tryb automatycznego ukrywania; FAŁSZ, aby włączyć zwykły tryb dokowania.

dwAlignment
[in] Określa wyrównanie okienka automatycznego ukrywania, które ma zostać utworzone. Aby uzyskać listę możliwych wartości, zobacz CPane::MoveByAlignment.

pCurrAutoHideBar
[in, out] Wskaźnik do bieżącego paska narzędzi automatycznego ukrywania. Może mieć wartość NULL.

bUseTimer
[in] Określa, czy używać efektu automatycznego ukrywania, gdy użytkownik przełącza okienko do trybu automatycznego ukrywania, czy ukrywa okienko natychmiast.

Wartość zwracana

Wskaźnik do automatycznie ukrywanego paska narzędzi, który jest tworzony podczas przełączania do trybu automatycznego ukrywania lub null, jeśli pasek narzędzi nie zostanie utworzony.

Uwagi

Struktura wywołuje tę metodę, gdy użytkownik wybierze przycisk pinezki, aby przełączyć okienko z kartami do trybu automatycznego ukrywania lub zwykłego trybu dokowania.

Tryb automatycznego ukrywania jest ustawiany dla każdego odłączonego okienka w okienku z kartami. Okienka, które nie są odłączane, są ignorowane. Aby uzyskać więcej informacji, zobacz CMFCBaseTabCtrl::EnableTabDetach.

Wywołaj tę metodę, aby przełączyć okienko z kartami do trybu automatycznego ukrywania programowo. Okienko musi być zadokowane do głównego okna ramki ( CDockablePane::GetDefaultPaneDivider musi zwrócić prawidłowy wskaźnik do CPaneDivider).

Zobacz też

Wykres hierarchii
Klasy
Klasa CDockablePane