Clase CMFCRibbonGallery

Implementa galerías de cinta de estilo de Office 2007. Para obtener información más detallada, consulta el código fuente que se ubica en la carpeta VC\atlmfc\src\mfc de la instalación de Visual Studio.

Sintaxis

class CMFCRibbonGallery : public CMFCRibbonButton

Miembros

Constructores públicos

Nombre	Descripción
CMFCRibbonGallery::CMFCRibbonGallery	Construye e inicializa un objeto CMFCRibbonGallery.

Métodos públicos

Nombre	Descripción
CMFCRibbonGallery::AddGroup	Agrega un grupo nuevo a la galería.
CMFCRibbonGallery::AddSubItem	Agrega un elemento de menú nuevo al menú desplegable.
CMFCRibbonGallery::Clear	Borra el contenido de la galería.
CMFCRibbonGallery::EnableMenuResize	Habilita o deshabilita el cambio de tamaño del panel de menús.
CMFCRibbonGallery::EnableMenuSideBar	Habilita o deshabilita la barra lateral situada a la izquierda del menú emergente.
CMFCRibbonGallery::GetCompactSize	(Invalida CMFCRibbonButton::GetCompactSize).
CMFCRibbonGallery::GetDroppedDown	(Invalida CMFCRibbonBaseElement::GetDroppedDown).
CMFCRibbonGallery::GetGroupName	Devuelve el nombre del grupo que se encuentra en el índice especificado.
CMFCRibbonGallery::GetGroupOffset
CMFCRibbonGallery::GetIconsInRow	Devuelve el número de elementos de una fila de la galería de cintas de opciones.
CMFCRibbonGallery::GetItemToolTip	Devuelve el texto de información sobre herramientas asociado a un elemento de la galería.
CMFCRibbonGallery::GetLastSelectedItem	Devuelve el índice del último elemento de la galería que el usuario ha seleccionado.
CMFCRibbonGallery::GetPaletteID	Devuelve el id. de comando de la galería actual.
CMFCRibbonGallery::GetRegularSize	(Invalida CMFCRibbonButton::GetRegularSize).
CMFCRibbonGallery::GetSelectedItem
CMFCRibbonGallery::HasMenu	(Invalida CMFCRibbonButton::HasMenu).
CMFCRibbonGallery::IsButtonMode	Especifica si la galería está incluida en un botón de la galería.
CMFCRibbonGallery::IsMenuResizeEnabled	Especifica si el cambio de tamaño del menú está habilitado o deshabilitado.
CMFCRibbonGallery::IsMenuResizeVertical
CMFCRibbonGallery::IsMenuSideBar	Especifica si la barra lateral está habilitada o deshabilitada.
CMFCRibbonGallery::OnAfterChangeRect	(Invalida CMFCRibbonButton::OnAfterChangeRect).
CMFCRibbonGallery::OnDraw	(Invalida CMFCRibbonButton::OnDraw).
CMFCRibbonGallery::OnEnable	(Invalida CMFCRibbonBaseElement::OnEnable).
CMFCRibbonGallery::OnRTLChanged	(Invalida CMFCRibbonBaseElement::OnRTLChanged).
CMFCRibbonGallery::RedrawIcons	Vuelve a dibujar la galería.
CMFCRibbonGallery::RemoveItemToolTips	Quita la información sobre herramientas de todos los elementos de la galería.
CMFCRibbonGallery::SelectItem
CMFCRibbonGallery::SetACCData	(Invalida CMFCRibbonButton::SetACCData).
CMFCRibbonGallery::SetButtonMode	Especifica si se va a mostrar la galería de la cinta de opciones como un botón desplegable o como una paleta directamente en la cinta de opciones.
CMFCRibbonGallery::SetGroupName	Establece el nombre de un grupo.
CMFCRibbonGallery::SetIconsInRow	Define el número de elementos por fila en la galería.
CMFCRibbonGallery::SetItemToolTip	Establece el texto de información sobre herramientas de un elemento de la galería.
CMFCRibbonGallery::SetPalette	Adjunta una paleta a una galería de cintas de opciones.
CMFCRibbonGallery::SetPaletteID	Define el id. de comando que se envía en el mensaje WM_COMMAND cuando se ha seleccionado un elemento de la galería.

