Klasa CMFCRibbonGallery

Implementuje galerie wstążek w stylu pakietu Office 2007. Aby uzyskać więcej informacji, zobacz kod źródłowy znajdujący się w folderze VC\atlmfc\src\mfc instalacji programu Visual Studio.

Składnia

class CMFCRibbonGallery : public CMFCRibbonButton

Elementy członkowskie

Konstruktory publiczne

Nazwa/nazwisko	opis
CMFCRibbonGallery::CMFCRibbonGallery	Tworzy i inicjuje CMFCRibbonGallery obiekt.

Metody publiczne

Nazwa/nazwisko	opis
CMFCRibbonGallery::AddGroup	Dodaje nową grupę do galerii.
CMFCRibbonGallery::AddSubItem	Dodaje nowy element menu do menu rozwijanego.
CMFCRibbonGallery::Clear	Czyści zawartość galerii.
CMFCRibbonGallery::EnableMenuResize	Włącza lub wyłącza zmianę rozmiaru panelu menu.
CMFCRibbonGallery::EnableMenuSideBar	Włącza lub wyłącza pasek boczny po lewej stronie menu podręcznego.
CMFCRibbonGallery::GetCompactSize	(Przesłonięcia) CMFCRibbonButton::GetCompactSize.
CMFCRibbonGallery::GetDroppedDown	(Przesłonięcia) CMFCRibbonBaseElement::GetDroppedDown).
CMFCRibbonGallery::GetGroupName	Zwraca nazwę grupy, która znajduje się w określonym indeksie.
CMFCRibbonGallery::GetGroupOffset
CMFCRibbonGallery::GetIconsInRow	Zwraca liczbę elementów w wierszu galerii wstążki.
CMFCRibbonGallery::GetItemToolTip	Zwraca tekst etykietki narzędzia skojarzony z elementem w galerii.
CMFCRibbonGallery::GetLastSelectedItem	Zwraca indeks ostatniego elementu w galerii wybranej przez użytkownika.
CMFCRibbonGallery::GetPaletteID	Zwraca identyfikator polecenia bieżącej galerii.
CMFCRibbonGallery::GetRegularSize	(Przesłonięcia) CMFCRibbonButton::GetRegularSize.)
CMFCRibbonGallery::GetSelectedItem
CMFCRibbonGallery::HasMenu	(Przesłonięcia) CMFCRibbonButton::HasMenu.)
CMFCRibbonGallery::IsButtonMode	Określa, czy galeria jest zawarta w przycisku galerii.
CMFCRibbonGallery::IsMenuResizeEnabled	Określa, czy zmiana rozmiaru menu jest włączona, czy wyłączona.
CMFCRibbonGallery::IsMenuResizeVertical
CMFCRibbonGallery::IsMenuSideBar	Określa, czy pasek boczny jest włączony, czy wyłączony.
CMFCRibbonGallery::OnAfterChangeRect	(Przesłania CMFCRibbonButton::OnAfterChangeRect).
CMFCRibbonGallery::OnDraw	(Przesłonięcia) CMFCRibbonButton::OnDraw.
CMFCRibbonGallery::OnEnable	(Przesłania CMFCRibbonBaseElement::OnEnable).
CMFCRibbonGallery::OnRTLChanged	(Przesłonięcia) CMFCRibbonBaseElement::OnRTLChanged.
CMFCRibbonGallery::RedrawIcons	Ponownie rysuje galerię.
CMFCRibbonGallery::RemoveItemToolTips	Usuwa etykietki narzędzi ze wszystkich elementów w galerii.
CMFCRibbonGallery::SelectItem
CMFCRibbonGallery::SetACCData	(Przesłonięcia) CMFCRibbonButton::SetACCData.)
CMFCRibbonGallery::SetButtonMode	Określa, czy galeria wstążki ma być wyświetlana jako przycisk listy rozwijanej, czy jako paleta bezpośrednio na wstążce.
CMFCRibbonGallery::SetGroupName	Ustawia nazwę grupy.
CMFCRibbonGallery::SetIconsInRow	Definiuje liczbę elementów na wiersz w galerii.
CMFCRibbonGallery::SetItemToolTip	Ustawia tekst etykietki narzędzia dla elementu w galerii.
CMFCRibbonGallery::SetPalette	Dołącza paletę do galerii wstążki.
CMFCRibbonGallery::SetPaletteID	Definiuje identyfikator polecenia, który jest wysyłany w komunikacie WM_COMMAND po wybraniu elementu galerii.

