CTabCtrl-klass

Tillhandahåller funktionerna i den vanliga flikkontrollen i Windows.

Syntax

class CTabCtrl : public CWnd

Medlemmar

Offentliga konstruktorer

Offentliga metoder

Anmärkningar

En "tabbkontroll" motsvarar avdelarna i en notebook-fil eller etiketterna i ett filskåp. Genom att använda en flikkontroll kan ett program definiera flera sidor för samma område i ett fönster eller en dialogruta. Varje sida består av en uppsättning information eller en grupp kontroller som programmet visar när användaren väljer motsvarande flik. En särskild typ av flikkontroll visar flikar som ser ut som knappar. Om du klickar på en knapp bör du omedelbart utföra ett kommando i stället för att visa en sida.

Den här kontrollen (och därmed klassen CTabCtrl) är endast tillgänglig för program som körs under Windows 95/98 och Windows NT version 3.51 och senare.

Mer information om CTabCtrlfinns i Kontroller och Använda CTabCtrl.

Arvshierarki

CObject
CCmdTarget
CWnd

CTabCtrl

Kravspecifikation

rubrik:afxcmn.h

CTabCtrl::AdjustRect

Beräknar en flikkontrolls visningsområde givet en fönsterrektangel eller beräknar den fönsterrektangel som skulle motsvara ett visst visningsområde.

void AdjustRect(BOOL bLarger,   LPRECT lpRect);

Parameterar

bLarger
Anger vilken åtgärd som ska utföras. Om den här parametern är TRUEanger lpRect du en visningsrektangel och tar emot motsvarande fönsterrektangel. Om den här parametern är FALSEanger lpRect du en fönsterrektangel och tar emot motsvarande visningsrektangel.

lpRect
Pekare till en RECT struktur som anger den angivna rektangeln och tar emot den beräknade rektangeln.

Exempel

void CTabDlg::OnSize(UINT nType, int cx, int cy)
{
   CDialog::OnSize(nType, cx, cy);

   if (m_TabCtrl.m_hWnd == NULL)
      return; // Return if window is not created yet.

   RECT rect;

   // Get size of dialog window.
   GetClientRect(&rect);

   // Adjust the rectangle to fit the tab control into the
   // dialog's client rectangle.
   m_TabCtrl.AdjustRect(FALSE, &rect);

   // Move the tab control to the new position and size.
   m_TabCtrl.MoveWindow(&rect, TRUE);
}

CTabCtrl::Create

Skapar en flikkontroll och kopplar den till en instans av ett CTabCtrl objekt.

virtual BOOL Create(
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID);

Parameterar

dwStyle
Anger flikkontrollens formatmall. Använd valfri kombination av flikkontrollformat som beskrivs i Windows SDK. Se Kommentarer för en lista över fönsterformat som du också kan använda för kontrollen.

rect
Anger flikkontrollens storlek och position. Det kan vara antingen ett CRect objekt eller en RECT struktur.

pParentWnd
Anger flikkontrollens överordnade fönster, vanligtvis ett CDialog. Det får inte vara NULL.

nID
Anger flikkontrollens ID.

Returvärde

TRUE om initieringen av objektet lyckades. annars FALSE.

Anmärkningar

Du skapar ett CTabCtrl objekt i två steg. Anropa först konstruktorn och anropa Createsedan , vilket skapar tabbkontrollen och kopplar den CTabCtrl till objektet.

Förutom flikkontrollformat kan du använda följande fönsterformat på en flikkontroll:

• WS_CHILD: Skapar ett underordnat fönster som representerar flikkontrollen. Det går inte att använda WS_POPUP formatmallen.
• WS_VISIBLE: Skapar en flikkontroll som först visas.
• WS_DISABLED: Skapar ett fönster som är inaktiverat från början.
• WS_GROUP: Anger den första kontrollen för en grupp kontroller där användaren kan flytta från en kontroll till en annan med piltangenterna. Alla kontroller som definierats med WS_GROUPformatet : efter den första kontrollen tillhör samma grupp. Nästa kontroll med formatmallen WS_GROUP: avslutar formatgruppen och startar nästa grupp (det vill. en grupp slutar där nästa börjar).
• WS_TABSTOP: Anger en av valfritt antal kontroller som användaren kan flytta med hjälp av TAB-nyckeln. TABB-tangenten flyttar användaren till nästa kontroll som anges av WS_TABSTOPformatet : .