Métodos protegidos

Nombre	Descripción
CMFCRibbonGallery::OnDrawPaletteIcon	Lo llama el marco cuando se dibuja un icono de galería.

Comentarios

Un botón de galería se comporta igual que un botón de menú normal, salvo que en el primero se muestra una galería cuando un usuario lo abre. Al seleccionar un elemento en una galería, el marco envía el mensaje WM_COMMAND junto con el id. de comando del botón. Al controlar el mensaje, debe llamar a CMFCRibbonGallery::GetLastSelectedItem para determinar qué elemento se seleccionó de la galería.

Ejemplo

En el ejemplo siguiente, se muestra cómo configurar un objeto CMFCRibbonGallery mediante varios métodos de la clase CMFCRibbonGallery. En el ejemplo se muestra cómo especificar el número de elementos por fila en la galería, habilitar el cambio de tamaño del panel de menús, habilitar la barra lateral a la izquierda del menú emergente y mostrar la galería de cintas de opciones como una paleta directamente en la barra de cinta de opciones. Este fragmento de código forma parte del Ejemplo de cliente de dibujo.

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();

Jerarquía de herencia

CObject
└ CMFCRibbonBaseElement
 └ CMFCRibbonButton
  └ CMFCRibbonGallery

Requisitos

Encabezado: afxRibbonPaletteGallery.h

CMFCRibbonGallery::AddGroup

Agrega un grupo nuevo a la galería.

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

void AddGroup(
    LPCTSTR lpszGroupName,
    CMFCToolBarImages& imagesGroup);

void AddGroup(
    LPCTSTR lpszGroupName,
    int nIconsNum);

Parámetros

lpszGroupName
[in] Especifica el nombre del grupo.

uiImagesPaletteResID
[in] Especifica el id. de recurso de la lista de imágenes que contiene las imágenes del grupo.

cxPaletteImage
[in] Especifica el ancho en píxeles de una imagen.

imagesGroup
[in] Referencia a la lista de imágenes que contiene imágenes de grupo.

nIconsNum
[in] Especifica el número de iconos del grupo. Este parámetro solo se debe especificar para grupos personalizados (dibujados por el propietario).

Comentarios

Puede dividir los elementos de una galería de cintas de opciones en varios grupos; para ello, llame a este método. Cada grupo puede tener una descripción.

CMFCRibbonGallery::AddSubItem

Agrega un elemento de menú nuevo al menú desplegable.

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

Parámetros

pSubItem
[in] Puntero al elemento que se va a agregar al menú.

nIndex
[in] Especifica el índice de base cero de una ubicación donde se va a insertar el elemento.

bOnTop
[in] Es TRUE para especificar que el elemento debe insertarse antes de la galería de cintas de opciones; de lo contrario, es FALSE.

Comentarios

Puede combinar galerías emergentes con elementos de menú emergente llamando a este método. Los elementos de menú se pueden colocar antes o después de la galería.

Para insertar el elemento antes de la galería, establezca bOnTop en TRUE. Establezca bOnTop en FALSE para insertar el elemento debajo de la galería.

Nota:

El parámetro nIndex especifica el índice de inserción tanto en la parte superior como en la parte inferior de la galería. Por ejemplo, si necesita insertar un elemento una posición antes de la galería, establezca nIndex en 1 y bOnTop en TRUE. De igual modo, si necesita insertar un elemento una posición debajo de la galería, establezca nIndex en 1 y bOnTop en FALSE.

CMFCRibbonGallery::Clear

Borra el contenido de la galería.

virtual void Clear();

Comentarios

Llame a este método para quitar todo el contenido de la galería de cintas de opciones. Esto debe hacerse antes de adjuntar una galería de cintas de opciones nueva o de establecer grupos a la galería de cintas de opciones.