Metody chronione

Nazwa/nazwisko	opis
CMFCRibbonGallery::OnDrawPaletteIcon	Wywoływana przez platformę, gdy zostanie narysowana ikona galerii.

Uwagi

Przycisk galerii działa podobnie jak zwykły przycisk menu, z tą różnicą, że wyświetla galerię po otwarciu go przez użytkownika. Po wybraniu elementu w galerii platforma wysyła komunikat WM_COMMAND wraz z identyfikatorem polecenia przycisku. Podczas obsługi komunikatu należy wywołać metodę CMFCRibbonGallery::GetLastSelectedItem , aby określić, który element został wybrany z galerii.

Przykład

W poniższym przykładzie pokazano, jak używać różnych metod w CMFCRibbonGallery klasie do konfigurowania CMFCRibbonGallery obiektu. W przykładzie pokazano, jak określić liczbę elementów na wiersz w galerii, włączyć zmianę rozmiaru panelu menu, włączyć pasek boczny po lewej stronie menu podręcznego i wyświetlić galerię wstążki jako paletę bezpośrednio na pasku wstążki. Ten fragment kodu jest częścią przykładu Draw Client.

CMFCRibbonGallery *pBtnStyles = new CMFCRibbonGallery(ID_OBJECT_STYLES, _T("Styles\nk"), 0, 0, IDB_STYLES, 40);
pBtnStyles->SetIconsInRow(7);
pBtnStyles->EnableMenuResize(TRUE, TRUE);
pBtnStyles->EnableMenuSideBar();
pBtnStyles->SetButtonMode(false);
pBtnStyles->RedrawIcons();

Hierarchia dziedziczenia

Obiekt CObject
└ CMFCRibbonBaseElement
 └ CMFCRibbonButton
  └ CMFCRibbonGallery

Wymagania

Nagłówek: afxRibbonPaletteGallery.h

CMFCRibbonGallery::AddGroup

Dodaje nową grupę do galerii.

void AddGroup(
    LPCTSTR lpszGroupName,
    UINT uiImagesPaletteResID,
    int cxPaletteImage);

void AddGroup(
    LPCTSTR lpszGroupName,
    CMFCToolBarImages& imagesGroup);

void AddGroup(
    LPCTSTR lpszGroupName,
    int nIconsNum);

Parametry

lpszGroupName
[in] Określa nazwę grupy.

uiImagesPaletteResID
[in] Określa identyfikator zasobu listy obrazów, która zawiera obrazy dla grupy.

cxPaletteImage
[in] Określa szerokość obrazu w pikselach.

imagesGroup
[in] Odwołanie do listy obrazów zawierającej obrazy grupowe.

nIconsNum
[in] Określa liczbę ikon w grupie. Ten parametr powinien być określony tylko dla grup niestandardowych (rysowanych przez właściciela).

Uwagi

Elementy w galerii wstążki można podzielić na wiele grup, wywołując tę metodę. Każda grupa może mieć podpis.

CMFCRibbonGallery::AddSubItem

Dodaje nowy element menu do menu rozwijanego.

void AddSubItem(
    CMFCRibbonBaseElement* pSubItem,
    int nIndex=-1,
    BOOL bOnTop=FALSE);

Parametry

pSubItem
[in] Wskaźnik do elementu, który ma zostać dodany do menu.

nIndex
[in] Określa indeks zerowy lokalizacji, w której ma być wstawiony element.

bOnTop
[in] WARTOŚĆ TRUE określająca, że element powinien zostać wstawiony przed galerią wstążki; w przeciwnym razie, FAŁSZ.

Uwagi

Galerie podręczne można łączyć z elementami menu podręcznego, wywołując tę metodę. Elementy menu można umieścić przed galerią lub po nim.

Aby wstawić element przed galerią, ustaw wartość bOnTop na true. Ustaw wartość bOnTop na FALSE, aby wstawić element poniżej galerii.

Uwaga

Parametr nIndex określa indeks wstawiania zarówno w górnej części galerii, jak i w dolnej części galerii. Jeśli na przykład musisz wstawić element na jedną pozycję przed galerią, ustaw wartość nIndex na 1 i wartość bOnTop na true. Podobnie, jeśli musisz wstawić element na jedną pozycję poniżej galerii, ustaw nIndex na 1 i bOnTop na FALSE.

CMFCRibbonGallery::Clear

Czyści zawartość galerii.

virtual void Clear();

Uwagi