Om du vill skapa en flikkontroll med utökade fönsterformat anropar du CTabCtrl::CreateEx i stället för Create.

Exempel

// Assuming you have a member variable m_TabCtrl, that is a CTabCtrl
// object, you can use the following to create a tab control.

m_TabCtrl.Create(TCS_TABS | TCS_FIXEDWIDTH | WS_CHILD | WS_VISIBLE,
                 rect, this, IDC_MYTAB);

// This creates a tab control with the given styles, and with
// an ID of IDC_MYTAB.

CTabCtrl::CreateEx

Skapar en kontroll (ett underordnat fönster) och associerar den med objektet CTabCtrl.

virtual BOOL CreateEx(
    DWORD dwExStyle,
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID);

Parameterar

dwExStyle
Anger den utökade stilen för kontrollen som skapas. En lista över utökade Windows-format finns i parametern dwExStyle för CreateWindowEx i Windows SDK.

dwStyle
Anger flikkontrollens formatmall. Använd valfri kombination av flikkontrollformat som beskrivs i Windows SDK. Se Kommentarer i Create för en lista över fönsterformat som du också kan använda för kontrollen.

rect
En referens till en RECT struktur som beskriver storleken och positionen för fönstret som ska skapas i klientkoordinaterna pParentWndför .

pParentWnd
En pekare till det fönster som är kontrollens överordnade.

nID
Kontrollens underordnade fönster-ID.

Returvärde

Nonzero om det lyckas annars 0.

Anmärkningar

Använd CreateEx i stället för Create att använda utökade Windows-formatmallar, som anges i förordet WS_EX_för det utökade Windows-formatet .

CreateEx skapar kontrollen med de utökade Windows-format som anges av dwExStyle. Ange utökade format som är specifika för en kontroll med hjälp av SetExtendedStyle. Använd till exempel CreateEx för att ange formatmallar som WS_EX_CONTEXTHELP, men använd SetExtendedStyle för att ange formatmallar som TCS_EX_FLATSEPARATORS. Mer information finns i formaten som beskrivs i Tabbkontroll för utökade formatmallar i Windows SDK.

CTabCtrl::CTabCtrl

Konstruerar ett CTabCtrl objekt.

CTabCtrl();

CTabCtrl::DeleteAllItems

Tar bort alla objekt från en flikkontroll.

BOOL DeleteAllItems();

Returvärde

Nonzero om det lyckas; annars 0.

CTabCtrl::DeleteItem

Tar bort det angivna objektet från en flikkontroll.

BOOL DeleteItem(int nItem);

Parameterar

nItem
Nollbaserat värde för objektet som ska tas bort.

Returvärde

Nonzero om det lyckas; annars 0.

Exempel

// This example assumes that there is a CTabCtrl member of the
// CTabDlg class named m_TabCtrl.  On a button handler
// called OnDeleteItem of the dialog box the tab control will
// delete the 0 indexed item.

void CTabDlg::OnDeleteItem()
{
   // Delete the first item in the tab control.
   m_TabCtrl.DeleteItem(0);
}

CTabCtrl::DeselectAll

Återställer objekt i en flikkontroll och rensar alla som har tryckts på.

void DeselectAll(BOOL fExcludeFocus);

Parameterar

fExcludeFocus
Flagga som anger omfånget för objektets avmarkering. Om den här parametern är inställd på FALSEåterställs alla flikknappar. Om den är inställd på TRUEåterställs alla flikobjekt förutom det som för närvarande är markerat.

Anmärkningar

Den här medlemsfunktionen implementerar beteendet för Win32-meddelandet, TCM_DESELECTALL, enligt beskrivningen i Windows SDK.

CTabCtrl::DrawItem

Anropas av ramverket när en visuell aspekt av en ägardragningsflik ändras.

virtual void DrawItem(LPDRAWITEMSTRUCT lpDrawItemStruct);

Parameterar

lpDrawItemStruct
En pekare till en DRAWITEMSTRUCT struktur som beskriver objektet som ska målas.

Anmärkningar

