Klasa CMFCRibbonCategory

Klasa CMFCRibbonCategory implementuje kartę wstążki zawierającą grupę paneli wstążki.

Składnia

class CMFCRibbonCategory : public CObject

Członkowie

Konstruktory chronione

Nazwa/nazwisko opis
CMFCRibbonCategory::CMFCRibbonCategory Konstruktor.

Metody publiczne

Nazwa/nazwisko opis
CMFCRibbonCategory::AddHidden Dodaje ukryty element do kategorii wstążki.
CMFCRibbonCategory::AddPanel Dodaje nowy panel do kategorii wstążki.
CMFCRibbonCategory::CopyFrom
CMFCRibbonCategory::FindByData
CMFCRibbonCategory::FindByID
CMFCRibbonCategory::FindPanelWithElem
CMFCRibbonCategory::GetContextID Zwraca identyfikator kontekstu kategorii wstążki.
CMFCRibbonCategory::GetData Zwraca dane zdefiniowane przez użytkownika skojarzone z kategorią wstążki.
CMFCRibbonCategory::GetDroppedDown
CMFCRibbonCategory::GetElements
CMFCRibbonCategory::GetElementsByID
CMFCRibbonCategory::GetFirstVisibleElement Uzyskaj pierwszy widoczny element należący do kategorii wstążki.
CMFCRibbonCategory::GetFocused Zwraca element fokusu.
CMFCRibbonCategory::GetHighlighted Zwraca wyróżniony element.
CMFCRibbonCategory::GetImageCount
CMFCRibbonCategory::GetImageSize
CMFCRibbonCategory::GetItemIDsList
CMFCRibbonCategory::GetLastVisibleElement Uzyskiwanie ostatniego widocznego elementu należącego do kategorii wstążki
CMFCRibbonCategory::GetLargeImages Zwraca odwołanie do listy dużych obrazów używanych przez kategorię wstążki.
CMFCRibbonCategory::GetMaxHeight
CMFCRibbonCategory::GetName
CMFCRibbonCategory::GetPanel Zwraca wskaźnik do panelu wstążki znajdującego się w określonym indeksie.
CMFCRibbonCategory::GetPanelCount Zwraca liczbę paneli wstążki w kategorii wstążki.
CMFCRibbonCategory::GetPanelFromPoint
CMFCRibbonCategory::GetPanelIndex Zwraca indeks określonego panelu wstążki.
CMFCRibbonCategory::GetParentButton
CMFCRibbonCategory::GetParentMenuBar
CMFCRibbonCategory::GetParentRibbonBar
CMFCRibbonCategory::GetRect
CMFCRibbonCategory::GetSmallImages Zwraca odwołanie do listy małych obrazów używanych przez kategorię.
CMFCRibbonCategory::GetTabColor Zwraca bieżący kolor karty kategorii wstążki.
CMFCRibbonCategory::GetTabRect
CMFCRibbonCategory::GetTextTopLine
CMFCRibbonCategory::GetVisibleElements Uzyskaj wszystkie widoczne elementy należące do kategorii wstążki.
CMFCRibbonCategory::HighlightPanel
CMFCRibbonCategory::HitTest
CMFCRibbonCategory::HitTestEx
CMFCRibbonCategory::HitTestScrollButtons
CMFCRibbonCategory::IsActive
CMFCRibbonCategory::IsVisible Określa, czy kategoria wstążki jest widoczna.
CMFCRibbonCategory::IsWindows7Look Wskazuje, czy wstążka nadrzędna ma wygląd w stylu windows 7 (mały prostokątny przycisk aplikacji)
CMFCRibbonCategory::NotifyControlCommand
CMFCRibbonCategory::OnCancelMode
CMFCRibbonCategory::OnDraw
CMFCRibbonCategory::OnDrawImage
CMFCRibbonCategory::OnDrawMenuBorder
CMFCRibbonCategory::OnKey Wywoływana przez platformę, gdy użytkownik naciska przycisk klawiatury.
CMFCRibbonCategory::OnLButtonDown
CMFCRibbonCategory::OnLButtonUp
CMFCRibbonCategory::OnMouseMove
CMFCRibbonCategory::OnRTLChanged
CMFCRibbonCategory::OnScrollHorz
CMFCRibbonCategory::OnUpdateCmdUI
CMFCRibbonCategory::RecalcLayout
CMFCRibbonCategory::RemovePanel
CMFCRibbonCategory::ReposPanels
CMFCRibbonCategory::SetCollapseOrder Definiuje kolejność zwijania paneli wstążki znajdujących się w kategorii wstążki.
CMFCRibbonCategory::SetData Przechowuje dane zdefiniowane przez użytkownika w kategorii wstążki.
CMFCRibbonCategory::SetKeys Przypisuje etykietkę klucza do kategorii wstążki.
CMFCRibbonCategory::SetName
CMFCRibbonCategory::SetTabColor Ustawia kolor kategorii wstążki.