Wywołaj tę metodę, aby usunąć całą zawartość z galerii wstążki. Należy to zrobić przed dołączeniem nowej galerii wstążki lub zestawu grup do galerii wstążki.

CMFCRibbonGallery::CMFCRibbonGallery

Tworzy i inicjuje obiekt CMFCRibbonGallery .

CMFCRibbonGallery (
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex,
    int nLargeImageIndex,
    CMFCToolBarImages& imagesPalette);

CMFCRibbonGallery (
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex,
    int nLargeImageIndex,
    UINT uiImagesPaletteResID=0,
    int cxPaletteImage=0);

CMFCRibbonGallery (
    UINT nID,
    LPCTSTR lpszText,
    int nSmallImageIndex,
    int nLargeImageIndex,
    CSize sizeIcon,
    int nIconsNum,
    BOOL bDefaultButtonStyle=TRUE);

Parametry

Nid
Określa identyfikator polecenia do wykonania, gdy użytkownik kliknie przycisk.

lpszText
Określa tekst, który ma być wyświetlany na przycisku.

nSmallImageIndex
Indeks na podstawie zera małego obrazu, który ma być wyświetlany na przycisku.

nLargeImageIndex
Indeks zera dużego obrazu, który ma być wyświetlany na przycisku.

imagesPalette
Odwołanie do obiektu CMFCToolBarImages zawierającego obrazy do wyświetlenia w galerii.

uiImagesPaletteResID
Identyfikator zasobu listy obrazów do wyświetlenia w galerii.

cxPaletteImage
Określa szerokość obrazu w pikselach w galerii.

sizeIcon
Określa rozmiar obrazu galerii w pikselach.

nIconsNum
Określa liczbę ikon w galerii.

bDefaultButtonStyle
Określa, czy używać domyślnego, czy rysowanego przez właściciela stylu przycisku.

Uwagi

CMFCRibbonGallery::EnableMenuResize

Włącza lub wyłącza zmianę rozmiaru panelu menu.

void EnableMenuResize(
    BOOL bEnable = TRUE,
    BOOL bVertcalOnly = FALSE);

Parametry

bEnable
[in] WARTOŚĆ TRUE, aby włączyć zmianę rozmiaru menu; w przeciwnym razie, FAŁSZ.

bVertcalOnly
[in] WARTOŚĆ TRUE, aby określić, że rozmiar galerii można zmienić tylko w pionie; FAŁSZ, aby określić, że można zmienić rozmiar galerii zarówno w pionie, jak i w poziomie.

Uwagi

Użyj tej metody, aby włączyć lub wyłączyć zmianę rozmiaru galerii wstążki. Po włączeniu zmiany rozmiaru galeria wstążki wyświetla uchwyt, którego użytkownik może użyć do zmiany rozmiaru.

CMFCRibbonGallery::EnableMenuSideBar

Włącza lub wyłącza pasek boczny po lewej stronie menu podręcznego.

void EnablMenuSideBar(BOOL bEnable=TRUE);

Parametry

bEnable
[in] WARTOŚĆ TRUE określająca, że pasek boczny jest włączony; w przeciwnym razie, FAŁSZ.

Uwagi

Wywołaj tę metodę, aby włączyć lub wyłączyć pasek boczny stylu pakietu Office XP po lewej stronie menu.

CMFCRibbonGallery::GetCompactSize

virtual CSize GetCompactSize(CDC* pDC);

Parametry

[in] PDC

Wartość zwracana

Uwagi

CMFCRibbonGallery::GetDroppedDown

virtual CMFCRibbonBaseElement* GetDroppedDown();

Wartość zwracana

Uwagi

CMFCRibbonGallery::GetGroupName

Zwraca nazwę grupy, która znajduje się w określonym indeksie.

LPCTSTR GetGroupName(int nGroupIndex) const;

Parametry

nGroupIndex
[in] Określa indeks oparty na zerach dla grupy, której nazwa ma zostać pobrana.

Wartość zwracana

Nazwa grupy znajdującej się w określonym indeksie. Przekazanie nieprawidłowego indeksu spowoduje niepowodzenie asercji.

Uwagi

CMFCRibbonGallery::GetGroupOffset

virtual int GetGroupOffset() const;

Wartość zwracana

Uwagi

CMFCRibbonGallery::GetIconsInRow

Zwraca liczbę elementów w wierszu galerii wstążki.

int GetIconsInRow() const;

Wartość zwracana

Liczba elementów w wierszu.

