Compartir a través de


Clase CMFCRibbonCategory

La clase CMFCRibbonCategory implementa una ficha de cinta que contiene un grupo de Paneles de cinta.

Sintaxis

class CMFCRibbonCategory : public CObject

Miembros

Constructores protegidos

Nombre Descripción
CMFCRibbonCategory::CMFCRibbonCategory Constructor .

Métodos públicos

Nombre Descripción
CMFCRibbonCategory::AddHidden Agrega un elemento oculto a la categoría de la cinta de opciones.
CMFCRibbonCategory::AddPanel Agrega un nuevo panel a la categoría de cinta.
CMFCRibbonCategory::CopyFrom
CMFCRibbonCategory::FindByData
CMFCRibbonCategory::FindByID
CMFCRibbonCategory::FindPanelWithElem
CMFCRibbonCategory::GetContextID Devuelve el id. de contexto de la categoría de la cinta de opciones.
CMFCRibbonCategory::GetData Devuelve los datos definidos por el usuario asociados a la categoría de la cinta.
CMFCRibbonCategory::GetDroppedDown
CMFCRibbonCategory::GetElements
CMFCRibbonCategory::GetElementsByID
CMFCRibbonCategory::GetFirstVisibleElement Obtener un primer elemento visible que pertenezca a la categoría de la cinta de opciones.
CMFCRibbonCategory::GetFocused Devuelve un elemento que tiene el foco.
CMFCRibbonCategory::GetHighlighted Devuelve un elemento resaltado.
CMFCRibbonCategory::GetImageCount
CMFCRibbonCategory::GetImageSize
CMFCRibbonCategory::GetItemIDsList
CMFCRibbonCategory::GetLastVisibleElement Obtener un último elemento visible que pertenezca a la categoría de la cinta de opciones
CMFCRibbonCategory::GetLargeImages Devuelve una referencia a la lista de imágenes grandes que usa la categoría de la cinta de opciones.
CMFCRibbonCategory::GetMaxHeight
CMFCRibbonCategory::GetName
CMFCRibbonCategory::GetPanel Devuelve un puntero al panel de la cinta de opciones que se encuentra en el índice especificado.
CMFCRibbonCategory::GetPanelCount Devuelve el número de paneles de la cinta de opciones de la categoría de la cinta.
CMFCRibbonCategory::GetPanelFromPoint
CMFCRibbonCategory::GetPanelIndex Devuelve el índice del panel especificado de la cinta de opciones.
CMFCRibbonCategory::GetParentButton
CMFCRibbonCategory::GetParentMenuBar
CMFCRibbonCategory::GetParentRibbonBar
CMFCRibbonCategory::GetRect
CMFCRibbonCategory::GetSmallImages Devuelve una referencia a la lista de imágenes pequeñas que usa la categoría.
CMFCRibbonCategory::GetTabColor Devuelve el color actual de la pestaña de la categoría de la cinta de opciones.
CMFCRibbonCategory::GetTabRect
CMFCRibbonCategory::GetTextTopLine
CMFCRibbonCategory::GetVisibleElements Obtenga todos los elementos visibles que pertenezcan a la categoría de la cinta de opciones.
CMFCRibbonCategory::HighlightPanel
CMFCRibbonCategory::HitTest
CMFCRibbonCategory::HitTestEx
CMFCRibbonCategory::HitTestScrollButtons
CMFCRibbonCategory::IsActive
CMFCRibbonCategory::IsVisible Determina si la categoría de la cinta de opciones es visible.
CMFCRibbonCategory::IsWindows7Look Indica si la cinta de opciones primaria tiene la apariencia de Windows 7 (botón de aplicación rectangular pequeño)
CMFCRibbonCategory::NotifyControlCommand
CMFCRibbonCategory::OnCancelMode
CMFCRibbonCategory::OnDraw
CMFCRibbonCategory::OnDrawImage
CMFCRibbonCategory::OnDrawMenuBorder
CMFCRibbonCategory::OnKey Lo llama el marco de trabajo cuando un usuario pulsa un botón de teclado.
CMFCRibbonCategory::OnLButtonDown
CMFCRibbonCategory::OnLButtonUp
CMFCRibbonCategory::OnMouseMove
CMFCRibbonCategory::OnRTLChanged
CMFCRibbonCategory::OnScrollHorz
CMFCRibbonCategory::OnUpdateCmdUI
CMFCRibbonCategory::RecalcLayout
CMFCRibbonCategory::RemovePanel
CMFCRibbonCategory::ReposPanels
CMFCRibbonCategory::SetCollapseOrder Define el orden de contracción de los paneles de la cinta de opciones que están presentes en la categoría de la cinta.
CMFCRibbonCategory::SetData Almacena los datos definidos por el usuario en la categoría de la cinta de opciones.
CMFCRibbonCategory::SetKeys Asigna una información sobre las teclas a la categoría de la cinta de opciones.
CMFCRibbonCategory::SetName
CMFCRibbonCategory::SetTabColor Establece el color de la categoría de la cinta de opciones.