Uwagi

Zazwyczaj kategoria wstążki jest tworzona pośrednio przez wywołanie metody CMFCRibbonBar::AddCategory, która zwraca wskaźnik do nowo utworzonej kategorii wstążki. Panele są dodawane do kategorii przez wywołanie polecenia CMFCRibbonCategory::AddPanel.

Klasa CMFCRibbonTab rysuje kategorie wstążki. Pochodzi on z klasy CMFCRibbonBaseElement.

W poniższym przykładzie pokazano, jak utworzyć kategorię wstążki i dodać do niej panel.

// Create a new ribbon category and get a pointer to it`
CMFCRibbonCategory* pCategory = m_wndRibbonBar.AddCategory
    (_T("&Write"),           // Category name
    IDB_WRITE,               // Category small images (16 x 16)
    IDB_WRITE_LARGE);        // Category large images (32 x 32)

// Add a panel to the new category
CMFCRibbonPanel* pPanel = pCategory->AddPanel (
    _T("Clipboard"),                // Panel name
    m_PanelIcons.ExtractIcon (0));  // Panel icon

Na poniższym diagramie przedstawiono rysunek kategorii Narzędzia główne z przykładowej aplikacji RibbonApp.

Home category from the RibbonApp sample application.

Hierarchia dziedziczenia

Cobject

CMFCRibbonCategory

Wymagania

Nagłówek: afxribboncategory.h

CMFCRibbonCategory::AddHidden

Dodaje określony element wstążki do tablicy elementów wstążki wyświetlanych w oknie dialogowym dostosowywania.

void AddHidden(CMFCRibbonBaseElement* pElem);

Parametry

pElem
[in] Wskaźnik do elementu wstążki.

Uwagi

Elementy wstążki w oknie dialogowym dostosowywania to polecenia, które można dodać do paska narzędzi szybkiego dostępu.

CMFCRibbonCategory::AddPanel

Tworzy panel wstążki dla kategorii wstążki.

CMFCRibbonPanel* AddPanel(
    LPCTSTR lpszPanelName,
    HICON hIcon = 0,
    CRuntimeClass* pRTI = NULL);

Parametry

lpszPanelName
[in] Wskaźnik do nazwy nowego panelu wstążki.

hIcon
[in] Dojmij do domyślnej ikony nowego panelu wstążki.

pRTI
[in] Wskaźnik do informacji o klasie środowiska uruchomieniowego dla niestandardowego panelu wstążki.

Wartość zwracana

Wskaźnik do nowego panelu wstążki, jeśli metoda zakończyła się pomyślnie; w przeciwnym razie wartość NULL, jeśli panel nie został utworzony.

Uwagi

Jeśli chcesz utworzyć niestandardowy panel wstążki, musisz określić informacje o klasie środowiska uruchomieniowego w narzędziu pRTI. Niestandardowa klasa panelu wstążki musi pochodzić z CMFCRibbonPanel klasy .

Ikona domyślna panelu wstążki jest wyświetlana, gdy brakuje miejsca do wyświetlenia elementów wstążki.

Przykład

W poniższym przykładzie pokazano, jak używać AddPanel metody w CMFCRibbonCategory klasie .

// Create "Favorites" panel:
strTemp.LoadString(IDS_RIBBON_FAVORITES);
// CMFCRibbonCategory* pCategoryCustom
CMFCRibbonPanel *pPanelFavorites = pCategoryCustom->AddPanel(strTemp,
                                                             m_PanelImages.ExtractIcon(15));

CMFCRibbonCategory::CMFCRibbonCategory

Tworzy i inicjuje obiekt CMFCRibbonCategory .

CMFCRibbonCategory(
    CMFCRibbonBar* pParenrRibbonBar,
    LPCTSTR lpszName,
    UINT uiSmallImagesResID,
    UINT uiLargeImagesResID,
    CSize sizeSmallImage = CSize(16,
    16),
    CSize sizeLargeImage = CSize(32,
    32));

Parametry

pParenrRibbonBar
[in] Wskaźnik do nadrzędnego paska wstążki kategorii wstążki.

Lpszname
[in] Nazwa kategorii wstążki.

uiSmallImagesResID
[in] Identyfikator zasobu listy obrazów dla małych obrazów używanych przez elementy wstążki w kategorii wstążki.

uiLargeImagesResID
[in] Identyfikator zasobu listy obrazów dla dużych obrazów używanych przez elementy wstążki w kategorii wstążki.

sizeSmallImage
[in] Domyślny rozmiar małych obrazów dla elementów wstążki w kategorii wstążki.

sizeLargeImage
[in] Domyślny rozmiar dużych obrazów dla elementów wstążki w kategorii wstążki.

CMFCRibbonCategory::CopyFrom