CMFCRibbonGallery::CMFCRibbonGallery

Construye e inicializa un objeto 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);

Parámetros

Nid
Especifica el id. de comando del comando que se va a ejecutar cuando un usuario hace clic en el botón.

lpszText
Especifica el texto que aparece en el botón.

nSmallImageIndex
Índice de base cero de la imagen pequeña que se va a mostrar en el botón.

nLargeImageIndex
Índice de base cero de la imagen grande que se va a mostrar en el botón.

imagesPalette
Referencia al objeto CMFCToolBarImages que contiene las imágenes que se van a mostrar en la galería.

uiImagesPaletteResID
Id. de recurso de la lista de imágenes que se van a mostrar en la galería.

cxPaletteImage
Especifica el ancho en píxeles de la imagen de la galería.

sizeIcon
Especifica el tamaño en píxeles de la imagen de la galería.

nIconsNum
Especifica el número de iconos de la galería.

bDefaultButtonStyle
Especifica si se debe usar el estilo de botón dibujado por el propietario o el predeterminado.

Comentarios

CMFCRibbonGallery::EnableMenuResize

Habilita o deshabilita el cambio de tamaño del panel de menús.

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

Parámetros

bEnable
[in] Es TRUE para habilitar el cambio de tamaño del menú; de lo contrario, es FALSE.

bVertcalOnly
[in] Es TRUE para especificar que la galería solo se puede cambiar verticalmente; es FALSE para especificar que se puede cambiar el tamaño de la galería vertical y horizontalmente.

Comentarios

Use este método para habilitar o deshabilitar el cambio de tamaño de la galería de cintas de opciones. Cuando se habilita el cambio de tamaño, la galería de cintas de opciones muestra un barra de dimensionamiento que un usuario puede usar para cambiar el tamaño.

CMFCRibbonGallery::EnableMenuSideBar

Habilita o deshabilita la barra lateral situada a la izquierda del menú emergente.

void EnablMenuSideBar(BOOL bEnable=TRUE);

Parámetros

bEnable
[in] Es TRUE para especificar que la barra lateral está habilitada; de lo contrario, es FALSE.

Comentarios

Llame a este método para habilitar o deshabilitar la barra lateral de estilo Office XP en el lado izquierdo del menú.

CMFCRibbonGallery::GetCompactSize

virtual CSize GetCompactSize(CDC* pDC);

Parámetros

[in] pDC

Valor devuelto

Comentarios

CMFCRibbonGallery::GetDroppedDown

virtual CMFCRibbonBaseElement* GetDroppedDown();

Valor devuelto

Comentarios

CMFCRibbonGallery::GetGroupName

Devuelve el nombre del grupo que se encuentra en el índice especificado.

LPCTSTR GetGroupName(int nGroupIndex) const;

Parámetros

nGroupIndex
[in] Especifica el índice de base cero para el grupo cuyo nombre quiere recuperar.

Valor devuelto

El nombre del grupo que se encuentra en el índice especificado. Si se pasa un índice no válido, se producirá un error en la aserción.

Comentarios

CMFCRibbonGallery::GetGroupOffset

virtual int GetGroupOffset() const;

Valor devuelto

Comentarios

CMFCRibbonGallery::GetIconsInRow

Devuelve el número de elementos de una fila de la galería de cintas de opciones.

int GetIconsInRow() const;

Valor devuelto

El número de elementos de una fila.

Comentarios

CMFCRibbonGallery::GetItemToolTip

Devuelve el texto de información sobre herramientas asociado a un elemento de la galería.

LPCTSTR GetItemToolTip(int nItemIndex) const;

Parámetros

nItemIndex
[in] Especifica el índice de base cero del elemento para el que se va a recuperar el texto de información sobre herramientas.

Valor devuelto

Puntero a la cadena de información sobre herramientas asignada a un elemento de la galería de cintas de opciones. Puede ser NULL si no se asigna información sobre herramientas a ese elemento.