Comentarios

Normalmente, se crea una categoría de la cinta de opciones indirectamente al llamar a CMFCRibbonBar::AddCategory, que devuelve un puntero a la categoría de cinta recién creada. Para agregar paneles a la categoría, se llama a CMFCRibbonCategory::AddPanel.

La clase CMFCRibbonTab dibuja categorías de la cinta de opciones. Se deriva de CMFCRibbonBaseElement Class.

En este ejemplo siguiente se muestra cómo crear una categoría de la cinta de opciones y agregarle un 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

El diagrama siguiente muestra una ilustración de la categoría Inicio de la aplicación de ejemplo RibbonApp.

Home category from the RibbonApp sample application.

Jerarquía de herencia

CObject

CMFCRibbonCategory

Requisitos

Encabezado: afxribboncategory.h

CMFCRibbonCategory::AddHidden

Agrega el elemento de la cinta de opciones especificado a la matriz de elementos de la cinta que se muestran en el cuadro de diálogo de personalización.

void AddHidden(CMFCRibbonBaseElement* pElem);

Parámetros

pElem
[in] Puntero a un elemento de la cinta.

Comentarios

Los elementos de la cinta de opciones del cuadro de diálogo de personalización son los comandos que se pueden agregar a la barra de herramientas de acceso rápido.

CMFCRibbonCategory::AddPanel

Crea un panel de la cinta de opciones para la categoría de la cinta.

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

Parámetros

lpszPanelName
[in] Puntero al nombre del nuevo panel de la cinta de opciones.

hIcon
[in] Manipulador del icono predeterminado para el nuevo panel de la cinta de opciones.

pRTI
[in] Puntero a la información de la clase en tiempo de ejecución para un panel de la cinta de opciones personalizado.

Valor devuelto

Puntero al nuevo panel de la cinta de opciones si el método se realizó correctamente; de lo contrario, NULL si no se creó el panel.

Comentarios

Si desea crear un panel de la cinta de opciones personalizado, debe especificar su información de clase en tiempo de ejecución en pRTI. La clase del panel de la cinta de opciones debe derivarse de la clase CMFCRibbonPanel.

El icono predeterminado del panel de la cinta de opciones se muestra cuando no hay suficiente espacio para mostrar los elementos de la cinta.

Ejemplo

El siguiente ejemplo muestra cómo se usa el método AddPanel de la clase CMFCRibbonCategory.

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

CMFCRibbonCategory::CMFCRibbonCategory

Construye e inicializa un objeto CMFCRibbonCategory.

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

Parámetros

pParenrRibbonBar
[in] Puntero a la barra de la cinta de opciones primaria de la categoría de la cinta.

lpszName
[in] Nombre de la categoría de la cinta de opciones.

uiSmallImagesResID
[in] Id. de recurso de la lista de imágenes para las imágenes pequeñas que son usadas por los elementos de la cinta de opciones en la categoría de la cinta.

uiLargeImagesResID
[in] Id. de recurso de la lista de imágenes para las imágenes grandes que son usadas por los elementos de la cinta de opciones en la categoría de la cinta.

sizeSmallImage
[in] Tamaño predeterminado de imágenes pequeñas para los elementos de la cinta de opciones en la categoría de la cinta.

sizeLargeImage
[in] Tamaño predeterminado de imágenes grandes para los elementos de la cinta de opciones en la categoría de la cinta.

CMFCRibbonCategory::CopyFrom

Copia el estado de la CMFCRibbonCategory especificada en el objeto CMFCRibbonCategory actual.

virtual void CopyFrom(CMFCRibbonCategory& src);