Uwagi

CMFCRibbonGallery::GetItemToolTip

Zwraca tekst etykietki narzędzia skojarzony z elementem w galerii.

LPCTSTR GetItemToolTip(int nItemIndex) const;

Parametry

nItemIndex
[in] Określa indeks zerowy elementu, dla którego ma być pobierany tekst etykietki narzędzia.

Wartość zwracana

Wskaźnik do ciągu etykietki narzędzia przypisanego do elementu w galerii wstążki. Może to być wartość NULL, jeśli do tego elementu nie przypisano żadnej etykietki narzędzia.

Uwagi

CMFCRibbonGallery::GetLastSelectedItem

Zwraca indeks ostatniego elementu w galerii wstążki wybranej przez użytkownika.

static int GetLastSelectedItem(UINT uiCmdID);

Parametry

uiCmdID
[in] Określa identyfikator polecenia elementu menu, który otworzył galerię wstążki.

Wartość zwracana

Gdy użytkownik wybierze dowolny element w galerii wstążki, biblioteka wyśle komunikat WM_COMMAND wraz z identyfikatorem polecenia przycisku menu, który otworzył galerię wstążki.

Uwagi

CMFCRibbonGallery::GetPaletteID

Zwraca identyfikator polecenia bieżącej palety.

int GetPaletteID() const;

Wartość zwracana

Identyfikator polecenia aktualnie wybranej palety.

Uwagi

CMFCRibbonGallery::GetRegularSize

virtual CSize GetRegularSize(CDC* pDC);

Parametry

[in] PDC

Wartość zwracana

Uwagi

CMFCRibbonGallery::GetSelectedItem

int GetSelectedItem() const;

Wartość zwracana

Uwagi

CMFCRibbonGallery::HasMenu

virtual BOOL HasMenu() const;

Wartość zwracana

Uwagi

CMFCRibbonGallery::IsButtonMode

Określa, czy paleta jest zawarta w przycisku galerii.

BOOL IsButtonMode() const;

Wartość zwracana

WARTOŚĆ TRUE, jeśli paleta jest wyświetlana jako przycisk menu rozwijanego; FAŁSZ, jeśli paleta jest wyświetlana bezpośrednio na wstążce.

Uwagi

CMFCRibbonGallery::IsMenuResizeEnabled

Określa, czy jest włączona zmiana rozmiaru menu.

BOOL IsMenuResizeEnabled() const;

Wartość zwracana

WARTOŚĆ TRUE, jeśli włączono zmianę rozmiaru menu; w przeciwnym razie, FAŁSZ.

Uwagi

CMFCRibbonGallery::IsMenuResizeVertical

BOOL IsMenuResizeVertical() const;

Wartość zwracana

Uwagi

CMFCRibbonGallery::IsMenuSideBar

Określa, czy pasek boczny jest włączony, czy wyłączony.

BOOL IsMenuSideBar() const;

Wartość zwracana

WARTOŚĆ TRUE, jeśli pasek boczny stylu pakietu Office XP jest rysowany po lewej stronie menu podręcznego; w przeciwnym razie, FAŁSZ.

Uwagi

CMFCRibbonGallery::OnAfterChangeRect

virtual void OnAfterChangeRect(CDC* pDC);

Parametry

[in] PDC

Uwagi

CMFCRibbonGallery::OnDraw

virtual void OnDraw(CDC* pDC);

Parametry

[in] PDC

Uwagi

CMFCRibbonGallery::OnDrawPaletteIcon

Wywoływana przez platformę, gdy zostanie narysowana ikona galerii.

virtual void OnDrawPaletteIcon(
    CDC* pDC,
    CRect rectIcon,
    int nIconIndex,
    CMFCRibbonGalleryIcon* pIcon,
    COLORREF clrText);

Parametry

PDC
[in] Wskaźnik do kontekstu urządzenia, który jest używany do rysowania.

rectIcon
[in] Określa prostokąt ograniczenia ikony do rysowania.

nIconIndex
[in] Określa indeks oparty na zera na liście obrazów ikon galerii do rysowania.

PIcon
[in] Wskaźnik do narysowanej ikony.

clrText
[in] Określa kolor tekstu elementu do rysowania.

Uwagi

Tę metodę można zastąpić w klasie pochodnej, aby dostosować wygląd galerii wstążki.

CMFCRibbonGallery::OnEnable

virtual void OnEnable(BOOL bEnable);

Parametry

[in] bEnable

Uwagi