Comentarios

CMFCRibbonGallery::GetLastSelectedItem

Devuelve el índice del último elemento de la galería de cintas de opciones que ha seleccionado el usuario.

static int GetLastSelectedItem(UINT uiCmdID);

Parámetros

uiCmdID
[in] Especifica el id. de comando del elemento de menú que abrió la galería de cintas de opciones.

Valor devuelto

Cuando el usuario selecciona cualquier elemento de la galería de cintas de opciones, la biblioteca envía el mensaje WM_COMMAND junto con el id. de comando del botón de menú que abrió la galería de cintas de opciones.

Comentarios

CMFCRibbonGallery::GetPaletteID

Devuelve el id. de comando de la paleta actual.

int GetPaletteID() const;

Valor devuelto

Id. de comando de la paleta seleccionada actualmente.

Comentarios

CMFCRibbonGallery::GetRegularSize

virtual CSize GetRegularSize(CDC* pDC);

Parámetros

[in] pDC

Valor devuelto

Comentarios

CMFCRibbonGallery::GetSelectedItem

int GetSelectedItem() const;

Valor devuelto

Comentarios

CMFCRibbonGallery::HasMenu

virtual BOOL HasMenu() const;

Valor devuelto

Comentarios

CMFCRibbonGallery::IsButtonMode

Especifica si la paleta está incluida en un botón de galería.

BOOL IsButtonMode() const;

Valor devuelto

Es TRUE si la paleta se muestra como un botón de menú desplegable; es FALSE si la paleta se muestra directamente en la cinta de opciones.

Comentarios

CMFCRibbonGallery::IsMenuResizeEnabled

Especifica si el cambio de tamaño del menú está habilitado.

BOOL IsMenuResizeEnabled() const;

Valor devuelto

Es TRUE si se ha habilitado el cambio de tamaño del menú; de lo contrario, es FALSE.

Comentarios

CMFCRibbonGallery::IsMenuResizeVertical

BOOL IsMenuResizeVertical() const;

Valor devuelto

Comentarios

CMFCRibbonGallery::IsMenuSideBar

Especifica si la barra lateral está habilitada o deshabilitada.

BOOL IsMenuSideBar() const;

Valor devuelto

Es TRUE si la barra lateral de estilo Office XP se dibuja en el lado izquierdo del menú emergente; de lo contrario, es FALSE.

Comentarios

CMFCRibbonGallery::OnAfterChangeRect

virtual void OnAfterChangeRect(CDC* pDC);

Parámetros

[in] pDC

Comentarios

CMFCRibbonGallery::OnDraw

virtual void OnDraw(CDC* pDC);

Parámetros

[in] pDC

Comentarios

CMFCRibbonGallery::OnDrawPaletteIcon

Lo llama el marco cuando se dibuja un icono de galería.

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

Parámetros

pDC
[in] Puntero al contexto del dispositivo que se usa para dibujar.

rectIcon
[in] Especifica el rectángulo delimitador del icono que se va a dibujar.

nIconIndex
[in] Especifica el índice de base cero en la lista de imágenes de iconos de la galería del icono que se va a dibujar.

pIcon
[in] Puntero al icono que se va a dibujar.

clrText
[in] Especifica el color del texto del elemento que se va a dibujar.

Comentarios

Puede invalidar este método en una clase derivada para personalizar la apariencia de una galería de cintas de opciones.

CMFCRibbonGallery::OnEnable

virtual void OnEnable(BOOL bEnable);

Parámetros

[in] bEnable

Comentarios

CMFCRibbonGallery::OnRTLChanged

virtual void OnRTLChanged(BOOL bIsRTL);

Parámetros

[in] bIsRTL

Comentarios

CMFCRibbonGallery::RedrawIcons

Vuelve a dibujar la galería.

void RedrawIcons();

Comentarios