Parámetros

src
[in] El objeto CMFCRibbonCategory de origen.

Comentarios

CMFCRibbonCategory::FindByData

Recupera el elemento de la cinta de opciones asociado a los datos especificados.

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

Parámetros

dwData
[in] Los datos asociados a un elemento de la barra de opciones.

bVisibleOnly
[in] TRUE para incluir elementos de la cinta de opciones de acceso rápido en la búsqueda; FALSE para excluir elementos de la cinta de opciones de acceso rápido en la búsqueda.

Valor devuelto

Puntero a un elemento de la cinta de opciones si el método se realizó correctamente; en caso contrario, NULL.

Comentarios

CMFCRibbonCategory::FindByID

Recupera el elemento de la cinta de opciones asociado al Id. de comando especificado.

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

Parámetros

uiCmdID
[in] Id. de comando asociado a un elemento de la cinta de opciones.

bVisibleOnly
[in] TRUE para incluir elementos de la cinta de opciones de acceso rápido en la búsqueda; FALSE para excluir elementos de la cinta de opciones de acceso rápido en la búsqueda.

Valor devuelto

Puntero a un elemento de la cinta de opciones si el método se realizó correctamente; en caso contrario, NULL.

Comentarios

CMFCRibbonCategory::FindPanelWithElem

Recupera el panel de la cinta de opciones que contiene el elemento de cinta especificado.

CMFCRibbonPanel* FindPanelWithElem(const CMFCRibbonBaseElement* pElement);

Parámetros

pElement
[in] Puntero a un elemento de la cinta.

Valor devuelto

Puntero a un panel de la cinta de opciones si el método se realizó correctamente; en caso contrario, NULL.

Comentarios

CMFCRibbonCategory::GetContextID

Recupera el id. de contexto de la categoría de la cinta de opciones.

UINT GetContextID() const;

Valor devuelto

Id. de contexto de la categoría de la cinta de opciones.

Comentarios

El id. de contexto es 0 si la categoría de la cinta de opciones no es una categoría de la cinta de contexto.

CMFCRibbonCategory::GetData

Recupera los datos definidos por el usuario asociados a la categoría de la cinta de opciones.

DWORD_PTR GetData() const;

Valor devuelto

Los datos definidos por el usuario asociados a la categoría de la cinta de opciones.

CMFCRibbonCategory::GetDroppedDown

Recupera un puntero al elemento de la cinta de opciones que actualmente tiene su menú emergente desplegado.

CMFCRibbonBaseElement* GetDroppedDown();

Valor devuelto

Puntero a un elemento de la cinta de opciones si el método se realizó correctamente; en caso contrario, NULL.

Comentarios

CMFCRibbonCategory::GetElements

Recupera todos los elementos de la cinta de opciones de la categoría de la cinta.

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

Parámetros

arElements
[in, out] Referencia a una CArray de elementos de la cinta de opciones.

Comentarios

Los elementos de la cinta de opciones diseñados para su uso en la barra de herramientas de acceso rápido se incluyen en la matriz.

CMFCRibbonCategory::GetElementsByID

Recupera todos los elementos de la cinta de opciones asociados al id. de comando especificado.

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

Parámetros

uiCmdID
[in] Id. de comando asociado a un elemento de la cinta de opciones.

arElements
[in, out] Referencia a una CArray de elementos de la cinta de opciones.

Comentarios

Los elementos de la cinta de opciones diseñados para su uso en la barra de herramientas de acceso rápido se incluyen en la matriz.

CMFCRibbonCategory::GetFirstVisibleElement

Recupera el primer elemento visible que pertenezca a la categoría de la cinta de opciones.

CMFCRibbonBaseElement* GetFirstVisibleElement() const;

Valor devuelto

Puntero al primer elemento visible; puede ser NULL si la categoría no tiene ningún elemento visible.

Comentarios

CMFCRibbonCategory::GetFocused

Devuelve un elemento que tiene el foco.

CMFCRibbonBaseElement* GetFocused();

Valor devuelto

Puntero a un elemento centrado o NULL.

Comentarios

CMFCRibbonCategory::GetHighlighted

Devuelve un elemento resaltado.

CMFCRibbonBaseElement* GetHighlighted();

Valor devuelto

Puntero a un elemento resaltado o NULL si no hay ningún elemento resaltado.