Medlemmen itemAction i DRAWITEMSTRUCT strukturen definierar den ritningsåtgärd som ska utföras.

Som standard gör den här medlemsfunktionen ingenting. Åsidosätt den här medlemsfunktionen för att implementera ritning för ett ägarritningsobjekt CTabCtrl .

Programmet ska återställa alla GDI-objekt (grafikenhetsgränssnitt) som valts för visningskontexten som anges i lpDrawItemStruct innan den här medlemsfunktionen avslutas.

CTabCtrl::GetCurFocus

Hämtar indexet för fliken med aktuellt fokus.

int GetCurFocus() const;

Returvärde

Flikens nollbaserade index med aktuellt fokus.

CTabCtrl::GetCurSel

Hämtar den markerade fliken i en flikkontroll.

int GetCurSel() const;

Returvärde

Nollbaserat index för den valda fliken om det lyckas eller -1 om ingen flik har valts.

CTabCtrl::GetExtendedStyle

Hämtar de utökade formatmallar som används för flikkontrollen.

DWORD GetExtendedStyle();

Returvärde

Representerar de utökade formatmallar som används för flikkontrollen. Det här värdet är en kombination av utökade flikkontrollformat, enligt beskrivningen i Windows SDK.

Anmärkningar

Den här medlemsfunktionen implementerar beteendet för Win32-meddelandet TCM_GETEXTENDEDSTYLE, enligt beskrivningen i Windows SDK.

CTabCtrl::GetImageList

Hämtar den bildlista som är associerad med en flikkontroll.

CImageList* GetImageList() const;

Returvärde

Om det lyckas visas en pekare till bildlistan för flikkontrollen. annars . NULL

CTabCtrl::GetItem

Hämtar information om en flik i en flikkontroll.

BOOL GetItem(int nItem,   TCITEM* pTabCtrlItem) const;

Parameterar

nItem
Nollbaserat index för fliken.

pTabCtrlItem
Pekare till en TCITEM struktur som används för att ange den information som ska hämtas. Används också för att ta emot information om fliken. Den här strukturen används med medlemsfunktionerna InsertItem, GetItemoch SetItem .

Returvärde

Returnerar TRUE om det lyckas, FALSE annars.

Anmärkningar

När meddelandet skickas mask anger medlemmen vilka attribut som ska returneras. mask Om medlemmen anger TCIF_TEXT värdet pszText måste medlemmen innehålla adressen till bufferten som tar emot objekttexten cchTextMax och medlemmen måste ange buffertens storlek.

• mask

  Värde som anger vilka strukturmedlemmar som TCITEM ska hämtas eller anges. Den här medlemmen kan vara noll eller en kombination av följande värden:

  • TCIF_TEXT: Medlemmen pszText är giltig.
  • TCIF_IMAGE: Medlemmen iImage är giltig.
  • TCIF_PARAM: Medlemmen lParam är giltig.
  • TCIF_RTLREADING: Texten i visas med hjälp av pszText läsordningen från höger till vänster på hebreiska eller arabiska system.
  • TCIF_STATE: Medlemmen dwState är giltig.

• pszText

  Pekare till en null-avslutad sträng som innehåller tabbtexten om strukturen innehåller information om en flik. Om strukturen tar emot information anger den här medlemmen adressen till bufferten som tar emot tabbtexten.

• cchTextMax

  Storleken på bufferten som pekas på av pszText. Den här medlemmen ignoreras om strukturen inte tar emot information.

• iImage Indexera i tabbkontrollens bildlista eller -1 om det inte finns någon bild för fliken.

• lParam

  Programdefinierade data som är associerade med fliken. Om det finns mer än 4 byte programdefinierade data per flik måste ett program definiera en struktur och använda den TCITEM i stället för strukturen. Den första medlemmen i den programdefinierade strukturen måste vara en TCITEMHEADER struktur. Strukturen TCITEMHEADER är identisk med TCITEM strukturen, men utan lParam medlemmen. Skillnaden mellan strukturens storlek och strukturens TCITEMHEADER storlek bör vara lika med antalet extra byte per flik.

Exempel

// In this example a CTabCtrl data member, m_TabCtrl, changes the
// text of the tabs in the tab control.  A call to GetItem is used
// to get the current text, and then the text is changed.  A call
// to SetItem is used to update the tab with the new text.