CMFCRibbonGallery::OnRTLChanged

virtual void OnRTLChanged(BOOL bIsRTL);

Parametry

[in] bIsRTL

Uwagi

CMFCRibbonGallery::RedrawIcons

Ponownie rysuje galerię.

void RedrawIcons();

Uwagi

Wywołaj tę funkcję, aby ponownie wyrysować galerię. Tę metodę należy wywołać, jeśli zawartość galerii została zmieniona w czasie wykonywania.

CMFCRibbonGallery::RemoveItemToolTips

Usuwa etykietki narzędzi ze wszystkich elementów w galerii.

void RemoveItemToolTips();

Uwagi

CMFCRibbonGallery::SelectItem

void SelectItem(int nItemIndex);

Parametry

[in] nItemIndex

Uwagi

CMFCRibbonGallery::SetACCData

Wypełnia określony CAccessibilityData obiekt przy użyciu danych ułatwień dostępu z galerii wstążki.

virtual BOOL SetACCData(
    CWnd* pParent,
    CAccessibilityData& data);

Parametry

PParent
[in] Okno nadrzędne okna galerii wstążki.

data
[out] CAccessibilityData Obiekt, który odbiera dane ułatwień dostępu z galerii wstążki.

Wartość zwracana

Uwagi

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

CMFCRibbonGallery::SetButtonMode

Określa, czy galeria wstążek ma być wyświetlana jako przycisk listy rozwijanej, czy jako paleta bezpośrednio na wstążce.

void SetButtonMode(BOOL bSet=TRUE);

Parametry

Zestaw bSet
[in] WARTOŚĆ TRUE, aby wyświetlić galerię wstążki jako przycisk menu rozwijanego; FAŁSZ, aby wyświetlić zawartość galerii wstążki bezpośrednio na wstążce.

Uwagi

CMFCRibbonGallery::SetGroupName

Ustawia nazwę grupy.

void SetGroupName(
    int nGroupIndex,
    LPCTSTR lpszGroupName);

Parametry

nGroupIndex
[in] Określa indeks oparty na zerach dla grupy, dla której nazwa jest zmieniana.

lpszGroupName
[in] Określa nową nazwę grupy.

Uwagi

Grupa, której nazwa jest zmieniana, musi zostać dodana przy użyciu metody CMFCRibbonGallery::AddGroup .

CMFCRibbonGallery::SetIconsInRow

Określa liczbę elementów na wiersz w galerii.

void SetIconsInRow(int nIconsInRow);

Parametry

nIconsInRow
[in] Określa liczbę elementów do wyświetlenia w każdym wierszu galerii.

Uwagi

Użyj tej metody, aby określić szerokość galerii wstążki.

CMFCRibbonGallery::SetItemToolTip

Ustawia tekst etykietki narzędzia dla elementu w galerii.

void SetItemToolTip(
    int nItemIndex,
    LPCTSTR lpszToolTip);

Parametry

nItemIndex
[in] Indeks na podstawie zera elementu palety, z którym należy skojarzyć etykietkę narzędzia.

lpszToolTip
[in] Tekst wyświetlany w etykietce narzędzia.

Uwagi

CMFCRibbonGallery::SetPalette

Dołącza paletę do galerii wstążki.

void SetPalette(CMFCToolBarImages& imagesPalette);

void SetPalette(
    UINT uiImagesPaletteResID,
    int cxPaletteImage);

Parametry

imagesPalette
[in] Określa listę obrazów zawierającą ikony, które mają być wyświetlane w galerii.

uiImagesPaletteResID
[in] Określa identyfikator zasobu listy obrazów, która zawiera ikony, które mają być wyświetlane w galerii.

cxPaletteImage
[in] Określa szerokość obrazu w pikselach w galerii.

Uwagi

CMFCRibbonGallery::SetPaletteID

Definiuje identyfikator polecenia, który jest wysyłany w komunikacie WM_COMMAND, gdy użytkownik wybierze element galerii.

void SetPaletteID(UINT nID);

Parametry

Nid
[in] Określa identyfikator polecenia, który jest wysyłany w komunikacie WM_COMMAND, gdy użytkownik wybierze element galerii.

Uwagi

Aby określić konkretny element wybrany przez użytkownika z galerii, wywołaj metodę statyczną CMFCRibbonGallery::GetLastSelectedItem .

Zobacz też

Wykres hierarchii
Klasy
Klasa CMFCRibbonButton
Klasa CMFCRibbonGalleryMenuButton