Kopiuje stan określonego obiektu CMFCRibbonCategory do bieżącego obiektu CMFCRibbonCategory.

virtual void CopyFrom(CMFCRibbonCategory& src);

Parametry

Src
[in] Obiekt źródłowy CMFCRibbonCategory .

Uwagi

CMFCRibbonCategory::FindByData

Pobiera element wstążki skojarzony z określonymi danymi.

CMFCRibbonBaseElement* FindByData(
    DWORD_PTR dwData,
    BOOL bVisibleOnly = TRUE) const;

Parametry

dwData
[in] Dane skojarzone z elementem wstążki.

bVisibleOnly
[in] WARTOŚĆ TRUE do uwzględnienia elementów wstążki szybkiego dostępu w wyszukiwaniu; FAŁSZ do wykluczenia elementów wstążki szybkiego dostępu w wyszukiwaniu.

Wartość zwracana

Wskaźnik do elementu wstążki, jeśli metoda zakończyła się pomyślnie; w przeciwnym razie wartość NULL.

Uwagi

CMFCRibbonCategory::FindByID

Pobiera element wstążki skojarzony z określonym identyfikatorem polecenia.

CMFCRibbonBaseElement* FindByID(
    UINT uiCmdID,
    BOOL bVisibleOnly = TRUE) const;

Parametry

uiCmdID
[in] Identyfikator polecenia skojarzony z elementem wstążki.

bVisibleOnly
[in] WARTOŚĆ TRUE do uwzględnienia elementów wstążki szybkiego dostępu w wyszukiwaniu; FAŁSZ do wykluczenia elementów wstążki szybkiego dostępu w wyszukiwaniu.

Wartość zwracana

Wskaźnik do elementu wstążki, jeśli metoda zakończyła się pomyślnie; w przeciwnym razie wartość NULL.

Uwagi

CMFCRibbonCategory::FindPanelWithElem

Pobiera panel wstążki zawierający określony element wstążki.

CMFCRibbonPanel* FindPanelWithElem(const CMFCRibbonBaseElement* pElement);

Parametry

pElement
[in] Wskaźnik do elementu wstążki.

Wartość zwracana

Wskaźnik do panelu wstążki, jeśli metoda zakończyła się pomyślnie; w przeciwnym razie wartość NULL.

Uwagi

CMFCRibbonCategory::GetContextID

Pobiera identyfikator kontekstu kategorii wstążki.

UINT GetContextID() const;

Wartość zwracana

Identyfikator kontekstu kategorii wstążki.

Uwagi

Identyfikator kontekstu to 0, jeśli kategoria wstążki nie jest kategorią wstążki kontekstowej.

CMFCRibbonCategory::GetData

Pobiera dane zdefiniowane przez użytkownika skojarzone z kategorią wstążki.

DWORD_PTR GetData() const;

Wartość zwracana

Dane zdefiniowane przez użytkownika skojarzone z kategorią wstążki.

CMFCRibbonCategory::GetDroppedDown

Pobiera wskaźnik do elementu wstążki, który obecnie ma wyświetlone menu podręczne.

CMFCRibbonBaseElement* GetDroppedDown();

Wartość zwracana

Wskaźnik do elementu wstążki, jeśli metoda zakończyła się pomyślnie; w przeciwnym razie wartość NULL.

Uwagi

CMFCRibbonCategory::GetElements

Pobiera wszystkie elementy wstążki w kategorii wstążki.

void GetElements(
    CArray <CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);

Parametry

arElements
[in, out] Odwołanie do obiektu CArray elementów wstążki.

Uwagi

Elementy wstążki przeznaczone do użycia na pasku narzędzi szybkiego dostępu znajdują się w tablicy.

CMFCRibbonCategory::GetElementsByID

Pobiera wszystkie elementy wstążki skojarzone z określonym identyfikatorem polecenia.

void GetElementsByID(
    UINT uiCmdID,
    CArray <CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);

Parametry

uiCmdID
[in] Identyfikator polecenia skojarzony z elementem wstążki.

arElements
[in, out] Odwołanie do obiektu CArray elementów wstążki.

Uwagi

Elementy wstążki przeznaczone do użycia na pasku narzędzi szybkiego dostępu znajdują się w tablicy.

CMFCRibbonCategory::GetFirstVisibleElement

Pobiera pierwszy widoczny element należący do kategorii wstążki.

CMFCRibbonBaseElement* GetFirstVisibleElement() const;

Wartość zwracana

Wskaźnik do pierwszego widocznego elementu; może mieć wartość NULL, jeśli kategoria nie ma żadnych widocznych elementów.

Uwagi

CMFCRibbonCategory::GetFocused

Zwraca element fokusu.

CMFCRibbonBaseElement* GetFocused();

Wartość zwracana

Wskaźnik do elementu ukierunkowanego lub wartości NULL.

Uwagi