void CTabDlg::OnChangeItem()
{
   TCITEM tcItem;
   CString pszString;

   //  Get text for the tab item.
   GetDlgItemText(IDC_ITEM_TEXT, pszString);

   //  Get the current tab item text.
   TCHAR buffer[256] = {0};
   tcItem.pszText = buffer;
   tcItem.cchTextMax = 256;
   tcItem.mask = TCIF_TEXT;
   m_TabCtrl.GetItem(0, &tcItem);
   TRACE(_T("Changing item text from %s to %s..."), tcItem.pszText, pszString);

   //  Set the new text for the item.
   tcItem.pszText = pszString.LockBuffer();

   //  Set the item in the tab control.
   m_TabCtrl.SetItem(0, &tcItem);

   pszString.UnlockBuffer();
}

CTabCtrl::GetItemCount

Hämtar antalet flikar i flikkontrollen.

int GetItemCount() const;

Returvärde

Antal objekt i flikkontrollen.

Exempel

Se exemplet för CPropertySheet::GetTabControl.

CTabCtrl::GetItemRect

Hämtar avgränsningsrektangeln för den angivna fliken i en flikkontroll.

BOOL GetItemRect(int nItem,   LPRECT lpRect) const;

Parameterar

nItem
Nollbaserat index för flikobjektet.

lpRect
Pekare till en RECT struktur som tar emot avgränsningsrektangeln på fliken. Dessa koordinater använder visningsplatsens aktuella mappningsläge.

Returvärde

Nonzero om det lyckas; annars 0.

Exempel

Se exemplet för CPropertySheet::GetTabControl.

CTabCtrl::GetItemState

Hämtar tillståndet för flikkontrollobjektet som identifieras av nItem.

DWORD GetItemState(
    int nItem,
    DWORD dwMask) const;

Parameterar

nItem
Det nollbaserade indexnumret för det objekt som tillståndsinformationen ska hämtas för.

dwMask
Mask som anger vilken av objektets tillståndsflaggor som ska returneras. En lista med värden finns i maskmedlemmen i TCITEM strukturen enligt beskrivningen i Windows SDK.

Returvärde

En referens till ett DWORD-värde som tar emot tillståndsinformationen. Kan vara något av följande värden:

Anmärkningar

Ett objekts tillstånd anges av dwState medlemmen i TCITEM strukturen.

CTabCtrl::GetRowCount

Hämtar det aktuella antalet rader i en flikkontroll.

int GetRowCount() const;

Returvärde

Antalet rader med flikar i flikkontrollen.

Anmärkningar

Endast flikkontroller som har TCS_MULTILINE formatet kan ha flera rader med flikar.

CTabCtrl::GetToolTips

Hämtar handtaget för knappbeskrivningskontrollen som är associerad med en flikkontroll.

CToolTipCtrl* GetToolTips() const;

Returvärde

Handtaget på verktygets spetskontroll om det lyckas; annars NULL.

Anmärkningar

En flikkontroll skapar en knappbeskrivningskontroll om den TCS_TOOLTIPS har formatet . Du kan också tilldela en knappbeskrivningskontroll till en flikkontroll med hjälp SetToolTips av medlemsfunktionen.

CTabCtrl::HighlightItem

Anger markeringstillståndet för ett flikobjekt.

BOOL HighlightItem(int idItem,  BOOL fHighlight = TRUE);

Parameterar

idItem
Nollbaserat index för ett flikkontrollobjekt.

fHighlight
Värde som anger det markeringstillstånd som ska anges. Om det här värdet är TRUEär fliken markerad. Om FALSEär fliken inställd på dess standardtillstånd.

Returvärde

Nonzero om det lyckas; annars noll.

Anmärkningar

Den här medlemsfunktionen implementerar Win32-meddelandet TCM_HIGHLIGHTITEM, enligt beskrivningen i Windows SDK.

CTabCtrl::HitTest

Avgör vilken flik som finns på den angivna skärmpositionen.

int HitTest(TCHITTESTINFO* pHitTestInfo) const;

Parameterar

pHitTestInfo
Pekare till en TCHITTESTINFO struktur, enligt beskrivningen i Windows SDK, som anger skärmpositionen som ska testas.

