CMFCRibbonBaseElement (clase)
La clase CMFCRibbonBaseElement es la clase base para todos los elementos que se pueden agregar a una barra de cinta. Los botones, las casillas y los cuadros combinados de la cinta son ejemplos de elementos de la cinta.
Sintaxis
class CMFCRibbonBaseElement : public CObject
Miembros
Constructores públicos
| Nombre | Descripción |
|---|---|
CMFCRibbonBaseElement |
Construye un objeto CMFCRibbonBaseElement. |
Métodos públicos
| Nombre | Descripción |
|---|---|
| CMFCRibbonBaseElement::AddToKeyList | Agrega una información sobre teclas para el elemento de la cinta a una matriz de información sobre claves. |
| CMFCRibbonBaseElement::AddToListBox | Agrega un elemento de cinta al cuadro de lista de comandos de la cinta especificado. |
| CMFCRibbonBaseElement::CanBeAddedToQuickAccessToolBar | Indica si el elemento de la cinta se puede agregar a la barra de herramientas de acceso rápido. |
| CMFCRibbonBaseElement::CanBeCompacted | Indica si el tamaño del elemento de la cinta puede ser compacto. |
| CMFCRibbonBaseElement::CanBeStretched | Indica si el alto del elemento de la cinta puede aumentar verticalmente al alto de una fila de la cinta. |
| CMFCRibbonBaseElement::CanBeStretchedHorizontally | Indica si el ancho del elemento de la cinta puede cambiar. |
| CMFCRibbonBaseElement::CleanUpSizes | Limpia la configuración de dimensión para el elemento de la cinta. |
| CMFCRibbonBaseElement::ClosePopupMenu | Cierra el menú emergente del elemento de la cinta. |
| CMFCRibbonBaseElement::CopyFrom | Copia el estado del objeto especificado CMFCRibbonBaseElement en el objeto actual. |
| CMFCRibbonBaseElement::DestroyCtrl | Destruye el elemento de la cinta. |
| CMFCRibbonBaseElement::DrawImage | Dibuja la imagen del elemento de la cinta. |
| CMFCRibbonBaseElement::Find | Devuelve el puntero especificado al elemento de la cinta si apunta al objeto actual. |
| CMFCRibbonBaseElement::FindByData | Recupera un puntero al elemento de la cinta si contiene los datos especificados. |
| CMFCRibbonBaseElement::FindByID | Recupera un puntero al elemento de la cinta si ese elemento se identifica mediante el identificador de comando especificado. |
| CMFCRibbonBaseElement::FindByOriginal | Recupera un puntero al elemento de la cinta si su elemento de cinta original coincide con el elemento de cinta especificado. |
| CMFCRibbonBaseElement::GetCompactSize | Devuelve el tamaño compacto del elemento de la cinta. |
| CMFCRibbonBaseElement::GetData | Recupera los datos definidos por el usuario asociados al elemento de la cinta. |
| CMFCRibbonBaseElement::GetDescription | Devuelve la descripción del elemento de la cinta. |
| CMFCRibbonBaseElement::GetDroppedDown | Recupera un puntero al elemento de la cinta si se coloca su menú emergente. |
| CMFCRibbonBaseElement::GetElements | Agrega el elemento actual de la cinta a la matriz especificada. |
| CMFCRibbonBaseElement::GetElementsByID | Agrega el elemento de cinta actual a la matriz especificada si el elemento de cinta actual contiene el identificador de comando especificado. |
| CMFCRibbonBaseElement::GetHighlighted | Recupera un puntero al elemento de la cinta si está resaltado. |
| CMFCRibbonBaseElement::GetID | Devuelve el identificador de comando del elemento de la cinta. |
| CMFCRibbonBaseElement::GetImageSize | Devuelve el tamaño de la imagen del elemento de la cinta. |
| CMFCRibbonBaseElement::GetIntermediateSize | Devuelve el tamaño del elemento de la cinta en su estado intermedio. |
| CMFCRibbonBaseElement::GetKeys | Devuelve la información sobre claves asociada al elemento de la cinta. |
| CMFCRibbonBaseElement::GetKeyTipRect | Recupera el rectángulo de límite de la información sobre teclas para el elemento de la cinta. |
| CMFCRibbonBaseElement::GetKeyTipSize | Recupera el tamaño del texto de información sobre teclas. |
| CMFCRibbonBaseElement::GetLocationInGroup | Indica la ubicación para mostrar del elemento de la cinta en un grupo de cintas. |
| CMFCRibbonBaseElement::GetMenuKeys | Devuelve la información sobre teclas asociada a un botón. |
| CMFCRibbonBaseElement::GetNotifyID | Recupera el identificador de comando de notificación para el elemento de la cinta. |
| CMFCRibbonBaseElement::GetOriginal | Recupera el elemento original de la cinta. |
| CMFCRibbonBaseElement::GetParentCategory | Recupera la categoría de la cinta para el elemento de la cinta. |
| CMFCRibbonBaseElement::GetParentPanel | Recupera el panel de la cinta que contiene el elemento de la cinta. |
| CMFCRibbonBaseElement::GetParentRibbonBar | Recupera la barra de cinta primaria del elemento de la cinta. |
| CMFCRibbonBaseElement::GetParentWnd | Recupera la ventana primaria del elemento de la cinta. |
| CMFCRibbonBaseElement::GetPressed | Recupera un puntero al elemento de la cinta si el usuario lo presiona. |
| CMFCRibbonBaseElement::GetQuickAccessToolBarID | Recupera el identificador de comando del elemento de la cinta cuando se encuentra en la barra de herramientas de acceso rápido. |
| CMFCRibbonBaseElement::GetRect | Devuelve el rectángulo delimitador del elemento de la cinta. |
| CMFCRibbonBaseElement::GetRegularSize | Devuelve el tamaño normal del elemento de la cinta. |
| CMFCRibbonBaseElement::GetSize | Devuelve el tamaño actual del elemento de la cinta. |
| CMFCRibbonBaseElement::GetText | Devuelve el texto asociado al elemento de la cinta. |
| CMFCRibbonBaseElement::GetToolTipText | Devuelve el texto de información sobre herramientas del elemento de la cinta. |
| CMFCRibbonBaseElement::GetTopLevelRibbonBar | Recupera la barra de cinta de nivel superior para el elemento de la cinta. |
| CMFCRibbonBaseElement::HasCompactMode | Especifica si el elemento de la cinta tiene un modo compacto. |
| CMFCRibbonBaseElement::HasFocus | Indica si el elemento primario tiene el foco del teclado. |
| CMFCRibbonBaseElement::HasIntermediateMode | Especifica si el elemento de la cinta tiene un modo intermedio. |
| CMFCRibbonBaseElement::HasLargeMode | Especifica si el elemento de la cinta tiene un modo grande. |
| CMFCRibbonBaseElement::HasMenu | Indica si el elemento de la cinta tiene un menú. |
| CMFCRibbonBaseElement::HitTest | Recupera un puntero al elemento de la cinta si el punto especificado se encuentra en él. |
| CMFCRibbonBaseElement::IsAlignByColumn | Indica si el elemento de la cinta está alineado verticalmente con otros elementos de la cinta. |
| CMFCRibbonBaseElement::IsAlwaysLargeImage | Indica si el tamaño de la imagen del elemento de la cinta siempre es grande. |
| CMFCRibbonBaseElement::IsAutoRepeatMode | Indica si el elemento de la cinta está en modo de repetición automática. |
| CMFCRibbonBaseElement::IsChecked | Especifica si el elemento de la cinta está activado. |
| CMFCRibbonBaseElement::IsCompactMode | Especifica si el elemento de la cinta está en modo compacto. |
| CMFCRibbonBaseElement::IsDefaultMenuLook | |
| CMFCRibbonBaseElement::IsDisabled | Especifica si el elemento de la cinta está deshabilitado. |
| CMFCRibbonBaseElement::IsDroppedDown | Determina si el elemento de la cinta muestra un menú emergente y se coloca. |
| CMFCRibbonBaseElement::IsFocused | Especifica si el elemento de la cinta tiene el foco. |
| CMFCRibbonBaseElement::IsGalleryIcon | Indica si el elemento de la cinta está incluido en una galería de cinta. |
| CMFCRibbonBaseElement::IsHighlighted | Especifica si el elemento de la cinta está resaltado. |
| CMFCRibbonBaseElement::IsIntermediateMode | Indica si la imagen actual del elemento de la cinta es de tamaño intermedio. |
| CMFCRibbonBaseElement::IsLargeMode | Indica si la imagen actual del elemento de la cinta tiene un tamaño grande. |
| CMFCRibbonBaseElement::IsMenuMode | Indica si el elemento de la cinta está contenido en un menú. |
| CMFCRibbonBaseElement::IsPressed | Indica si el usuario ha realizado clic en el elemento de la cinta. |
| CMFCRibbonBaseElement::IsQATMode | Indica si el elemento de la cinta está contenido en la barra de herramientas de acceso rápido. |
| CMFCRibbonBaseElement::IsSeparator | Indica si el elemento de la cinta es un separador de pantalla. |
| CMFCRibbonBaseElement::IsShowGroupBorder | Indica si el elemento de la cinta está contenido en un grupo que muestra un borde común. |
| CMFCRibbonBaseElement::IsShowTooltipOnBottom | Indica si la información sobre herramientas se muestra en el elemento de la cinta. |
| CMFCRibbonBaseElement::IsTabStop | Indica si el elemento de la cinta se puede seleccionar con el teclado. |
| CMFCRibbonBaseElement::IsTextAlwaysOnRight | Indica si el texto del elemento de la cinta se muestra a la derecha. |
| CMFCRibbonBaseElement::IsVisible | Indica si el elemento de la cinta es un separador de pantalla. |
| CMFCRibbonBaseElement::IsWholeRowHeight | Indica si la altura de presentación del elemento de la cinta es la misma que la del panel de la cinta que lo contiene. |
| CMFCRibbonBaseElement::NotifyCommand | Envía una notificación de comando a la ventana primaria del elemento de la cinta. |
| CMFCRibbonBaseElement::NotifyHighlightListItem | Notifica a la ventana primaria de la barra de cinta cuando un usuario resalta un elemento de la cinta que se encuentra en una lista. |
| CMFCRibbonBaseElement::OnAddToQAToolbar | Agrega el elemento de la cinta a la barra de herramientas de acceso rápido especificada. |
| CMFCRibbonBaseElement::OnAfterChangeRect | Actualiza la información sobre herramientas del elemento de la cinta. |
| CMFCRibbonBaseElement::OnAutoRepeat | Actualiza el elemento de la cinta en respuesta a la entrada sostenida del usuario. |
| CMFCRibbonBaseElement::OnCalcTextSize | Calcula el tamaño del texto del elemento de la cinta. |
| CMFCRibbonBaseElement::OnChangeMenuHighlight | Llamado por el marco de trabajo cuando cambia el resaltado de un elemento de cinta que se encuentra en un menú. |
| CMFCRibbonBaseElement::OnDraw | Llamado por el marco de trabajo para dibujar el elemento de la cinta. |
| CMFCRibbonBaseElement::OnDrawKeyTip | Llamado por el marco de trabajo para dibujar la información sobre teclas para el elemento de la cinta. |
| CMFCRibbonBaseElement::OnDrawMenuImage | Llamado por el marco de trabajo cuando se dibuja la imagen de menú del elemento de la cinta. |
| CMFCRibbonBaseElement::OnDrawOnList | Llamado por el marco de trabajo para dibujar el elemento de la cinta en un cuadro de lista de comandos. |
| CMFCRibbonBaseElement::OnKey | Llamado por el marco de trabajo cuando el usuario presiona una información sobre teclas y el elemento de la cinta tiene el foco. |
| CMFCRibbonBaseElement::OnMenuKey | |
| CMFCRibbonBaseElement::OnRTLChanged | Llamado por el marco de trabajo cuando el diseño cambia de dirección. |
| CMFCRibbonBaseElement::OnShow | Llamado por el marco de trabajo para mostrar u ocultar el elemento de la cinta. |
| CMFCRibbonBaseElement::OnShowPopupMenu | Llamado por el marco de trabajo cuando el elemento de la cinta va a mostrar un menú emergente. |
| CMFCRibbonBaseElement::PostMenuCommand | |
| CMFCRibbonBaseElement::Redraw | Actualiza la presentación del elemento de la cinta. |
| CMFCRibbonBaseElement::SetACCData | Establece los datos de accesibilidad para el elemento de la cinta de opciones. |
| CMFCRibbonBaseElement::SetCompactMode | Establece el tamaño de presentación del elemento de la cinta. |
| CMFCRibbonBaseElement::SetData | Asocia un elemento de datos al elemento de la cinta. |
| CMFCRibbonBaseElement::SetDefaultMenuLook | |
| CMFCRibbonBaseElement::SetDescription | Establece la descripción del elemento de la cinta. |
| CMFCRibbonBaseElement::SetID | Establece el identificador de comando del elemento de la cinta. |
| CMFCRibbonBaseElement::SetInitialMode | Establece el tamaño de presentación inicial para el elemento de la cinta. |
| CMFCRibbonBaseElement::SetKeys | Establece una información sobre teclas para el elemento de la cinta. |
| CMFCRibbonBaseElement::SetOriginal | Establece el elemento original de la cinta para el elemento de la cinta. |
| CMFCRibbonBaseElement::SetParentCategory | Establece la categoría primaria del elemento de la cinta. |
| CMFCRibbonBaseElement::SetParentMenu | Establece el contenedor de menús primario para el elemento de la cinta. |
| CMFCRibbonBaseElement::SetParentRibbonBar | Establece la barra de cinta primaria para el elemento de la cinta. |
| CMFCRibbonBaseElement::SetRect | Establece las dimensiones que muestra el rectángulo para el elemento de cinta. |
| CMFCRibbonBaseElement::SetText | Establece el texto para el elemento de la cinta. |
| CMFCRibbonBaseElement::SetTextAlwaysOnRight | Establece el texto del elemento de la cinta que se va a mostrar a la derecha. |
| CMFCRibbonBaseElement::SetToolTipText | Establece el texto de la información sobre herramientas para el elemento de la cinta. |
| CMFCRibbonBaseElement::SetVisible | Establece el estado de visibilidad del elemento de la cinta. |
| CMFCRibbonBaseElement::StretchHorizontally | Extiende el ancho del elemento de la cinta. |
| CMFCRibbonBaseElement::StretchToWholeRow | Cambia el alto de presentación del elemento de la cinta a la altura de la fila especificada. |
| CMFCRibbonBaseElement::UpdateTooltipInfo | Actualiza el texto de la información sobre herramientas mediante el recurso de comando para el elemento de la cinta. |
Métodos protegidos
| Nombre | Descripción |
|---|---|
| CMFCRibbonBaseElement::OnProcessKey | Llamado por el marco de trabajo cuando el usuario presiona la tecla de método abreviado. |
| CMFCRibbonBaseElement::OnSetFocus | Llamado por el marco de trabajo cuando un elemento de la cinta recibe o pierde el foco de entrada. |
Comentarios
La clase CMFCRibbonBaseElement define las propiedades comunes a todos los elementos de la cinta que incluyen el identificador de comando, la etiqueta de texto, el texto de información sobre herramientas, la descripción del elemento y el estado (que se pueden centrar, resaltar, presionar, deshabilitar, comprobar o bajar).
El tamaño de la imagen de un elemento de la cinta está definido por el miembro RibbonImageType, que puede ser uno de los siguientes valores:
RibbonImageLargeRibbonImageSmall
En función de su tamaño, un elemento de la cinta muestra una imagen pequeña o grande.
Ejemplo
En el siguiente ejemplo se muestra cómo usar los distintos métodos en la clase CMFCRibbonBaseElement . En el ejemplo se muestra cómo obtener un objeto CMFCRibbonBaseElement de una clase CMFCRibbonStatusBar, establecer la descripción del elemento de la cinta, establecer el texto, establecer una información sobre teclas y establecer el texto de información sobre herramientas para el elemento de la cinta. Este fragmento de código forma parte del Ejemplo de cliente de dibujo.
// CMFCRibbonStatusBar m_wndStatusBar
CMFCRibbonBaseElement *pPane = m_wndStatusBar.FindByID(nID);
pPane->SetDescription(_T("a pane"));
// CString strText
pPane->SetText(strText);
pPane->SetKeys(_T("p"));
pPane->SetToolTipText(_T("this is a pane"));
Jerarquía de herencia
Requisitos
Encabezado: afxbaseribbonelement.h
CMFCRibbonBaseElement::AddToKeyList
Agrega una información sobre teclas para el elemento de la cinta a una matriz de información sobre claves.
virtual void AddToKeyList(
CArray<CMFCRibbonKeyTip*, CMFCRibbonKeyTip*>& arElems);
Parámetros
arElems
[in] Referencia a una CArray de información sobre teclas.
Comentarios
Cuando la característica de información sobre teclas de la cinta está activada, el marco muestra información sobre la cinta cuando el usuario pulsa la tecla ALT o la tecla F10.
CMFCRibbonBaseElement::AddToListBox
Agrega un elemento de cinta al cuadro de lista de comandos de la cinta especificado.
virtual int AddToListBox(
CMFCRibbonCommandsListBox* pWndListBox,
BOOL bDeep);
Parámetros
pWndListBox
[in] Puntero a un cuadro de lista de comandos.
bDeep
[in] Este parámetro no se utiliza.
Valor devuelto
Índice de base cero del elemento de la cinta agregado.
Comentarios
El marco agrega elementos de cinta a un cuadro de lista de comandos para permitir al usuario personalizar la interfaz de usuario.
CMFCRibbonBaseElement::CanBeAddedToQuickAccessToolBar
Indica si el elemento de la cinta se puede agregar a la barra de herramientas de acceso rápido.
virtual BOOL CanBeAddedToQuickAccessToolBar() const;
Valor devuelto
TRUE si se puede agregar el elemento; de lo contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::CanBeCompacted
Indica si el tamaño del elemento de la cinta puede ser compacto.
virtual BOOL CanBeCompacted() const;
Valor devuelto
TRUE si el tamaño del elemento de cinta de puede ser compacto; de lo contrario, se devuelve el valor FALSE.
Comentarios
El tamaño de un elemento de cinta puede ser compacto, intermedio o grande.
CMFCRibbonBaseElement::CanBeStretched
Indica si el alto del elemento de la cinta puede aumentar verticalmente al alto de una fila de la cinta.
virtual BOOL CanBeStretched();
Valor devuelto
Siempre devuelve TRUE.
Comentarios
De forma predeterminada, este método siempre devuelve TRUE. Invalide este método para indicar si el alto del elemento de la cinta puede aumentar verticalmente hasta el alto de una fila de la cinta.
CMFCRibbonBaseElement::CanBeStretchedHorizontally
Indica si el ancho del elemento de la cinta puede cambiar.
virtual BOOL CanBeStretchedHorizontally();
Valor devuelto
Siempre devuelve FALSE.
Comentarios
De forma predeterminada, este método siempre devuelve FALSE. Invalide este método para indicar si el ancho del elemento de la cinta puede cambiar.
CMFCRibbonBaseElement::CleanUpSizes
Limpia la configuración de dimensión para el elemento de la cinta.
virtual void CleanUpSizes();
Comentarios
De forma predeterminada, este método no hace nada. Invalide este método en una clase derivada para restablecer la configuración de dimensión para el elemento de la cinta.
CMFCRibbonBaseElement::ClosePopupMenu
Cierra el menú emergente del elemento de la cinta.
virtual void ClosePopupMenu();
Comentarios
CMFCRibbonBaseElement::CopyFrom
Copia el estado del CMFCRibbonBaseElement especificado en el objeto actual.
virtual void CopyFrom(const CMFCRibbonBaseElement& src);
Parámetros
src
[in] El objeto CMFCRibbonBaseElement de origen.
Comentarios
CMFCRibbonBaseElement::DestroyCtrl
Destruye el elemento de la cinta.
virtual void DestroyCtrl();
Comentarios
De forma predeterminada, este método no hace nada. Invalide este método en una clase derivada para destruir el elemento de la cinta.
CMFCRibbonBaseElement::DrawImage
Dibuja la imagen del elemento de la cinta.
virtual void DrawImage(
CDC* pDC,
RibbonImageType type,
CRect rectImage);
Parámetros
pDC
[in] Puntero a un contexto de dispositivo.
type
[in] Valor enumerado de tipo de imagen. Consulte la sección Comentarios para obtener una lista de valores posibles.
rectImage
[in] El rectángulo de la imagen.
Comentarios
De forma predeterminada, este método no hace nada. Invalide este método en una clase derivada para dibujar la imagen del elemento de la cinta.
En la siguiente tabla se muestran los posibles valores del parámetro tipo.
| Valor | Descripción |
|---|---|
RibbonImageLarge |
Tamaño de la imagen grande de 32 x 32 píxeles. |
RibbonImageSmall |
Tamaño de la imagen pequeño de 16 x 16 píxeles. |
CMFCRibbonBaseElement::Find
Devuelve el puntero especificado si apunta al objeto actual.
virtual CMFCRibbonBaseElement* Find(const CMFCRibbonBaseElement* pElement);
Parámetros
pElement
[in] Puntero a un elemento de la cinta.
Valor devuelto
Puntero al elemento de la cinta si pElement apunta al objeto actual; en caso contrario, se devuelve el valor NULL.
Comentarios
CMFCRibbonBaseElement::FindByData
Recupera un puntero al elemento de la cinta si contiene los datos especificados.
virtual CMFCRibbonBaseElement* FindByData(DWORD_PTR dwData);
Parámetros
dwData
[in] Los datos asociados a un elemento de la barra de opciones.
Valor devuelto
Puntero al elemento de la cinta si contiene los datos especificados; en caso contrario, se devuelve el valor NULL.
Comentarios
CMFCRibbonBaseElement::FindByID
Recupera un puntero al elemento de la cinta si ese elemento se identifica mediante el identificador de comando especificado.
virtual CMFCRibbonBaseElement* FindByID(UINT uiCmdID);
Parámetros
uiCmdID
[in] Identificador de comando de un elemento de la cinta.
Valor devuelto
Puntero al elemento de la cinta si ese elemento se identifica mediante el identificador de comando especificado; en caso contrario, se devuelve el valor NULL.
Comentarios
CMFCRibbonBaseElement::FindByOriginal
Recupera un puntero al elemento de la cinta actual si su elemento de la cinta original coincide con el elemento de la cinta especificado.
virtual CMFCRibbonBaseElement* FindByOriginal(CMFCRibbonBaseElement* pOriginal);
Parámetros
pOriginal
[in] Puntero a un elemento de la cinta.
Valor devuelto
Puntero al elemento de la cinta si su elemento de cinta original coincide con el elemento de la cinta especificado; en caso contrario, se devuelve el valor NULL.
Comentarios
Los elementos de la cinta que se copian en otro contenedor conservan un puntero al elemento original de la cinta.
CMFCRibbonBaseElement::GetCompactSize
Devuelve el tamaño compacto del elemento de la cinta.
virtual CSize GetCompactSize(CDC* pDC);
Parámetros
pDC
[in] Puntero a un contexto de dispositivo.
Valor devuelto
Tamaño compacto de un elemento de la cinta.
Nota:
El tamaño compacto significa que el elemento de la cinta se trunca (muestra una imagen pequeña o una imagen sin texto).
CMFCRibbonBaseElement::GetData
Recupera los datos definidos por el usuario asociados al elemento de la cinta.
DWORD_PTR GetData() const;
Valor devuelto
Los datos definidos por el usuario asociados al elemento de la cinta.
CMFCRibbonBaseElement::GetDescription
Devuelve la descripción del elemento de la cinta.
virtual CString GetDescription() const;
Valor devuelto
Descripción del elemento de la cinta. La descripción se muestra en la barra de estado o en una información sobre herramientas, o en el botón de menú si el elemento de la cinta se encuentra en CMFCRibbonMainPanel (clase).
CMFCRibbonBaseElement::GetDroppedDown
Recupera un puntero al elemento de la cinta si se coloca su menú emergente.
virtual CMFCRibbonBaseElement* GetDroppedDown();
Valor devuelto
Puntero al elemento de la cinta si se coloca su menú emergente; en caso contrario, se devuelve el valor NULL.
Comentarios
CMFCRibbonBaseElement::GetElements
Agrega el elemento actual de la cinta a la matriz especificada.
virtual void GetElements(
CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
Parámetros
arElements
[in, out] Matriz de elementos de la cinta.
Comentarios
CMFCRibbonBaseElement::GetElementsByID
Agrega el elemento de cinta actual a la matriz especificada si el elemento de cinta actual contiene el identificador de comando especificado.
virtual void GetElementsByID(
UINT uiCmdID,
CArray<CMFCRibbonBaseElement*, CMFCRibbonBaseElement*>& arElements);
Parámetros
uiCmdID
[in] Identificador de comando de un elemento de la cinta.
arElements
[in] Matriz de elementos de la cinta.
Comentarios
CMFCRibbonBaseElement::GetHighlighted
Recupera un puntero al elemento de la cinta si está resaltado.
virtual CMFCRibbonBaseElement* GetHighlighted();
Valor devuelto
Puntero al elemento de la cinta si está resaltado; en caso contrario, se devuelve el valor NULL.
Comentarios
CMFCRibbonBaseElement::GetID
Devuelve el identificador de comando del elemento de la cinta.
UINT GetID() const;
Valor devuelto
Identificador de comando del elemento de la cinta.
CMFCRibbonBaseElement::GetImageSize
Devuelve el tamaño de la imagen del elemento de la cinta.
virtual CSize GetImageSize(RibbonImageType R) const;
Valor devuelto
Tamaño de imagen del elemento de la cinta.
CMFCRibbonBaseElement::GetIntermediateSize
Devuelve el tamaño del elemento de la cinta en su estado intermedio.
virtual CSize GetIntermediateSize(CDC* pDC);
Parámetros
pDC
[in] Puntero a un contexto de dispositivo.
Valor devuelto
El tamaño del elemento de la cinta en su estado intermedio.
CMFCRibbonBaseElement::GetKeys
Devuelve la información sobre claves asociada al elemento de la cinta.
LPCTSTR GetKeys() const;
Valor devuelto
Información sobre teclas asociada al elemento de la cinta.
CMFCRibbonBaseElement::GetKeyTipRect
Recupera el rectángulo de límite de la información sobre teclas para el elemento de la cinta.
virtual CRect GetKeyTipRect(
CDC* pDC,
BOOL bIsMenu);
Parámetros
pDC
[in] Puntero a un contexto de dispositivo.
bIsMenu
[in] TRUE si el elemento de la cinta muestra un menú emergente; en caso contrario, se devuelve el valor FALSE.
Valor devuelto
Siempre devuelve un rectángulo con valores 0.
Comentarios
Invalide este método en una clase derivada para devolver el rectángulo de límite de la información sobre teclas.
CMFCRibbonBaseElement::GetKeyTipSize
Recupera el tamaño del texto de información sobre teclas.
virtual CSize GetKeyTipSize(CDC* pDC);
Parámetros
pDC
[in] Puntero a un contexto de dispositivo.
Valor devuelto
Tamaño del texto de la información sobre teclas.
Comentarios
CMFCRibbonBaseElement::GetLocationInGroup
Indica la ubicación para mostrar del elemento de la cinta en un grupo de cintas.
RibbonElementLocation GetLocationInGroup() const;
Valor devuelto
Valor RibbonElementLocation enumerado. En la tabla siguiente, se enumeran los valores posibles.
| Valor | Descripción |
|---|---|
RibbonElementNotInGroup |
El elemento de la cinta no está incluido en un grupo de la barra de herramientas. |
RibbonElementSingleInGroup |
El elemento de la cinta se muestra como el único elemento de un grupo de la barra de herramientas. |
RibbonElementFirstInGroup |
El elemento de la cinta se muestra en el extremo izquierdo de un grupo de la barra de herramientas. |
RibbonElementLastInGroup |
El elemento de cinta se muestra en el extremo derecho de un grupo de la barra de herramientas. |
RibbonElementMiddleInGroup |
El elemento de la cinta no se muestra en ningún extremo de un grupo de la barra de herramientas. |
Comentarios
Los grupos de elementos de la cinta solo se alinean horizontalmente.
CMFCRibbonBaseElement::GetMenuKeys
Devuelve la información sobre teclas de menú del elemento de la cinta.
LPCTSTR GetMenuKeys() const;
Valor devuelto
La información sobre teclas de menú asociada al elemento de la cinta.
Comentarios
Cuando se invoca, una información sobre teclas de menú muestra un menú emergente.
CMFCRibbonBaseElement::GetNotifyID
Recupera el identificador de comando de notificación para el elemento de la cinta.
virtual UINT GetNotifyID();
Valor devuelto
Identificador del comando de notificación.
Comentarios
CMFCRibbonBaseElement::GetOriginal
Recupera el elemento original de la cinta.
CMFCRibbonBaseElement* GetOriginal() const;
Valor devuelto
Puntero al elemento original de la cinta.
Comentarios
Los elementos de la cinta que se copian en otro contenedor conservan un puntero al elemento original de la cinta.
CMFCRibbonBaseElement::GetParentCategory
Recupera la categoría de la cinta para el elemento de la cinta.
CMFCRibbonCategory* GetParentCategory() const;
Valor devuelto
Puntero a la categoría de la cinta.
Comentarios
CMFCRibbonBaseElement::GetParentPanel
Recupera el panel de la cinta que contiene el elemento de la cinta.
virtual CMFCRibbonPanel* GetParentPanel() const;
Valor devuelto
Puntero al panel de la cinta que contiene el elemento de la cinta.
Comentarios
CMFCRibbonBaseElement::GetParentRibbonBar
Recupera la barra de cinta primaria del elemento de la cinta.
CMFCRibbonBar* GetParentRibbonBar() const;
Valor devuelto
Puntero a la barra de cinta primaria del elemento de la cinta.
Comentarios
CMFCRibbonBaseElement::GetParentWnd
Recupera la ventana primaria del elemento de la cinta.
virtual CWnd* GetParentWnd() const;
Valor devuelto
Puntero a la ventana primaria del elemento de la cinta si el método se realizó correctamente; de lo contrario, se devuelve el valor NULL.
Comentarios
La ventana primaria de un elemento de la cinta es una CMFCRibbonBar (clase) o una cmFCRibbonPanelMenuBar.
CMFCRibbonBaseElement::GetPressed
Recupera un puntero al elemento de la cinta si el usuario lo presiona.
virtual CMFCRibbonBaseElement* GetPressed();
Valor devuelto
Puntero al elemento de la cinta si el usuario lo presiona; en caso contrario, se devuelve el valor NULL.
Comentarios
CMFCRibbonBaseElement::GetQuickAccessToolBarID
Recupera el identificador de comando del elemento de la cinta cuando se encuentra en la barra de herramientas de acceso rápido.
virtual UINT GetQuickAccessToolBarID() const;
Valor devuelto
Identificador de comando del elemento de la cinta cuando se encuentra en la barra de herramientas de acceso rápido.
Comentarios
CMFCRibbonBaseElement::GetRect
Devuelve el rectángulo delimitador del elemento de la cinta.
CRect GetRect() const;
Valor devuelto
Rectángulo delimitador del elemento de la cinta. La posición del rectángulo está en las coordenadas del control primario de la cinta.
CMFCRibbonBaseElement::GetRegularSize
Devuelve el tamaño normal del elemento de la cinta.
virtual CSize GetRegularSize(CDC* pDC) = 0;
Parámetros
pDC
[in] Puntero a un contexto de dispositivo.
Valor devuelto
Tamaño normal del elemento de la cinta.
Comentarios
Nota:
El tamaño normal es el tamaño máximo posible del elemento de la cinta.
CMFCRibbonBaseElement::GetSize
Devuelve el tamaño actual del elemento de la cinta.
virtual CSize GetSize(CDC* pDC);
Parámetros
pDC
[in] Puntero a un contexto de dispositivo.
Valor devuelto
Tamaño actual del elemento de la cinta.
CMFCRibbonBaseElement::GetText
Devuelve el texto asociado al elemento de la cinta.
LPCTSTR GetText() const;
Valor devuelto
Texto asociado al elemento de la cinta.
CMFCRibbonBaseElement::GetToolTipText
Devuelve el texto de información sobre herramientas del elemento de la cinta.
virtual CString GetToolTipText() const;
Valor devuelto
Texto de información sobre herramientas del elemento de la cinta.
CMFCRibbonBaseElement::GetTopLevelRibbonBar
Recupera la barra de cinta de nivel superior para el elemento de la cinta.
CMFCRibbonBar* GetTopLevelRibbonBar() const;
Valor devuelto
Puntero a la barra de la cinta de nivel superior del elemento de la cinta si el método se realizó correctamente; en caso contrario, se devuelve el valor NULL.
Comentarios
CMFCRibbonBaseElement::HasCompactMode
Especifica si el elemento de la cinta tiene un modo compacto.
virtual BOOL HasCompactMode() const;
Valor devuelto
TRUE si el elemento de la cinta tiene un modo compacto. FALSE en caso contrario.
Comentarios
Nota:
En el modo compacto, un elemento muestra solo una imagen pequeña.
CMFCRibbonBaseElement::HasIntermediateMode
Especifica si el elemento de la cinta tiene un modo intermedio.
virtual BOOL HasIntermediateMode() const;
Valor devuelto
TRUE si el elemento de la cinta tiene un modo intermedio; en caso contrario, se devuelve el valor FALSE. En el modo intermedio, un elemento muestra una imagen pequeña y un texto a la derecha de la imagen.
Comentarios
CMFCRibbonBaseElement::HasLargeMode
Determina si el elemento de la cinta tiene un modo grande.
virtual BOOL HasLargeMode() const;
Valor devuelto
TRUE si el elemento de la cinta tiene un modo grande. FALSE en caso contrario.
Comentarios
En el modo grande, un elemento puede tomar el alto completo del panel primario.
CMFCRibbonBaseElement::HasMenu
Indica si el elemento de la cinta tiene un menú.
virtual BOOL HasMenu() const;
Valor devuelto
Siempre devuelve FALSE.
Comentarios
De forma predeterminada, este método siempre devuelve FALSE. Invalide este método en una clase derivada para indicar si el elemento de la cinta tiene un menú.
CMFCRibbonBaseElement::HitTest
Recupera un puntero al elemento de la cinta si el punto especificado se encuentra en él.
virtual CMFCRibbonBaseElement* HitTest(CPoint point);
Parámetros
point
[in] Este parámetro no se utiliza.
Valor devuelto
Puntero al elemento de la cinta si existe; en caso contrario, se devuelve el valor FALSE.
Comentarios
De forma predeterminada, este método siempre devuelve un puntero válido al elemento de la cinta cuando existe. Invalide este método para indicar si el punto reside en el elemento de la cinta.
CMFCRibbonBaseElement::IsAlignByColumn
Indica si el elemento de la cinta está alineado verticalmente con otros elementos de la cinta.
virtual BOOL IsAlignByColumn() const;
Valor devuelto
Siempre devuelve TRUE.
Comentarios
De forma predeterminada, este método siempre devuelve TRUE. Invalide este método en una clase derivada para indicar si el elemento de cinta derivado está alineado verticalmente con otros elementos de la cinta.
CMFCRibbonBaseElement::IsAlwaysLargeImage
Indica si el tamaño de la imagen del elemento de la cinta siempre es grande.
virtual BOOL IsAlwaysLargeImage() const;
Valor devuelto
TRUE si el tamaño de la imagen del elemento de la cinta siempre es grande; en caso contrario, se devuelve el valor FALSE.
Comentarios
El tamaño de la imagen grande es de 32 x 32 píxeles.
CMFCRibbonBaseElement::IsAutoRepeatMode
Indica si el elemento de la cinta está en modo de repetición automática.
virtual BOOL IsAutoRepeatMode(int& nDelay) const;
Parámetros
nDelay
[in] Este parámetro no se utiliza.
Valor devuelto
Siempre devuelve FALSE.
Comentarios
De forma predeterminada, este método siempre devuelve FALSE. Invalide este método para indicar si el elemento de la cinta está en modo de repetición automática.
En el modo de repetición automática, el elemento de la cinta responde en un intervalo establecido, medido en milisegundos, a la entrada sostenida del usuario.
CMFCRibbonBaseElement::IsChecked
Especifica si el elemento de la cinta está activado.
virtual BOOL IsChecked() const;
Valor devuelto
TRUE si se comprueba el elemento de la cinta; en caso contrario, se devuelve el valor FALSE.
CMFCRibbonBaseElement::IsCompactMode
Especifica si el elemento de la cinta está en modo compacto.
BOOL IsCompactMode() const;
Valor devuelto
TRUE si el elemento de cinta está en modo compacto; en caso contrario, se devuelve el valor FALSE.
CMFCRibbonBaseElement::IsDefaultMenuLook
Indica si el elemento de la cinta está establecido para que aparezca como un comando emergente.
BOOL IsDefaultMenuLook() const;
Valor devuelto
TRUE si el elemento de la cinta está establecido para que aparezca como un comando emergente; en caso contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::IsDisabled
Especifica si el elemento de la cinta está deshabilitado.
virtual BOOL IsDisabled() const;
Valor devuelto
TRUE si el elemento de la cinta está deshabilitado; en caso contrario, se devuelve el valor FALSE.
CMFCRibbonBaseElement::IsDroppedDown
Especifica si el elemento de la cinta muestra un menú emergente y se coloca.
virtual BOOL IsDroppedDown() const;
Valor devuelto
TRUE si el elemento de la cinta está colocado y muestra un menú emergente; en caso contrario, se devuelve el valor FALSE.
CMFCRibbonBaseElement::IsFocused
Especifica si el elemento de la cinta tiene el foco.
virtual BOOL IsFocused() const;
Valor devuelto
TRUE si el elemento de la cinta tiene el foco; en caso contrario, se devuelve el valor FALSE.
CMFCRibbonBaseElement::IsGalleryIcon
Indica si el elemento de la cinta está incluido en una galería de cinta.
virtual BOOL IsGalleryIcon() const;
Valor devuelto
Siempre devuelve FALSE.
Comentarios
De forma predeterminada, este método siempre devuelve FALSE. Invalide este método en una clase derivada para indicar si el elemento de la cinta está incluido en una galería de cintas.
CMFCRibbonBaseElement::IsHighlighted
Especifica si el elemento de la cinta está resaltado.
virtual BOOL IsHighlighted() const;
Valor devuelto
TRUE si el elemento de la cinta está resaltado; en caso contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::IsIntermediateMode
Indica si la imagen actual del elemento de la cinta es de tamaño intermedio.
BOOL IsIntermediateMode() const;
Valor devuelto
TRUE si la imagen del elemento de la cinta es de tamaño intermedio; en caso contrario, se devuelve el valor FALSE.
Comentarios
El tamaño intermedio de la imagen es de 16 x 16 píxeles.
CMFCRibbonBaseElement::IsLargeMode
Indica si la imagen actual del elemento de la cinta es de gran tamaño.
BOOL IsLargeMode() const;
Valor devuelto
TRUE si la imagen del elemento de cinta es de gran tamaño; en caso contrario, se devuelve el valor FALSE.
Comentarios
El tamaño de la imagen grande es de 32 x 32 píxeles.
CMFCRibbonBaseElement::IsMenuMode
Indica si el elemento de la cinta está contenido en un menú.
BOOL IsMenuMode() const;
Valor devuelto
TRUE si el elemento de la cinta está contenido en un menú; de lo contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::IsPressed
Indica si el usuario ha realizado clic en el elemento de la cinta.
virtual BOOL IsPressed() const;
Valor devuelto
TRUE si el usuario ha hecho clic en el elemento de la cinta; en caso contrario, se devuelve el valor FALSE.
CMFCRibbonBaseElement::IsQATMode
Indica si el elemento de la cinta está contenido en la barra de herramientas de acceso rápido.
BOOL IsQATMode() const;
Valor devuelto
TRUE si el elemento de la cinta está incluido en la barra de herramientas de acceso rápido; de lo contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::IsSeparator
Indica si el elemento de la cinta es un separador de pantalla.
virtual BOOL IsSeparator() const;
Valor devuelto
TRUE si el elemento de la cinta es un separador de pantalla; en caso contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::IsShowGroupBorder
Indica si el elemento de la cinta está contenido en un grupo que muestra un borde común.
BOOL IsShowGroupBorder() const;
Valor devuelto
TRUE si el elemento de la cinta está contenido en un grupo que muestra un borde común; de lo contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::IsShowTooltipOnBottom
Indica si la información sobre herramientas se muestra en el elemento de la cinta.
virtual BOOL IsShowTooltipOnBottom() const;
Valor devuelto
TRUE si la información sobre herramientas se muestra bajo el elemento de la cinta; FALSE si la información sobre herramientas se muestra cerca del puntero.
Comentarios
CMFCRibbonBaseElement::IsTabStop
Indica si el elemento de la cinta se puede seleccionar con el teclado.
virtual BOOL IsTabStop() const;
Valor devuelto
Siempre devuelve TRUE.
Comentarios
De forma predeterminada, este método siempre devuelve TRUE. Invalide este método para indicar si el elemento de la cinta se puede seleccionar con el teclado.
CMFCRibbonBaseElement::IsTextAlwaysOnRight
Indica si el texto del elemento de la cinta se muestra a la derecha.
BOOL IsTextAlwaysOnRight() const;
Valor devuelto
TRUE si el texto del elemento de la cinta se muestra a la derecha; de lo contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::IsVisible
Indica si el elemento de la cinta es un separador de pantalla.
BOOL IsVisible() const;
Valor devuelto
TRUE si el elemento de la cinta se muestra actualmente; de lo contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::IsWholeRowHeight
Indica si el alto de presentación del elemento de cinta es el mismo que el alto de presentación del panel de la cinta que lo contiene.
virtual BOOL IsWholeRowHeight() const;
Valor devuelto
Siempre devuelve FALSE.
Comentarios
De forma predeterminada, este método siempre devuelve FALSE. Invalide este método para indicar si el alto de presentación del elemento de la cinta es el mismo que el alto de presentación del panel de la cinta que lo contiene.
CMFCRibbonBaseElement::NotifyCommand
Envía una notificación de comando a la ventana primaria del elemento de la cinta.
BOOL NotifyCommand(BOOL bWithDelay = FALSE);
Parámetros
bWithDelay
[in] TRUE para agregar la notificación de comando a la cola de mensajes de la ventana primaria; FALSE para enviar el mensaje inmediatamente a la ventana primaria.
Valor devuelto
TRUE si se envió el mensaje; de lo contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::NotifyHighlightListItem
Notifica a la ventana primaria de la barra de cinta cuando un usuario resalta un elemento de la cinta que se encuentra en una lista.
virtual void NotifyHighlightListItem(int nIndex);
Parámetros
nIndex
[in] Índice del elemento de la cinta de la lista.
Comentarios
CMFCRibbonBaseElement::OnAddToQAToolbar
Agrega el elemento de la cinta a la barra de herramientas de acceso rápido especificada.
virtual BOOL OnAddToQAToolbar(CMFCRibbonQuickAccessToolBar& qat);
Parámetros
qat
[in] Barra de herramientas de acceso rápido.
Valor devuelto
Siempre devuelve TRUE que indica que el elemento de la cinta se agregó a la barra de herramientas de acceso rápido.
Comentarios
CMFCRibbonBaseElement::OnAfterChangeRect
Actualiza la información sobre herramientas del elemento de la cinta.
virtual void OnAfterChangeRect(CDC* pDC);
Parámetros
pDC
[in] Este parámetro no se utiliza.
Comentarios
De forma predeterminada, este método actualiza la información sobre herramientas para el elemento de la cinta. Invalide este método para actualizar el elemento de la cinta después de que haya cambiado su rectángulo para mostrar.
CMFCRibbonBaseElement::OnAutoRepeat
Actualiza el elemento de la cinta en respuesta a la entrada sostenida del usuario.
virtual BOOL OnAutoRepeat();
Valor devuelto
Siempre devuelve FALSE.
Comentarios
De forma predeterminada, este método siempre devuelve FALSE. Invalide este método para procesar la entrada de usuario sostenida.
CMFCRibbonBaseElement::OnCalcTextSize
Calcula el tamaño del texto del elemento de la cinta.
virtual void OnCalcTextSize(CDC* pDC);
Parámetros
pDC
[in] Este parámetro no se utiliza.
Comentarios
De forma predeterminada, este método no hace nada. Invalide este método para calcular el tamaño del texto del elemento de la cinta.
CMFCRibbonBaseElement::OnChangeMenuHighlight
Llamado por el marco de trabajo cuando cambia el resaltado de un elemento de cinta que se encuentra en un menú.
virtual void OnChangeMenuHighlight(CMFCRibbonPanelMenuBar* pPanelMenuBar
CMFCRibbonBaseElement* pHot);
Parámetros
pPanelMenuBar
[in] Este parámetro no se utiliza.
pHot
[in] Este parámetro no se utiliza.
Comentarios
De forma predeterminada, este método no hace nada. Invalide este método para actualizar un elemento de cinta que se encuentra en un menú cuando cambia el resaltado.
CMFCRibbonBaseElement::OnDraw
Llamado por el marco de trabajo para dibujar el elemento de la cinta.
virtual void OnDraw(CDC* pDC) = 0;
Parámetros
pDC
[in] Puntero a un contexto de dispositivo.
Comentarios
Invalide este método en una clase derivada si desea personalizar el dibujo de un elemento de cinta específico.
CMFCRibbonBaseElement::OnDrawKeyTip
Llamado por el marco de trabajo para dibujar la información sobre teclas para el elemento de la cinta.
virtual void OnDrawKeyTip(
CDC* pDC,
const CRect& rect,
BOOL bIsMenu);
Parámetros
pDC
[in] Puntero a un contexto de dispositivo.
rect
[in] Rectángulo de límite para la información sobre teclas.
bIsMenu
[in] TRUE si la información sobre teclas es para un botón de menú emergente; de lo contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::OnDrawMenuImage
Llamado por el marco de trabajo cuando se dibuja la imagen de menú del elemento de la cinta.
virtual BOOL OnDrawMenuImage(
CDC* pDC,
CRect rect);
Parámetros
pDC
[in] Puntero a un contexto de dispositivo.
rect
[in] Rectángulo de imagen de menú.
Valor devuelto
Siempre devuelve TRUE para indicar que se ha dibujado la imagen.
Comentarios
CMFCRibbonBaseElement::OnDrawOnList
Llamado por el marco de trabajo para dibujar el elemento de la cinta en un cuadro de lista de comandos.
virtual void OnDrawOnList(
CDC* pDC,
CString strText,
int nTextOffset,
CRect rect,
BOOL bIsSelected,
BOOL bHighlighted);
Parámetros
pDC
[in] Puntero a un contexto de dispositivo para el elemento de la cinta.
strText
[in] Texto para mostrar.
nTextOffset
[in] Distancia, en píxeles, desde el lado izquierdo del cuadro de la lista hasta el texto para mostrar.
rect
[in] El rectángulo de visualización del elemento de la cinta.
bIsSelected
[in] Este parámetro no se utiliza.
bHighlighted
[in] Este parámetro no se utiliza.
Comentarios
El cuadro de lista comandos muestra los elementos de la cinta para permitir a los usuarios personalizar la barra de herramientas de acceso rápido.
CMFCRibbonBaseElement::OnKey
Llamado por el marco de trabajo cuando el usuario presiona una información sobre teclas y el elemento de la cinta tiene el foco.
virtual BOOL OnKey(BOOL bIsMenuKey);
Parámetros
bIsMenuKey
[in] TRUE si la información sobre teclas muestra un menú emergente; en caso contrario, se devuelve el valor FALSE.
Valor devuelto
TRUE si el evento se ha controlado; en caso contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::OnMenuKey
Llamado por el marco de trabajo cuando el usuario presiona una información sobre teclas de menú en el panel principal.
virtual BOOL OnMenuKey(UINT nUpperChar);
Parámetros
nUpperChar
[in] Este parámetro no se utiliza.
Valor devuelto
Siempre devuelve FALSE.
Comentarios
De forma predeterminada, este método siempre devuelve FALSE. Invalide este método para responder cuando un usuario pulsa una información sobre teclas de menú en el panel principal.
CMFCRibbonBaseElement::OnProcessKey
Llamado por el marco de trabajo cuando el usuario presiona la tecla de método abreviado.
virtual BOOL OnProcessKey(UINT nChar);
Parámetros
nChar
[in] Este parámetro no se utiliza.
Valor devuelto
Siempre devuelve FALSE.
Comentarios
Invalide este método si desea que el elemento de la cinta procese una tecla de método abreviado.
CMFCRibbonBaseElement::OnRTLChanged
Llamado por el marco de trabajo cuando el diseño cambia de dirección.
virtual void OnRTLChanged(BOOL bIsRTL);
Parámetros
bIsRTL
[in] Este parámetro no se utiliza.
Comentarios
De forma predeterminada, este método no hace nada. Invalide este método para ajustar el elemento de la cinta cuando el diseño cambia de dirección. La dirección de diseño predeterminada es de izquierda a derecha.
CMFCRibbonBaseElement::OnSetFocus
Llamado por el marco de trabajo cuando un elemento de la cinta recibe o pierde el foco de entrada.
virtual void OnSetFocus(BOOL B);
Comentarios
Invalide este método en una clase derivada si desea que la aplicación controle un cambio en el foco de un elemento de la cinta.
CMFCRibbonBaseElement::OnShow
Llamado por el marco de trabajo para mostrar u ocultar el elemento de la cinta.
virtual void OnShow(BOOL bShow);
Parámetros
bShow
[in] Este parámetro no se utiliza.
Comentarios
De forma predeterminada, este método no hace nada. Invalide este método para mostrar u ocultar el elemento de la cinta.
CMFCRibbonBaseElement::OnShowPopupMenu
Llamado por el marco de trabajo antes de que el elemento de la cinta muestre un menú emergente.
virtual void OnShowPopupMenu();
Comentarios
Este método notifica a la ventana primaria de la barra de la cinta que el elemento de la cinta mostrará un menú emergente.
CMFCRibbonBaseElement::PostMenuCommand
Cierra el menú emergente del elemento de la cinta y envía un mensaje de cierre al menú primario.
void PostMenuCommand(UINT uiCmdId);
Parámetros
uiCmdId
[in] No se usa el parámetro.
Comentarios
El mensaje de cierre solo se envía si el elemento de la cinta se encuentra en un menú emergente.
CMFCRibbonBaseElement::Redraw
Actualiza la presentación del elemento de la cinta.
virtual void Redraw();
Comentarios
Este método vuelve a dibujar el rectángulo de presentación para el elemento de la cinta llamando CWnd::RedrawWindow con las marcas RDW_INVALIDATE, RDW_ERASE y RDW_UPDATENOW establecidas.
CMFCRibbonBaseElement::SetACCData
Establece los datos de accesibilidad para el elemento de la cinta de opciones.
virtual BOOL SetACCData(
CWnd* pParent,
CAccessibilityData& data);
Parámetros
pParent
La ventana principal para el elemento de la cinta de opciones.
data
Los datos de accesibilidad para el elemento de la cinta de opciones.
Valor devuelto
Siempre devuelve TRUE.
Comentarios
De forma predeterminada, este método establece los datos de accesibilidad para el elemento de la cinta de opciones y siempre devuelve TRUE. Invalide este método para establecer los datos de accesibilidad y devolver un valor que indique éxito o error.
CMFCRibbonBaseElement::SetCompactMode
Establece el tamaño de presentación del elemento de la cinta.
virtual void SetCompactMode(BOOL bCompactMode = TRUE);
Parámetros
bCompactMode
[in] TRUE para reducir el tamaño de presentación del elemento de cinta; FALSE para aumentar el tamaño de presentación del elemento de la cinta.
Comentarios
En la tabla siguiente se resume la lógica de este método.
| bCompactMode | Tamaño actual del elemento de la cinta | Nuevo tamaño de elemento de la cinta |
|---|---|---|
| TRUE | Compacto | Sin cambios. |
| TRUE | Intermedio | Compacto si es posible. |
| TRUE | grande | Intermedio si es posible. |
| FALSE | Compacto | Intermedio si es posible; de lo contrario, grande. |
CMFCRibbonBaseElement::SetData
Asocia un elemento de datos al elemento de la cinta.
void SetData(DWORD_PTR dwData);
Parámetros
dwData
[in] Valor de datos.
CMFCRibbonBaseElement::SetDefaultMenuLook
Establece el elemento de la cinta para que aparezca como un comando emergente.
void SetDefaultMenuLook(BOOL bIsDefaultMenuLook = TRUE);
Parámetros
bIsDefaultMenuLook
[in] TRUE para establecer el elemento de la cinta para que aparezca como un comando emergente; en caso contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::SetDescription
Establece la descripción del elemento de la cinta.
virtual void SetDescription(LPCTSTR lpszText);
Parámetros
lpszText
[in] Descripción del elemento de la cinta.
Comentarios
El marco muestra la nueva descripción en la barra de estado, en la información sobre herramientas o en el botón de menú.
CMFCRibbonBaseElement::SetID
Establece el identificador de comando del elemento de la cinta.
virtual void SetID(UINT nID);
Parámetros
Nid
[in] Identificador del comando.
CMFCRibbonBaseElement::SetInitialMode
Establece el tamaño de presentación inicial para el elemento de la cinta.
virtual void SetInitialMode(BOOL bOneRow = FALSE);
Parámetros
bOneRow
[in] TRUE para limitar el tamaño de presentación del elemento de la cinta a compacto o intermedio; de lo contrario, se devuelve el valor FALSE.
Comentarios
El tamaño de presentación de los elementos de la cinta puede ser compacto, intermedio o grande.
CMFCRibbonBaseElement::SetKeys
Establece la información sobre teclas para el elemento de la cinta.
virtual void SetKeys(
LPCTSTR lpszKeys,
LPCTSTR lpszMenuKeys=NULL);
Parámetros
lpszKeys
[in] La información sobre teclas para el elemento de la cinta.
lpszMenuKeys
[in] La información sobre teclas del menú emergente del elemento de la cinta.
CMFCRibbonBaseElement::SetOriginal
Establece el elemento original de la cinta para el elemento de la cinta.
virtual void SetOriginal(CMFCRibbonBaseElement* pOriginal);
Parámetros
pOriginal
[in] Puntero a un elemento de la cinta.
Comentarios
Los elementos de la cinta que se copian en otro contenedor conservan un puntero al elemento original de la cinta.
CMFCRibbonBaseElement::SetParentCategory
Establece la categoría primaria del elemento de la cinta.
virtual void SetParentCategory(CMFCRibbonCategory* pParent);
Parámetros
pParent
[in] Puntero a una categoría de la cinta.
Comentarios
Los grupos con pestañas de los controles de la cinta se denominan categorías.
CMFCRibbonBaseElement::SetParentMenu
Establece el contenedor de menús primario para el elemento de la cinta.
virtual void SetParentMenu(CMFCRibbonPanelMenuBar* pMenuBar);
Parámetros
pMenuBar
[in] Menú primario.
Comentarios
CMFCRibbonBaseElement::SetParentRibbonBar
Establece la barra de cinta primaria para el elemento de la cinta.
virtual void SetParentRibbonBar(CMFCRibbonBar* pRibbonBar);
Parámetros
pRibbonBar
[in] Puntero a la barra de la cinta primaria.
Comentarios
CMFCRibbonBaseElement::SetRect
Establece las dimensiones del rectángulo de presentación para el elemento de la cinta.
void SetRect(CRect rect);
Parámetros
rect
[in] Dimensiones del rectángulo.
Comentarios
CMFCRibbonBaseElement::SetText
Establece el texto y la información sobre teclas para el elemento de la cinta.
virtual void SetText(LPCTSTR lpszText);
Parámetros
lpszText
[in] Texto y información sobre teclas para el elemento de la cinta.
Comentarios
Para establecer la información sobre teclas para el elemento de la cinta, anexe la secuencia de escape de nueva línea seguida de los caracteres de la información sobre teclas a lpszText.
Ejemplo
//Set the text for the ribbon element
SetText(_T("Margins"))
//Set the text and a single-letter keytip
SetText(_T("Margins\nm"))
//Set the text and a multiple-letter keytip
SetText(_T("Line Numbers\nln"))
CMFCRibbonBaseElement::SetTextAlwaysOnRight
Establece el texto del elemento de la cinta que se va a mostrar a la derecha.
virtual void SetTextAlwaysOnRight(BOOL bSet = TRUE);
Parámetros
bSet
[in] TRUE para mostrar el texto de la derecha; en caso contrario, se devuelve el valor FALSE.
Comentarios
CMFCRibbonBaseElement::SetToolTipText
Establece el texto de la información sobre herramientas para el elemento de la cinta.
virtual void SetToolTipText(LPCTSTR lpszText);
Parámetros
lpszText
[in] Texto de información sobre herramientas.
CMFCRibbonBaseElement::SetVisible
Establece la visibilidad del elemento de la cinta.
void SetVisible(BOOL bIsVisible);
Parámetros
bIsVisible
[in] TRUE para mostrar el elemento de la cinta; FALSE para ocultar el elemento de la cinta.
Comentarios
CMFCRibbonBaseElement::StretchHorizontally
Extiende el ancho del elemento de la cinta.
virtual void StretchHorizontally();
Comentarios
De forma predeterminada, este método genera un error de aserción en las compilaciones de depuración y, por lo tanto, no debería ser llamado. Invalide este método para ajustar el ancho del elemento de la cinta.
CMFCRibbonBaseElement::StretchToWholeRow
Cambia el alto de presentación del elemento de la cinta a la altura de la fila especificada.
virtual BOOL StretchToWholeRow(
CDC* pDC,
int nHeight);
Parámetros
pDC
[in] Este parámetro no se utiliza.
nHeight
[in] Alto de la fila.
Valor devuelto
TRUE si se estableció el alto de la pantalla; de lo contrario, se devuelve el valor FALSE.
Comentarios
Invalide este método para cambiar el alto de presentación del elemento de la cinta al alto de fila especificado.
CMFCRibbonBaseElement::UpdateTooltipInfo
Actualiza el texto de la información sobre herramientas mediante el recurso de comando para el elemento de la cinta.
virtual void UpdateTooltipInfo();
Comentarios
CMFCRibbonBaseElement::HasFocus
Indica si el elemento primario tiene el foco del teclado.
virtual BOOL HasFocus() const;
Valor devuelto
TRUE si el elemento de la cinta está centrado; en caso contrario, se devuelve el valor FALSE.
Comentarios
Consulte también
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de