Comentarios

CMFCRibbonCategory::GetImageCount

Recupera el número de imágenes de la lista de imágenes especificada que se encuentra en la categoría de la cinta de opciones.

int GetImageCount(BOOL bIsLargeImage) const;

Parámetros

bIsLargeImage
[in] TRUE para el número de imágenes de la lista de imágenes grandes; FALSE para el número de imágenes de la lista de imágenes pequeñas.

Valor devuelto

El número de imágenes en la lista de imágenes especificada.

Comentarios

CMFCRibbonCategory::GetImageSize

Recupera el tamaño de una imagen de la lista de imágenes especificada que se encuentra en la categoría de la cinta de opciones.

CSize GetImageSize(BOOL bIsLargeImage) const;

Parámetros

bIsLargeImage
[in] TRUE para el tamaño de las imágenes grandes; FALSE para el tamaño de las imágenes pequeñas.

Valor devuelto

Tamaño de una imagen en la lista de imágenes especificada.

Comentarios

El tamaño recuperado incluye el factor de escala global de la imagen.

CMFCRibbonCategory::GetItemIDsList

Recupera los identificadores de comando de los elementos de la cinta de opciones que están contenidos en la categoría de la cinta de opciones.

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

Parámetros

lstItems
[out] Lista de identificadores de comando para los elementos de la cinta de opciones de la categoría de la cinta.

bHiddenOnly
[in] TRUE para excluir los elementos de la cinta de opciones que se muestran en los paneles de la cinta de la categoría de la cinta de opciones; FALSE para incluir todos los elementos de la cinta de opciones en la categoría de la cinta.

Comentarios

CMFCRibbonCategory::GetLargeImages

Recupera la lista de imágenes grandes contenidas en la categoría de la cinta de opciones.

CMFCToolBarImages& GetLargeImages();

Valor devuelto

Lista de imágenes grandes contenidas en la categoría de la cinta de opciones.

CMFCRibbonCategory::GetLastVisibleElement

Recupera el último elemento visible que pertenezca a la categoría de la cinta de opciones.

CMFCRibbonBaseElement* GetLastVisibleElement() const;

Valor devuelto

Puntero al último elemento visible; puede ser NULL si la categoría no tiene ningún elemento visible.

Comentarios

CMFCRibbonCategory::GetMaxHeight

Recupera la altura máxima de los paneles de la cinta de opciones contenidos en la categoría de la cinta.

int GetMaxHeight(CDC* pDC);

Parámetros

pDC
[in] Puntero a un contexto de dispositivo para los paneles de la cinta de opciones.

Valor devuelto

Altura máxima de los paneles de la cinta de opciones contenidos en la categoría de la cinta.

Comentarios

El valor recuperado incluye la altura de los márgenes superior e inferior de los paneles de la cinta de opciones.

CMFCRibbonCategory::GetName

Recupera el nombre de la categoría de la cinta de opciones.

LPCTSTR GetName() const;

Valor devuelto

Nombre de la categoría de la cinta de opciones.

Comentarios

CMFCRibbonCategory::GetPanel

Devuelve un puntero al panel de la cinta de opciones que se encuentra en el índice especificado.

CMFCRibbonPanel* GetPanel(int nIndex);

Parámetros

nIndex
[in] Índice de base cero de un panel de la cinta de opciones.

Valor devuelto

Puntero al panel de la cinta de opciones que se encuentra en el índice especificado.

Comentarios

Se produce una excepción si el nIndex está fuera del intervalo.

CMFCRibbonCategory::GetPanelCount

Devuelve el número de paneles de la cinta de opciones de la categoría de la cinta.

int GetPanelCount() const;

Valor devuelto

Número de paneles de la cinta de opciones de la categoría de la cinta.

CMFCRibbonCategory::GetPanelFromPoint

Recupera un puntero a un panel de la cinta de opciones si el punto especificado se encuentra en él.

CMFCRibbonPanel* GetPanelFromPoint(CPoint point) const;

Parámetros

point
[in] Coordenadas X e Y del puntero, relativas a la esquina superior izquierda de la ventana.

Valor devuelto

Puntero a un panel de la cinta de opciones si el método se realizó correctamente; en caso contrario, NULL.

Comentarios

Solo se prueban los paneles de la cinta de opciones contenidos en la categoría de la cinta.