CMFCRibbonCategory::GetHighlighted

Zwraca wyróżniony element.

CMFCRibbonBaseElement* GetHighlighted();

Wartość zwracana

Wskaźnik do wyróżnionego elementu lub wartości NULL, jeśli nie wyróżniono żadnych elementów.

Uwagi

CMFCRibbonCategory::GetImageCount

Pobiera liczbę obrazów na określonej liście obrazów, która znajduje się w kategorii wstążki.

int GetImageCount(BOOL bIsLargeImage) const;

Parametry

bIsLargeImage
[in] WARTOŚĆ TRUE dla liczby obrazów na dużej liście obrazów; FAŁSZ dla liczby obrazów na małej liście obrazów.

Wartość zwracana

Liczba obrazów na określonej liście obrazów.

Uwagi

CMFCRibbonCategory::GetImageSize

Pobiera rozmiar obrazu na określonej liście obrazów, który znajduje się w kategorii wstążki.

CSize GetImageSize(BOOL bIsLargeImage) const;

Parametry

bIsLargeImage
[in] WARTOŚĆ TRUE dla rozmiaru dużych obrazów; FAŁSZ dla rozmiaru małych obrazów.

Wartość zwracana

Rozmiar obrazu na określonej liście obrazów.

Uwagi

Pobrany rozmiar obejmuje globalny współczynnik skalowania obrazów.

CMFCRibbonCategory::GetItemIDsList

Pobiera identyfikatory poleceń dla elementów wstążki, które znajdują się w kategorii wstążki.

void GetItemIDsList(
    CList<UINT, UINT>& lstItems,
    BOOL bHiddenOnly = FALSE) const;

Parametry

lstItems
[out] Lista identyfikatorów poleceń dla elementów wstążki w kategorii wstążki.

bHiddenOnly
[in] WARTOŚĆ TRUE wyklucza elementy wstążki wyświetlane na panelach wstążki w kategorii wstążki; FAŁSZ, aby uwzględnić wszystkie elementy wstążki w kategorii wstążki.

Uwagi

CMFCRibbonCategory::GetLargeImages

Pobiera listę dużych obrazów znajdujących się w kategorii wstążki.

CMFCToolBarImages& GetLargeImages();

Wartość zwracana

Lista dużych obrazów zawartych w kategorii wstążki.

CMFCRibbonCategory::GetLastVisibleElement

Pobiera ostatni widoczny element należący do kategorii wstążki.

CMFCRibbonBaseElement* GetLastVisibleElement() const;

Wartość zwracana

Wskaźnik do ostatniego widocznego elementu; może mieć wartość NULL, jeśli kategoria nie ma żadnych widocznych elementów.

Uwagi

CMFCRibbonCategory::GetMaxHeight

Pobiera maksymalną wysokość paneli wstążki znajdujących się w kategorii wstążki.

int GetMaxHeight(CDC* pDC);

Parametry

Pdc
[in] Wskaźnik do kontekstu urządzenia dla paneli wstążki.

Wartość zwracana

Maksymalna wysokość paneli wstążki zawartych w kategorii wstążki.

Uwagi

Pobrana wartość zawiera wysokość górnego i dolnego marginesu paneli wstążki.

CMFCRibbonCategory::GetName

Pobiera nazwę kategorii wstążki.

LPCTSTR GetName() const;

Wartość zwracana

Nazwa kategorii wstążki.

Uwagi

CMFCRibbonCategory::GetPanel

Zwraca wskaźnik do panelu wstążki znajdującego się w określonym indeksie.

CMFCRibbonPanel* GetPanel(int nIndex);

Parametry

Nindex
[in] Indeks zerowy panelu wstążki.

Wartość zwracana

Wskaźnik do panelu wstążki, który znajduje się w określonym indeksie.

Uwagi

Wyjątek jest zgłaszany, jeśli nIndex jest poza zakresem.

CMFCRibbonCategory::GetPanelCount

Zwraca liczbę paneli wstążki w kategorii wstążki.

int GetPanelCount() const;

Wartość zwracana

Liczba paneli wstążki w kategorii wstążki.

CMFCRibbonCategory::GetPanelFromPoint

Pobiera wskaźnik do panelu wstążki, jeśli określony punkt znajduje się w nim.

CMFCRibbonPanel* GetPanelFromPoint(CPoint point) const;

Parametry

Punkt
[in] Współrzędne x i y wskaźnika względem lewego górnego rogu okna.

Wartość zwracana

Wskaźnik do panelu wstążki, jeśli metoda zakończyła się pomyślnie; w przeciwnym razie wartość NULL.

Uwagi

Testowane są tylko panele wstążki znajdujące się w kategorii wstążki.

CMFCRibbonCategory::GetPanelIndex

Pobiera indeks zerowy określonego panelu wstążki.

int GetPanelIndex(const CMFCRibbonPanel* pPanel) const;