Llame a esta función para volver a dibujar la galería. Debe llamar a este método si ha cambiado el contenido de la galería en tiempo de ejecución.

CMFCRibbonGallery::RemoveItemToolTips

Quita la información sobre herramientas de todos los elementos de la galería.

void RemoveItemToolTips();

Comentarios

CMFCRibbonGallery::SelectItem

void SelectItem(int nItemIndex);

Parámetros

[in] nItemIndex

Comentarios

CMFCRibbonGallery::SetACCData

Rellena el objeto CAccessibilityData especificado mediante los datos de accesibilidad de la galería de la cinta de opciones.

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

Parámetros

pParent
[in] La ventana primaria de la ventana de la galería de cintas de opciones.

data
[out] Un objeto CAccessibilityData que recibe los datos de accesibilidad procedentes de la galería de cintas de opciones.

Valor devuelto

Comentarios

TRUE si el método es correcto; de lo contrario, FALSE.

CMFCRibbonGallery::SetButtonMode

Determina si se va a mostrar la galería de cintas de opciones como un botón desplegable o como una paleta directamente en la cinta de opciones.

void SetButtonMode(BOOL bSet=TRUE);

Parámetros

bSet
[in] Es TRUE para mostrar la galería de cintas de opciones como un botón de menú desplegable; es FALSE para mostrar el contenido de la galería de cintas de opciones directamente en la cinta de opciones.

Comentarios

CMFCRibbonGallery::SetGroupName

Establece el nombre de un grupo.

void SetGroupName(
    int nGroupIndex,
    LPCTSTR lpszGroupName);

Parámetros

nGroupIndex
[in] Especifica el índice de base cero para el grupo al que se le va a cambiar el nombre.

lpszGroupName
[in] Especifica el nuevo nombre del grupo.

Comentarios

El grupo cuyo nombre se va a cambiar debe haberse agregado mediante el método CMFCRibbonGallery::AddGroup.

CMFCRibbonGallery::SetIconsInRow

Especifica el número de elementos por fila en la galería.

void SetIconsInRow(int nIconsInRow);

Parámetros

nIconsInRow
[in] Especifica el número de elementos que se mostrarán en cada fila de la galería.

Comentarios

Use este método para especificar el ancho de la galería de cintas de opciones.

CMFCRibbonGallery::SetItemToolTip

Establece el texto de información sobre herramientas de un elemento de la galería.

void SetItemToolTip(
    int nItemIndex,
    LPCTSTR lpszToolTip);

Parámetros

nItemIndex
[in] Índice de base cero del elemento de paleta con el que se va a asociar la información sobre herramientas.

lpszToolTip
[in] Texto que se va a mostrar en la información sobre herramientas.

Comentarios

CMFCRibbonGallery::SetPalette

Adjunta una paleta a una galería de cintas de opciones.

void SetPalette(CMFCToolBarImages& imagesPalette);

void SetPalette(
    UINT uiImagesPaletteResID,
    int cxPaletteImage);

Parámetros

imagesPalette
[in] Especifica la lista de imágenes que incluye los iconos que se van a mostrar en la galería.

uiImagesPaletteResID
[in] Especifica el id. de recurso de la lista de imágenes que contiene los iconos que se van a mostrar en la galería.

cxPaletteImage
[in] Especifica el ancho en píxeles de una imagen en la galería.

Comentarios

CMFCRibbonGallery::SetPaletteID

Define el id. de comando que se envía en el mensaje de WM_COMMAND cuando un usuario selecciona un elemento de la galería.

void SetPaletteID(UINT nID);

Parámetros

Nid
[in] Especifica el id. de comando que se envía en el mensaje de WM_COMMAND cuando un usuario selecciona un elemento de la galería.

Comentarios

Para determinar el elemento específico que ha seleccionado un usuario de la galería, llame al método estático CMFCRibbonGallery::GetLastSelectedItem.

Consulte también

Gráfico de jerarquías
Clases
CMFCRibbonButton (clase)
CMFCRibbonGalleryMenuButton (clase)