CMFCRibbonCategory::GetPanelIndex

Recupera el índice de base cero del panel de la cinta de opciones especificado.

int GetPanelIndex(const CMFCRibbonPanel* pPanel) const;

Parámetros

pPanel
[in] Puntero a un elemento de la cinta de opciones.

Valor devuelto

Índice de base cero del panel de la cinta de opciones especificado si el método se realizó correctamente; en caso contrario, -1.

Comentarios

Solo se buscan los paneles de la cinta de opciones contenidos en la categoría de la cinta.

CMFCRibbonCategory::GetParentButton

Recupera el elemento primario de la cinta de opciones de la categoría de la cinta.

CMFCRibbonBaseElement* GetParentButton() const;

Valor devuelto

Devuelve un puntero al elemento primario de la cinta de opciones o NULL si no hay ningún elemento primario.

Comentarios

CMFCRibbonCategory::GetParentMenuBar

Devuelve un puntero a la barra de menús primaria del objeto CMFCRibbonCategory.

CMFCRibbonPanelMenuBar* GetParentMenuBar() const;

Valor devuelto

Devuelve los contenidos del miembro protegido m_pParentMenuBar.

Comentarios

CMFCRibbonCategory::GetParentRibbonBar

Recupera la barra primaria de la cinta de opciones de la categoría de la cinta.

CMFCRibbonBar* GetParentRibbonBar() const;

Valor devuelto

Puntero a la barra de la cinta primaria de opciones para la categoría de la cinta.

Comentarios

CMFCRibbonCategory::GetRect

Recupera el rectángulo de visualización de la categoría de la cinta de opciones.

CRect GetRect() const;

Valor devuelto

Rectángulo de visualización de la categoría de la cinta de opciones.

Comentarios

El rectángulo de visualización de la categoría de la cinta de opciones no incluye la pestaña de categoría.

CMFCRibbonCategory::GetSmallImages

Recupera la lista de imágenes pequeñas contenidas en la categoría de la cinta de opciones.

CMFCToolBarImages& GetSmallImages();

Valor devuelto

Lista de imágenes pequeñas contenidas en la categoría de la cinta de opciones.

CMFCRibbonCategory::GetTabColor

Devuelve el color actual de la pestaña de la categoría de la cinta de opciones.

AFX_RibbonCategoryColor GetTabColor() const;

Valor devuelto

Color actual de la pestaña de la categoría de la cinta.

Comentarios

El valor devuelto puede ser uno de los valores enumerados siguientes:

  • AFX_CategoryColor_Red

  • AFX_CategoryColor_Orange

  • AFX_CategoryColor_Yellow

  • AFX_CategoryColor_Green

  • AFX_CategoryColor_Blue

  • AFX_CategoryColor_Indigo

  • AFX_CategoryColor_Violet

CMFCRibbonCategory::GetTabRect

Recupera el rectángulo de visualización de la categoría de la pestaña de la cinta de opciones.

CRect GetTabRect() const;

Valor devuelto

Rectángulo de visualización de la pestaña de la categoría de la cinta de opciones.

Comentarios

CMFCRibbonCategory::GetTextTopLine

Recupera la ubicación vertical del texto en los botones de la cinta de opciones de la categoría de la cinta que muestran imágenes grandes.

int GetTextTopLine() const;

Valor devuelto

Ubicación vertical del texto, en píxeles, en botones de la cinta de opciones que muestran imágenes grandes.

Comentarios

CMFCRibbonCategory::GetVisibleElements

Recupera todos los elementos visibles que pertenezcan a la categoría de la cinta.

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

Parámetros

arElements
Matriz de todos los elementos visibles.

Comentarios

CMFCRibbonCategory::HighlightPanel

Resalta el panel de la cinta de opciones especificado.

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

Parámetros

pHLPanel
[in] Puntero al panel de la cinta de opciones que se va a resaltar.

point
[in] Coordenadas X e Y del puntero, relativas a la esquina superior izquierda de la ventana.

Valor devuelto

Puntero al panel de la cinta de opciones resaltado anteriormente; de lo contrario NULL, si no se resalta ningún panel de la cinta de opciones cuando se invoca este método.

Comentarios

Para obtener más información sobre cómo resaltar un panel de la cinta de opciones, consulte CMFCRibbonPanel::Highlight.