Parametry

pPanel
[in] Wskaźnik do panelu wstążki.

Wartość zwracana

Indeks na podstawie zera określonego panelu wstążki, jeśli metoda zakończyła się pomyślnie; w przeciwnym razie -1.

Uwagi

Przeszukiwane są tylko panele wstążki znajdujące się w kategorii wstążki.

CMFCRibbonCategory::GetParentButton

Pobiera element nadrzędnej wstążki kategorii wstążki.

CMFCRibbonBaseElement* GetParentButton() const;

Wartość zwracana

Zwraca wskaźnik do nadrzędnego elementu wstążki lub wartość NULL, jeśli nie ma elementu nadrzędnego.

Uwagi

CMFCRibbonCategory::GetParentMenuBar

Zwraca wskaźnik do nadrzędnego CMFCRibbonCategory paska menu obiektu.

CMFCRibbonPanelMenuBar* GetParentMenuBar() const;

Wartość zwracana

Zwraca zawartość chronionego m_pParentMenuBar elementu członkowskiego.

Uwagi

CMFCRibbonCategory::GetParentRibbonBar

Pobiera nadrzędny pasek wstążki dla kategorii wstążki.

CMFCRibbonBar* GetParentRibbonBar() const;

Wartość zwracana

Wskaźnik do nadrzędnego paska wstążki dla kategorii wstążki.

Uwagi

CMFCRibbonCategory::GetRect

Pobiera prostokąt wyświetlania dla kategorii wstążki.

CRect GetRect() const;

Wartość zwracana

Prostokąt wyświetlania kategorii wstążki.

Uwagi

Prostokąt wyświetlania kategorii wstążki nie zawiera karty kategorii.

CMFCRibbonCategory::GetSmallImages

Pobiera listę małych obrazów znajdujących się w kategorii wstążki.

CMFCToolBarImages& GetSmallImages();

Wartość zwracana

Lista małych obrazów zawartych w kategorii wstążki.

CMFCRibbonCategory::GetTabColor

Zwraca bieżący kolor karty kategorii wstążki.

AFX_RibbonCategoryColor GetTabColor() const;

Wartość zwracana

Bieżący kolor karty kategorii wstążki.

Uwagi

Zwrócona wartość może być jedną z następujących wyliczonych wartości:

  • AFX_CategoryColor_Red

  • AFX_CategoryColor_Orange

  • AFX_CategoryColor_Yellow

  • AFX_CategoryColor_Green

  • AFX_CategoryColor_Blue

  • AFX_CategoryColor_Indigo

  • AFX_CategoryColor_Violet

CMFCRibbonCategory::GetTabRect

Pobiera prostokąt wyświetlania dla karty kategorii wstążki.

CRect GetTabRect() const;

Wartość zwracana

Prostokąt wyświetlania dla karty kategorii wstążki.

Uwagi

CMFCRibbonCategory::GetTextTopLine

Pobiera pionową lokalizację tekstu na przyciskach wstążki w kategorii wstążki, które wyświetlają duże obrazy.

int GetTextTopLine() const;

Wartość zwracana

Pionowa lokalizacja tekstu w pikselach na przyciskach wstążki, które wyświetlają duże obrazy.

Uwagi

CMFCRibbonCategory::GetVisibleElements

Pobiera wszystkie widoczne elementy należące do kategorii wstążki.

void GetVisibleElements(
    CArray <CMFCRibbonBaseElement*,
    CMFCRibbonBaseElement*>& arElements);

Parametry

arElements
Tablica wszystkich widocznych elementów.

Uwagi

CMFCRibbonCategory::HighlightPanel

Wyróżnia określony panel wstążki.

CMFCRibbonPanel* HighlightPanel(
    CMFCRibbonPanel* pHLPanel,
    CPoint point);

Parametry

pHLPanel
[in] Wskaźnik do panelu wstążki w celu wyróżnienia.

Punkt
[in] Współrzędne x i y wskaźnika względem lewego górnego rogu okna.

Wartość zwracana

Wskaźnik do wcześniej wyróżnionego panelu wstążki; w przeciwnym razie wartość NULL, jeśli po wywołaniu tej metody nie zostanie wyróżniony panel wstążki.

Uwagi

Aby uzyskać więcej informacji na temat wyróżniania panelu wstążki, zobacz CMFCRibbonPanel::Highlight.

CMFCRibbonCategory::HitTest

Pobiera wskaźnik do elementu wstążki, jeśli określony punkt znajduje się w nim.

CMFCRibbonBaseElement* HitTest(
    CPoint point,
    BOOL bCheckPanelCaption = FALSE) const;

Parametry

Punkt
[in] Współrzędne x i y wskaźnika myszy względem lewego górnego rogu okna.

bCheckPanelCaption
[in] WARTOŚĆ TRUE do testowania podpis panelu wstążki; FAŁSZ wyklucza podpis panelu wstążki.