Returvärde

Returnerar det nollbaserade indexet för fliken eller -1 om ingen flik finns på den angivna positionen.

CTabCtrl::InsertItem

Infogar en ny flik i en befintlig flikkontroll.

LONG InsertItem(
    int nItem,
    TCITEM* pTabCtrlItem);

LONG InsertItem(
    int nItem,
    LPCTSTR lpszItem);

LONG InsertItem(
    int nItem,
    LPCTSTR lpszItem,
    int nImage);

LONG InsertItem(
    UINT nMask,
    int nItem,
    LPCTSTR lpszItem,
    int nImage,
    LPARAM lParam);

LONG InsertItem(
    UINT nMask,
    int nItem,
    LPCTSTR lpszItem,
    int nImage,
    LPARAM lParam,
    DWORD dwState,
    DWORD dwStateMask);

Parameterar

nItem
Nollbaserat index för den nya fliken.

pTabCtrlItem
Pekare till en TCITEM struktur som anger flikens attribut.

lpszItem
Adress för en null-avslutad sträng som innehåller texten på fliken.

nImage
Det nollbaserade indexet för en bild som ska infogas från en bildlista.

nMask
Anger vilka strukturattribut som TCITEM ska anges. Kan vara noll eller en kombination av följande värden:

• TCIF_TEXT: Medlemmen pszText är giltig.
• TCIF_IMAGE: Medlemmen iImage är giltig.
• TCIF_PARAM: Medlemmen lParam är giltig.
• TCIF_RTLREADING: Texten i visas med hjälp av pszText läsordningen från höger till vänster på hebreiska eller arabiska system.
• TCIF_STATE: Medlemmen dwState är giltig.

lParam
Programdefinierade data som är associerade med fliken.

dwState
Anger värden för objektets tillstånd. Mer information TCITEM finns i Windows SDK.

dwStateMask
Anger vilka tillstånd som ska anges. Mer information TCITEM finns i Windows SDK.

Returvärde

Nollbaserat index för den nya fliken om det lyckas. annars -1.

Exempel

TCITEM tcItem;
tcItem.mask = TCIF_TEXT;
tcItem.pszText = _T("Tab #1");

m_TabCtrl.InsertItem(0, &tcItem);

CTabCtrl::RemoveImage

Tar bort den angivna bilden från en flikkontrolls bildlista.

void RemoveImage(int nImage);

Parameterar

nImage
Nollbaserat index för avbildningen som ska tas bort.

Anmärkningar

Tabbkontrollen uppdaterar varje fliks bildindex så att varje flik förblir associerad med samma bild.

CTabCtrl::SetCurFocus

Anger fokus till en angiven flik i en flikkontroll.

void SetCurFocus(int nItem);

Parameterar

nItem
Anger indexet för fliken som får fokus.

Anmärkningar

Den här medlemsfunktionen implementerar beteendet för Win32-meddelandet TCM_SETCURFOCUS, enligt beskrivningen i Windows SDK.

CTabCtrl::SetCurSel

Väljer en flik i en flikkontroll.

int SetCurSel(int nItem);

Parameterar

nItem
Det nollbaserade indexet för det objekt som ska väljas.

Returvärde

Nollbaserat index för den tidigare valda fliken om det lyckas, annars -1.

Anmärkningar

En flikkontroll skickar inte ett TCN_SELCHANGING meddelande eller TCN_SELCHANGE meddelande när en flik har valts med hjälp av den här funktionen. Dessa meddelanden skickas med , WM_NOTIFYnär användaren klickar eller använder tangentbordet för att ändra flikar.

CTabCtrl::SetExtendedStyle

Anger utökade format för en flikkontroll.

DWORD SetExtendedStyle(DWORD dwNewStyle, DWORD dwExMask = 0);

Parameterar

dwNewStyle
Värde som anger en kombination av utökade flikkontrollformat.

dwExMask
Ett DWORD-värde som anger vilka formatmallar som dwNewStyle ska påverkas. Endast de utökade formaten i dwExMask ändras. Alla andra format kommer att underhållas som de är. Om den här parametern är noll påverkas alla formatmallar i dwNewStyle .

Returvärde