CMFCRibbonCategory::HitTest

Recupera un puntero a un elemento de la cinta de opciones si el punto especificado se encuentra en él.

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

Parámetros

point
[in] Coordenadas X y Y del puntero del mouse, relativas a la esquina superior izquierda de la ventana.

bCheckPanelCaption
[in] TRUE para probar el subtítulo del panel de la cinta; FALSE para excluir el subtítulo del panel de la cinta de opciones.

Valor devuelto

Puntero a un elemento de la cinta de opciones si el método se realizó correctamente; en caso contrario, NULL.

Comentarios

Solo se prueban los elementos de la cinta de opciones contenidos en la categoría de la cinta.

CMFCRibbonCategory::HitTestEx

Recupera el índice de base cero de un elemento de la cinta de opciones si el punto especificado se encuentra en él.

int HitTestEx(CPoint point) const;

Parámetros

point
[in] Coordenadas X y Y del puntero del mouse, relativas a la esquina superior izquierda de la ventana.

Valor devuelto

Índice de base cero de un elemento de la cinta de opciones si el método se realizó correctamente; en caso contrario, -1.

Comentarios

Solo se prueban los elementos de la cinta de opciones contenidos en la categoría de la cinta.

CMFCRibbonCategory::HitTestScrollButtons

Si un punto está dentro del botón de desplazamiento izquierdo o derecho de una categoría de cinta, devuelve un puntero a ese botón.

CMFCRibbonBaseElement* HitTestScrollButtons(CPoint point) const;

Parámetros

point
[in] Punto de prueba.

Valor devuelto

Si point está dentro del rectángulo delimitador del botón de desplazamiento izquierdo o derecho de la categoría de la cinta, devuelve un puntero a ese botón o, de lo contrario, devuelve NULL.

Comentarios

CMFCRibbonCategory::IsActive

Indica si la categoría de la cinta de opciones es la categoría activa en la barra de la cinta.

BOOL IsActive() const;

Valor devuelto

TRUE si la categoría de la cinta de opciones es la categoría activa; en caso contrario, FALSE.

Comentarios

La categoría de la cinta de opciones activa muestra sus paneles de cinta.

CMFCRibbonCategory::IsVisible

Indica si la categoría de la cinta es visible.

BOOL IsVisible() const;

Valor devuelto

TRUE si la categoría de la cinta está visible; en caso contrario, FALSE.

Comentarios

Las categorías de la cinta de opciones visibles muestran una pestaña de categoría.

CMFCRibbonCategory::IsWindows7Look

Indica si la cinta de opciones primaria tiene la apariencia de Windows 7 (botón de aplicación rectangular pequeño).

BOOL IsWindows7Look() const;

Valor devuelto

TRUE si la cinta primaria tiene la apariencia de Windows 7; de lo contrario, FALSE.

Comentarios

CMFCRibbonCategory::NotifyControlCommand

Entrega un mensaje de comando WM_NOTIFY a todos los elementos CMFCRibbonPanel de CMFCRibbonCategory hasta que se controle el mensaje.

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

Parámetros

bAccelerator
[in] TRUE si este comando se originó en un acelerador o FALSE en caso contrario.

nNotifyCode
El código de notificación.

wParam
[in] Campo WPARAM del mensaje.

lParam
[in] Campo LPARAM del mensaje.

Valor devuelto

Devuelve TRUE si el mensaje se ha controlado o FALSE si no es así.

Comentarios

CMFCRibbonCategory::OnCancelMode

Invoca el modo de cancelación en todos los elementos CMFCRibbonPanel de CMFCRibbonCategory.

virtual void OnCancelMode();

Comentarios

CMFCRibbonCategory::OnDraw

Llamado por el marco para dibujar la categoría de la cinta.

virtual void OnDraw(CDC* pDC);

Parámetros

pDC
[in] Puntero a un contexto de dispositivo para las categorías de la cinta de opciones.

Comentarios

CMFCRibbonCategory::OnDrawImage

Llamado por el marco para dibujar la imagen especificada en la categoría de la cinta de opciones.

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

Parámetros

pDC
[in] Puntero a un contexto de dispositivo para la imagen.

rect
[in] Muestra el rectángulo de la imagen.

pElement
[in] Puntero al elemento de la cinta de opciones que contiene la imagen.