Wartość zwracana

Wskaźnik do elementu wstążki, jeśli metoda zakończyła się pomyślnie; w przeciwnym razie wartość NULL.

Uwagi

Testowane są tylko elementy wstążki znajdujące się w kategorii wstążki.

CMFCRibbonCategory::HitTestEx

Pobiera indeks zerowy elementu wstążki, jeśli określony punkt znajduje się w nim.

int HitTestEx(CPoint point) const;

Parametry

Punkt
[in] Współrzędne x i y wskaźnika myszy względem lewego górnego rogu okna.

Wartość zwracana

Indeks wstążki oparty na zera, jeśli metoda zakończyła się pomyślnie; w przeciwnym razie -1.

Uwagi

Testowane są tylko elementy wstążki znajdujące się w kategorii wstążki.

CMFCRibbonCategory::HitTestScrollButtons

Jeśli punkt znajduje się w lewym lub prawym przycisku przewijania kategorii wstążki, zwraca wskaźnik do tego przycisku.

CMFCRibbonBaseElement* HitTestScrollButtons(CPoint point) const;

Parametry

Punkt
[in] Punkt do przetestowania.

Wartość zwracana

Jeśli punkt mieści się w obrębie prostokąta ograniczenia lewego lub prawego przycisku przewijania kategorii wstążki, zwraca wskaźnik do tego przycisku lub w inny sposób zwraca wartość NULL.

Uwagi

CMFCRibbonCategory::IsActive

Wskazuje, czy kategoria wstążki jest aktywną kategorią na pasku wstążki.

BOOL IsActive() const;

Wartość zwracana

Wartość TRUE, jeśli kategoria wstążki jest aktywną kategorią; w przeciwnym razie FAŁSZ.

Uwagi

Aktywna kategoria wstążki wyświetla panele wstążki.

CMFCRibbonCategory::IsVisible

Wskazuje, czy kategoria wstążki jest widoczna.

BOOL IsVisible() const;

Wartość zwracana

WARTOŚĆ TRUE, jeśli kategoria wstążki jest widoczna; w przeciwnym razie FAŁSZ.

Uwagi

Kategorie wstążki, które są widoczne, wyświetlają kartę kategorii.

CMFCRibbonCategory::IsWindows7Look

Wskazuje, czy wstążka nadrzędna ma wygląd systemu Windows 7 (mały prostokątny przycisk aplikacji).

BOOL IsWindows7Look() const;

Wartość zwracana

WARTOŚĆ TRUE, jeśli nadrzędna wstążka ma wygląd systemu Windows 7; w przeciwnym razie FAŁSZ.

Uwagi

CMFCRibbonCategory::NotifyControlCommand

Dostarcza komunikat polecenia WM_NOTIFY do wszystkich CMFCRibbonPanel elementów w CMFCRibbonCategory obiekcie , dopóki komunikat nie zostanie obsłużony.

virtual BOOL NotifyControlCommand(
    BOOL bAccelerator,
    int nNotifyCode,
    WPARAM wParam,
    LPARAM lParam);

Parametry

bAccelerator
[in] WARTOŚĆ TRUE, jeśli to polecenie pochodzi z akceleratora lub FALSE w przeciwnym razie.

nNotifyCode
[in] Kod powiadomienia.

Wparam
[in] Pole WPARAM komunikatu.

Lparam
[in] Pole LPARAM komunikatu.

Wartość zwracana

Zwraca wartość TRUE, jeśli komunikat został obsłużony lub FALSE, jeśli nie.

Uwagi

CMFCRibbonCategory::OnCancelMode

Wywołuje tryb anulowania we wszystkich CMFCRibbonPanel elementach .CMFCRibbonCategory

virtual void OnCancelMode();

Uwagi

CMFCRibbonCategory::OnDraw

Wywoływana przez strukturę w celu narysowania kategorii wstążki.

virtual void OnDraw(CDC* pDC);

Parametry

Pdc
[in] Wskaźnik do kontekstu urządzenia dla kategorii wstążki.

Uwagi

CMFCRibbonCategory::OnDrawImage

Wywoływana przez strukturę w celu narysowania określonego obrazu w kategorii wstążki.

virtual BOOL OnDrawImage(
    CDC* pDC,
    CRect rect,
    CMFCRibbonBaseElement* pElement,
    BOOL bIsLargeImage,
    BOOL nImageIndex,
    BOOL bCenter);

Parametry

Pdc
[in] Wskaźnik do kontekstu urządzenia dla obrazu.

Rect
[in] Wyświetl prostokąt obrazu.

pElement
[in] Wskaźnik do elementu wstążki zawierającego obraz.

bIsLargeImage
[in] WARTOŚĆ TRUE, jeśli obraz ma duży rozmiar; FAŁSZ, jeśli obraz ma mały rozmiar.