Ett DWORD-värde som innehåller föregående flik kontrollerar utökade formatmallar enligt beskrivningen i Windows SDK.

Anmärkningar

Den här medlemsfunktionen implementerar beteendet för Win32-meddelandet TCM_SETEXTENDEDSTYLE, enligt beskrivningen i Windows SDK.

CTabCtrl::SetImageList

Tilldelar en bildlista till en flikkontroll.

CImageList* SetImageList(CImageList* pImageList);

Parameterar

pImageList
Pekare till bildlistan som ska tilldelas till flikkontrollen.

Returvärde

Returnerar en pekare till den tidigare bildlistan eller NULL om det inte finns någon tidigare bildlista.

CTabCtrl::SetItem

Anger vissa eller alla attribut för en flik.

BOOL SetItem(int nItem,   TCITEM* pTabCtrlItem);

Parameterar

nItem
Nollbaserat index för objektet.

pTabCtrlItem
Pekare till en TCITEM struktur som innehåller de nya objektattributen. Medlemmen mask anger vilka attribut som ska anges. mask Om medlemmen anger TCIF_TEXT värdet pszText är medlemmen adressen till en null-avslutad sträng och cchTextMax medlemmen ignoreras.

Returvärde

Nonzero om det lyckas; annars 0.

Exempel

Se exemplet för GetItem.

CTabCtrl::SetItemExtra

Anger antalet byte per flik som är reserverad för programdefinierade data i en flikkontroll.

BOOL SetItemExtra(int nBytes);

Parameterar

nBytes
Antalet extra byte som ska anges.

Returvärde

Nonzero om det lyckas; annars noll.

Anmärkningar

Den här medlemsfunktionen implementerar beteendet för Win32-meddelandet TCM_SETITEMEXTRA, enligt beskrivningen i Windows SDK.

CTabCtrl::SetItemSize

Anger bredd och höjd för flikkontrollobjekten.

CSize SetItemSize(CSize size);

Parameterar

size
Den nya bredden och höjden, i bildpunkter, för flikkontrollobjekten.

Returvärde

Returnerar den gamla bredden och höjden på flikkontrollobjekten.

CTabCtrl::SetItemState

Anger tillståndet för flikkontrollobjektet som identifieras av nItem.

BOOL SetItemState(
    int nItem,
    DWORD dwMask,
    DWORD dwState);

Parameterar

nItem
Det nollbaserade indexnumret för det objekt som tillståndsinformationen ska anges för.

dwMask
Mask som anger vilken av objektets tillståndsflaggor som ska anges. En lista med värden finns i maskmedlemmen i TCITEM strukturen enligt beskrivningen i Windows SDK.

dwState
En referens till ett DWORD-värde som innehåller tillståndsinformationen. Kan vara något av följande värden:

Returvärde

Nonzero om det lyckas; annars 0.

CTabCtrl::SetMinTabWidth

Anger den minsta bredden för objekt i en flikkontroll.

int SetMinTabWidth(int cx);

Parameterar

cx
Minsta bredd som ska anges för ett flikkontrollobjekt. Om den här parametern är inställd på -1 använder kontrollen standardflikbredden.

Returvärde

Föregående minsta flikbredd.

Anmärkningar

Den här medlemsfunktionen implementerar beteendet för Win32-meddelandet TCM_SETMINTABWIDTH, enligt beskrivningen i Windows SDK.

CTabCtrl::SetPadding

Anger mängden utrymme (utfyllnad) runt varje fliks ikon och etikett i en flikkontroll.

void SetPadding(CSize size);

Parameterar

size
Anger mängden utrymme (utfyllnad) runt varje fliks ikon och etikett i en flikkontroll.

CTabCtrl::SetToolTips

Tilldelar en knappbeskrivningskontroll till en flikkontroll.

void SetToolTips(CToolTipCtrl* pWndTip);

Parameterar

pWndTip
Handtaget på verktygets spetskontroll.

Anmärkningar

Du kan få knappbeskrivningskontrollen associerad med en flikkontroll genom att göra ett anrop till GetToolTips.

Exempel

Se exemplet för CPropertySheet::GetTabControl.

Se även

CWnd klass
CHeaderCtrl klass
CListCtrl klass
hierarkidiagram