bIsLargeImage
[in] TRUE si la imagen es el tamaño grande; FALSE si la imagen es el tamaño pequeño.

nImageIndex
[in] Índice de base cero de la imagen en la matriz de imágenes contenida en la categoría de la cinta de opciones.

bCenter
[in] TRUE para centrar la imagen en el rectángulo de visualización; FALSE para dibujar la imagen en la esquina superior izquierda del rectángulo de visualización.

Valor devuelto

TRUE si el método se aplicó correctamente; de lo contrario, FALSE.

Comentarios

CMFCRibbonCategory::OnDrawMenuBorder

El marco llama a esta clase para dibujar el borde de un menú emergente.

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

Parámetros

pDC
[in] Este parámetro no se utiliza.

pMenuBar
[in] Este parámetro no se utiliza.

Comentarios

De forma predeterminada, este método no hace nada. Invalide este método para dibujar el borde de un menú emergente.

CMFCRibbonCategory::OnKey

Lo llama el marco de trabajo cuando un usuario pulsa un botón de teclado.

virtual BOOL OnKey(UINT nChar);

Parámetros

nChar
El código de clave virtual de la tecla que presionó un usuario.

Comentarios

CMFCRibbonCategory::OnLButtonDown

El marco llama a esta clase para recuperar el elemento de la cinta de opciones bajo el punto especificado cuando el usuario presiona el botón izquierdo del mouse.

virtual CMFCRibbonBaseElement* OnLButtonDown(CPoint point);

Parámetros

point
[in] Coordenadas X y Y del puntero del mouse, relativas a la esquina superior izquierda de la ventana.

Valor devuelto

Puntero a un elemento de la cinta de opciones si el método se realizó correctamente; en caso contrario, NULL.

Comentarios

CMFCRibbonCategory::OnLButtonUp

El marco llama a esta clase cuando el usuario suelta el botón izquierdo del mouse y el puntero se encuentra sobre la categoría de la cinta de opciones.

virtual void OnLButtonUp(CPoint point);

Parámetros

point
[in] Coordenadas X e Y del puntero, relativas a la esquina superior izquierda de la ventana.

Comentarios

CMFCRibbonCategory::OnMouseMove

El marco llama a esta clase cuando el puntero se mueve en la barra de la cinta de opciones para actualizar la presentación de la categoría de la cinta.

virtual void OnMouseMove(CPoint point);

Parámetros

point
[in] Coordenadas X e Y del puntero, relativas a la esquina superior izquierda de la ventana.

Comentarios

CMFCRibbonCategory::OnRTLChanged

Llamado por el marco de trabajo cuando el diseño cambia de dirección.

virtual void OnRTLChanged(BOOL bIsRTL);

Parámetros

bIsRTL
[in] TRUE si el diseño está de derecha a izquierda; FALSE si el diseño está de izquierda a derecha.

Comentarios

Este método ajusta el diseño de todos los paneles de la cinta de opciones y de los elementos de la cinta contenidos en la categoría de la cinta.

CMFCRibbonCategory::OnScrollHorz

Desplaza la categoría de la cinta en la dirección horizontal.

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

Parámetros

bScrollLeft
[in] TRUE para desplazarse a la izquierda; FALSE para desplazarse a la derecha.

nScrollOffset
[in] Distancia de desplazamiento en píxeles.

Valor devuelto

TRUE si la categoría de la cinta se movió en una dirección horizontal; en caso contrario, FALSE.

Comentarios

CMFCRibbonCategory::OnUpdateCmdUI

Llama a la función miembro OnUpdateCmdUI en cada uno de los elementos CMFCRibbonPanel de CMFCRibbonCategory para habilitar o deshabilitar los elementos de la interfaz de usuario en ellos.

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

Parámetros

pCmdUI
[in] Puntero al objeto CMFCRibbonCmdUI que especifica qué elementos de la interfaz de usuario se van a habilitar y cuáles se van a deshabilitar.

pTarget
[in] Puntero a la ventana que controla la activación o desactivación de los elementos de la interfaz de usuario.

bDisableIfNoHndler
[in] TRUE para deshabilitar el elemento de interfaz de usuario si no se define ningún controlador en un mapa de mensajes; de lo contrario, FALSE.

Comentarios

CMFCRibbonCategory::RecalcLayout