nImageIndex
[in] Zerowy indeks obrazu w tablicy obrazów, który znajduje się w kategorii wstążki.

bCenter
[in] WARTOŚĆ TRUE, aby wyśrodkować obraz w prostokątze wyświetlania; FAŁSZ, aby narysować obraz w lewym górnym rogu prostokąta wyświetlania.

Wartość zwracana

Wartość TRUE, jeśli metoda zakończyła się pomyślnie; w przeciwnym razie FAŁSZ.

Uwagi

CMFCRibbonCategory::OnDrawMenuBorder

Wywoływana przez strukturę w celu narysowania obramowania menu podręcznego.

virtual void OnDrawMenuBorder(
    CDC* pDC,
    CMFCRibbonPanelMenuBar* pMenuBar);

Parametry

Pdc
[in] Ten parametr nie jest używany.

pMenuBar
[in] Ten parametr nie jest używany.

Uwagi

Domyślnie ta metoda nic nie robi. Zastąpij tę metodę, aby narysować obramowanie menu podręcznego.

CMFCRibbonCategory::OnKey

Wywoływana przez platformę, gdy użytkownik naciska przycisk klawiatury.

virtual BOOL OnKey(UINT nChar);

Parametry

Nchar
Kod klucza wirtualnego dla klucza, który użytkownik nacisnął.

Uwagi

CMFCRibbonCategory::OnLButtonDown

Wywoływana przez strukturę w celu pobrania elementu wstążki pod określonym punktem, gdy użytkownik naciska lewy przycisk myszy.

virtual CMFCRibbonBaseElement* OnLButtonDown(CPoint point);

Parametry

Punkt
[in] Współrzędne x i y wskaźnika myszy względem lewego górnego rogu okna.

Wartość zwracana

Wskaźnik do elementu wstążki, jeśli metoda zakończyła się pomyślnie; w przeciwnym razie wartość NULL.

Uwagi

CMFCRibbonCategory::OnLButtonUp

Wywoływana przez platformę, gdy użytkownik zwolni lewy przycisk myszy, a wskaźnik znajduje się nad kategorią wstążki.

virtual void OnLButtonUp(CPoint point);

Parametry

Punkt
[in] Współrzędne x i y wskaźnika względem lewego górnego rogu okna.

Uwagi

CMFCRibbonCategory::OnMouseMove

Wywoływana przez platformę, gdy wskaźnik przechodzi na pasku wstążki, aby zaktualizować wyświetlanie kategorii wstążki.

virtual void OnMouseMove(CPoint point);

Parametry

Punkt
[in] Współrzędne x i y wskaźnika względem lewego górnego rogu okna.

Uwagi

CMFCRibbonCategory::OnRTLChanged

Wywoływana przez platformę, gdy układ zmienia kierunek.

virtual void OnRTLChanged(BOOL bIsRTL);

Parametry

bIsRTL
[in] Wartość TRUE, jeśli układ jest od prawej do lewej; FAŁSZ, jeśli układ jest od lewej do prawej.

Uwagi

Ta metoda dostosowuje układ wszystkich paneli wstążki i elementów wstążki, które znajdują się w kategorii wstążki.

CMFCRibbonCategory::OnScrollHorz

Przewija kategorię wstążki w kierunku poziomym.

virtual BOOL OnScrollHorz(
    BOOL bScrollLeft,
    int nScrollOffset = 0);

Parametry

bScrollLeft
[in] Wartość TRUE, aby przewinąć do lewej strony; FAŁSZ, aby przewinąć w prawo.

nScrollOffset
[in] Odległość przewijania w pikselach.

Wartość zwracana

WARTOŚĆ TRUE, jeśli kategoria wstążki została przeniesiona w kierunku poziomym; w przeciwnym razie FAŁSZ.

Uwagi

CMFCRibbonCategory::OnUpdateCmdUI

OnUpdateCmdUI Wywołuje funkcję składową w każdym z CMFCRibbonPanel elementów elementu CMFCRibbonCategory , aby włączyć lub wyłączyć w nich elementy interfejsu użytkownika.

virtual void OnUpdateCmdUI(
    CMFCRibbonCmdUI* pCmdUI,
    CFrameWnd* pTarget,
    BOOL bDisableIfNoHndler);

Parametry

pCmdUI
[in] Wskaźnik do CMFCRibbonCmdUI obiektu, który określa, które elementy interfejsu użytkownika mają być włączone i które mają być wyłączone.

pTarget
[in] Wskaźnik do okna sterującego włączaniem lub wyłączaniem elementów interfejsu użytkownika.

bDisableIfNoHndler
[in] WARTOŚĆ TRUE, aby wyłączyć element interfejsu użytkownika, jeśli żadna procedura obsługi nie jest zdefiniowana na mapie komunikatów; w przeciwnym razie, FAŁSZ.

Uwagi