Ajusta el diseño de todos los controles de la categoría de la cinta de opciones.

virtual void RecalcLayout(CDC* pDC);

Parámetros

pDC
[in] Puntero a un contexto de dispositivo para las categorías de la cinta de opciones.

Comentarios

CMFCRibbonCategory::RemovePanel

Quita un panel de la cinta de opciones de la categoría de la cinta.

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

Parámetros

nIndex
[in] Número de índice del panel que se va a quitar. Se obtiene al llamar al método CMFCRibbonCategory::GetPanelIndex .

bDelete
[in] TRUE para eliminar el objeto de panel de la memoria; FALSE para quitar el objeto de panel sin eliminarlo.

Valor devuelto

TRUE si el método se realizó correctamente; en caso contrario, FALSE.

CMFCRibbonCategory::ReposPanels

Ajusta el diseño de todos los controles de los paneles de la cinta de opciones contenidos en la categoría de la cinta.

virtual void ReposPanels(CDC* pDC);

Parámetros

pDC
[in] Puntero a un contexto de dispositivo para los paneles de la cinta de opciones contenidos en la categoría de la cinta.

Comentarios

CMFCRibbonCategory::SetCollapseOrder

Define el orden en el que se contraen los paneles de la cinta de opciones de la categoría de la cinta.

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

Parámetros

arCollapseOrder
[in] Especifica el orden de contracción. La matriz contiene índices de base cero de los paneles de la cinta de opciones.

Comentarios

La biblioteca define el orden de contracción. Sin embargo, se puede personalizar este comportamiento al proporcionar la categoría con la lista de índices que especifica el orden de contracción.

Cuando la categoría detecta que tiene que contraer un panel de la cinta de opciones, busca el siguiente elemento de la lista especificada. Si la lista está vacía o no se han especificado suficientes elementos, la categoría usa el algoritmo interno.

Por ejemplo, la categoría tiene tres paneles de cinta de opciones y se puede contraer varias veces hasta que todos los paneles estén en estado totalmente contraído. Se puede establecer el siguiente orden de contracción: 0, 0, 2, 2. En este caso, la categoría contraerá el panel 0 dos veces, el panel 2 dos veces. El panel que tiene el índice de 1 permanece sin contraerse.

Ejemplo

El siguiente ejemplo muestra cómo se usa el método SetCollapseOrder de la clase CMFCRibbonCategory. En el ejemplo se muestra cómo construir una matriz para el orden de contracción y cómo establecer el orden de contracción en la categoría de la cinta de opciones.

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

CMFCRibbonCategory::SetData

Establece los datos definidos por el usuario asociados a la categoría de la cinta.

void SetData(DWORD_PTR dwData);

Parámetros

dwData
[in] Datos definidos por el usuario.

CMFCRibbonCategory::SetKeys

Asigna una información sobre las teclas a la categoría de la cinta de opciones.

void SetKeys(LPCTSTR lpszKeys);

Parámetros

lpszKeys
[in] Texto de información sobre las teclas.

Comentarios

La información sobre las teclas se muestran cuando el usuario presiona la tecla Alt o la tecla F10.

CMFCRibbonCategory::SetName

Asigna una información sobre las teclas a la categoría de la cinta.

void SetName(LPCTSTR lpszName);

Parámetros

lpszName
[in] Nombre y información sobre las teclas de la categoría de la cinta de opciones.

Comentarios

Para establecer la información sobre la tecla de la categoría de la cinta de opciones, anexe una secuencia de escape de nueva línea seguida de los caracteres de información sobre las teclas en lpszName.

CMFCRibbonCategory::SetTabColor

Establece el color de la categoría de la cinta de opciones.

void SetTabColor(AFX_RibbonCategoryColor color);

Parámetros

color
[in] Especifica el nuevo color de la categoría de la cinta de opciones.

Comentarios

El color puede tener uno de los valores siguientes:

  • AFX_CategoryColor_None

  • AFX_CategoryColor_Red

  • AFX_CategoryColor_Orange

  • AFX_CategoryColor_Yellow

  • AFX_CategoryColor_Green

  • AFX_CategoryColor_Blue

  • AFX_CategoryColor_Indigo

  • AFX_CategoryColor_Violet

Consulte también

Gráfico de jerarquías
Clases
CObject (clase)