CMFCRibbonCategory::RecalcLayout

Dostosowuje układ wszystkich kontrolek w kategorii wstążki.

virtual void RecalcLayout(CDC* pDC);

Parametry

Pdc
[in] Wskaźnik do kontekstu urządzenia dla kategorii wstążki.

Uwagi

CMFCRibbonCategory::RemovePanel

Usuwa panel wstążki z kategorii wstążki.

BOOL RemovePanel(
    int nIndex,
    BOOL bDelete = TRUE);

Parametry

Nindex
[in] Numer indeksu panelu do usunięcia. Uzyskane przez wywołanie metody CMFCRibbonCategory::GetPanelIndex .

bDelete
[in] WARTOŚĆ TRUE, aby usunąć obiekt panelu z pamięci; FAŁSZ, aby usunąć obiekt panelu bez jego usunięcia.

Wartość zwracana

Wartość TRUE, jeśli metoda zakończyła się pomyślnie; w przeciwnym razie, FAŁSZ.

CMFCRibbonCategory::ReposPanels

Dostosowuje układ wszystkich kontrolek na panelach wstążki, które znajdują się w kategorii wstążki.

virtual void ReposPanels(CDC* pDC);

Parametry

Pdc
[in] Wskaźnik do kontekstu urządzenia dla paneli wstążki, które znajdują się w kategorii wstążki.

Uwagi

CMFCRibbonCategory::SetCollapseOrder

Definiuje kolejność zwijania paneli wstążki kategorii wstążki.

void SetCollapseOrder(const CArray<int,int>& arCollapseOrder);

Parametry

arCollapseOrder
[in] Określa kolejność zwijania. Tablica zawiera indeksy zerowe paneli wstążki.

Uwagi

Biblioteka definiuje kolejność zwijania. Można jednak dostosować to zachowanie, podając kategorię z listą indeksów, które określają kolejność zwijania.

Gdy kategoria wykryje, że musi zwinąć panel wstążki, szuka następnego elementu na określonej liście. Jeśli lista jest pusta lub nie określono wystarczającej liczby elementów, kategoria używa algorytmu wewnętrznego.

Na przykład kategoria ma trzy panele wstążki i może być zwinięta kilka razy, aż wszystkie panele będą w stanie w pełni zwiniętym. Można ustawić następującą kolejność zwijania: 0, 0, 2, 2. W takim przypadku kategoria będzie zwijać panel 0 dwa razy, panel 2 dwa razy. Panel, który ma indeks 1, pozostaje niepochłonięty.

Przykład

W poniższym przykładzie pokazano, jak używać SetCollapseOrder metody w CMFCRibbonCategory klasie . W przykładzie pokazano, jak utworzyć tablicę dla kolejności zwijania oraz jak ustawić kolejność zwijania na kategorię wstążki.

CArray<int, int> arCollapseOrder;
arCollapseOrder.Add(0);
arCollapseOrder.Add(1);
arCollapseOrder.Add(2);
// CMFCRibbonCategory* pCategoryHome
pCategoryHome->SetCollapseOrder(arCollapseOrder);

CMFCRibbonCategory::SetData

Ustawia dane zdefiniowane przez użytkownika do skojarzenia z kategorią wstążki.

void SetData(DWORD_PTR dwData);

Parametry

dwData
[in] Dane zdefiniowane przez użytkownika.

CMFCRibbonCategory::SetKeys

Przypisuje etykietkę klucza do kategorii wstążki.

void SetKeys(LPCTSTR lpszKeys);

Parametry

lpszKeys
[in] Tekst etykietki klucza.

Uwagi

Etykietki klawiszy są wyświetlane, gdy użytkownik naciska klawisz Alt lub klawisz F10.

CMFCRibbonCategory::SetName

Przypisuje nazwę i etykietkę klucza do kategorii wstążki.

void SetName(LPCTSTR lpszName);

Parametry

Lpszname
[in] Nazwa i etykietka klucza kategorii wstążki.

Uwagi

Aby ustawić etykietkę klucza dla kategorii wstążki, dołącz sekwencję ucieczki nowego wiersza, a następnie znaki etykietki klucza na lpszName.

CMFCRibbonCategory::SetTabColor

Ustawia kolor kategorii wstążki.

void SetTabColor(AFX_RibbonCategoryColor color);

Parametry

Kolor
[in] Określa nowy kolor kategorii wstążki.

Uwagi

Kolor może być jedną z następujących wartości:

  • AFX_CategoryColor_None

  • AFX_CategoryColor_Red

  • AFX_CategoryColor_Orange

  • AFX_CategoryColor_Yellow

  • AFX_CategoryColor_Green

  • AFX_CategoryColor_Blue

  • AFX_CategoryColor_Indigo

  • AFX_CategoryColor_Violet

Zobacz też

Wykres hierarchii
Klasy
Klasa CObject