Clase wxHeaderCtrl

Constructor por defecto que no crea la ventana subyacente.

Se debe utilizar Create() después de crear el objeto utilizando este constructor.

Constructor que crea la ventana.

Consultar la documentación de los parámetros en Create().

Función auxiliar que añade los elementos seleccionables correspondientes a todas las columnas al menú dado.

Esta función es usada por ShowColumnsMenu() pero también puede ser usada si se muestra un menú propio de columnas personalizado y se quieren mostrar todas las columnas en él. Añadir elementos de menú con etiquetas de columna como texto e ids consecutivos empezando por idColumnsBase al menú y comprobar los elementos correspondientes a las columnas actualmente visibles.

Ejemplo de uso:

wxMenu menu;
menu.Append(100, "Some custom command");
menu.AppendSeparator();
AddColumnsItems(menu, 200);
const int rc = GetPopupMenuSelectionFromUser(menu, pt);
if ( rc >= 200 )
    ... toggle visibility of the column rc-200 ...

Parámetros

menu

El menú al que se añadirán los elementos. Puede estar vacío o no.

idColumnsBase

El id del elemento de menú correspondiente a la primera columna, las demás son consecutivas a partir de ella. Debe ser positivo.

Crea la ventana de control de cabecera.

Parámetros

parent

La ventana padre. El control de cabecera debería posicionarse típicamente a lo largo del borde superior de esta ventana.

winid

Id del control o wxID_ANY si no le importa.

pos

La posición inicial del control.

size

El tamaño inicial del control (normalmente no es muy útil ya que este control normalmente se redimensionará para tener el mismo ancho que el control de visualización de datos asociado).

style

El estilo del control, wxHD_DEFAULT_STYLE por defecto. Hay que tener en cuenta que el estilo por defecto permite al usuario reordenar las columnas arrastrándolas y se necesita desactivar explícitamente esta función utilizando:

wxHD_DEFAULT_STYLE & ~wxHD_ALLOW_REORDER 

si no se desea.

name

El nombre del control.

Método a implementar por las clases derivadas para devolver la información de la columna dada.

Parámetros

idx

El índice de la columna, entre 0 y el último valor pasado a SetColumnCount().

Devuelve el índice de la columna mostrada en la posición dada.

Parámetros

pos

La posición de visualización, por ejemplo 0 para la columna más a la izquierda, 1 para la siguiente y así sucesivamente hasta SetColumnCount() - 1.

Devuelve el número de columnas del control.

Valor de retorno

Número de columnas establecido previamente por SetColumnCount().

Obtiene la posición en la que se muestra actualmente esta columna.

Obsérvese que se devuelve una posición válida incluso para las columnas ocultas actualmente.

Parámetros

idx

El índice de la columna, debe ser menor que GetColumnCount().

Devuelve la matriz que describe el orden de visualización de las columnas.

Para los controles sin estilo wxHD_ALLOW_REORDER el array devuelto será el mismo que se pasó a SetColumnsOrder() previamente o definirá el orden por defecto (con n-ésimo elemento siendo n) si no se ha llamado. Pero para los controles con estilo wxHD_ALLOW_REORDER, las columnas también pueden ser reordenadas por el usuario.

Devuelve el ancho necesario para el título de la columna dada.

Devuelve el ancho necesario para la columna con el índice dado.

Esto es sólo una envoltura conveniente para la sobrecarga que toma wxHeaderColumn.

Devuelve true si el control tiene columnas.

Función auxiliar para manipular la matriz de índices de columnas.

Esta función reorganiza la matriz de índices de columnas indexadas por posiciones (es decir, utilizando la misma convención que para SetColumnsOrder()) de modo que la columna con el índice dado se encuentre en la posición especificada.

Parámetros

order

Matriz que contiene los índices de las columnas por orden de sus posiciones.

idx

El índice de la columna a mover.

pos

La nueva posición de la columna idx.

Puede sobrescribirse en la clase derivada para actualizar las estructuras de datos internas cuando cambia el número de columnas del control.

Este método es llamado por SetColumnCount() antes de cambiar efectivamente el número de columnas.

La versión de la clase base no hace nada pero es una buena práctica llamarlo desde la versión sobreescrita en la clase derivada.

Restablece el orden natural de las columnas.

Después de llamar a esta función, la columna con índice idx aparece en la posición idx en el control.

Establece el número de columnas del control.

El control utilizará GetColumn() para obtener información sobre todas las nuevas columnas y actualizarse, es decir, este método también tiene el mismo efecto que llamar a UpdateColumn() para todas las columnas, pero sólo debe utilizarse si el número de columnas ha cambiado realmente.

Cambia el orden de visualización de las columnas.

El orden de visualización define el orden en que aparecen las columnas en la pantalla y no afecta a la interpretación de los índices por parte de los demás métodos de la clase.

La matriz de orden especifica los índices de columna correspondientes a las posiciones de visualización.

Parámetros

order

Una permutación de todos los índices de columna, es decir, una matriz de tamaño GetColumnsOrder() que contiene todos los índices de columna exactamente una vez. El n-ésimo elemento de esta matriz define el índice de la columna mostrada en la n-ésima posición desde la izquierda (para la dirección de escritura por defecto de izquierda a derecha).

Muestra el menú emergente que permite al usuario mostrar u ocultar las columnas.

Esta función muestra el menú emergente que contiene todas las columnas con marcas de verificación para las que se muestran actualmente y permite al usuario marcarlas o desmarcarlas para cambiar su visibilidad. Es llamada desde el manejador por defecto EVT_HEADER_RIGHT_CLICK para los controles que tienen el estilo wxHD_ALLOW_HIDE. Y si la columna tiene también el estilo wxHD_ALLOW_REORDER, el menú también contiene un ítem para personalizar las columnas mostradas usando el cual se llama a ShowCustomizeDialog(), por favor ver su descripción para más detalles.

Si una columna fue toggleada, se llama a la función virtual UpdateColumnVisibility() por lo que debe ser implementada para los controles con estilo wxHD_ALLOW_HIDE o si se llama a esta función explícitamente.

Parámetros

pt

La posición del menú, en las coordenadas de la ventana de cabecera.

title

El título del menú si no está vacío.

Valor de retorno

true si se ha mostrado u ocultado una columna o false si no se ha hecho nada, por ejemplo porque se ha cancelado el menú.

Mostrar el diálogo de personalización de columnas.

Esta función muestra un diálogo modal que contiene la lista de todas las columnas que el usuario puede utilizar para reordenarlas, así como mostrar u ocultar columnas individuales.

Si el usuario acepta los cambios realizados en el diálogo, se llamará a los métodos virtuales UpdateColumnVisibility() y UpdateColumnsOrder() por lo que deben ser sobrescritos en la clase derivada si alguna vez se llama a este método. Nótese que el usuario podrá invocarlo interactivamente desde el menú emergente de la cabecera si el control tiene los estilos wxHD_ALLOW_HIDE y wxHD_ALLOW_REORDER.

Actualiza la columna con el índice dado.

Cuando el valor devuelto por GetColumn() cambia, este método debe ser llamado para notificar al control sobre el cambio y actualizar la presentación visual para que coincida con los nuevos datos de la columna.

Parámetros

idx

El índice de la columna, debe ser menor que GetColumnCount().

Método llamado cuando se cambia el orden de las columnas en el diálogo de personalización.

Este método sólo se llama desde ShowCustomizeDialog() cuando el usuario cambia el orden de las columnas. En particular no es llamado si una sola columna cambia de lugar porque el usuario la arrastró a la nueva ubicación, el manejador de eventos EVT_HEADER_END_REORDER debe ser usado para reaccionar a esto.

Una implementación típica en una clase derivada actualizará el orden de visualización de las columnas en el control asociado, si existe. Obsérvese que no hay necesidad de llamar a SetColumnsOrder() desde ella ya que wxHeaderCtrl lo hace por sí mismo.

La versión de la clase base no hace nada y debe ser sobreescrita si se llama a este método.

Parámetros

order

El nuevo orden de las columnas. Este array utiliza la misma convención que SetColumnsOrder().

Método llamado cuando la visibilidad de la columna es cambiada por el usuario.

Este método se llama desde ShowColumnsMenu() o ShowCustomizeDialog() cuando el usuario oculta o muestra interactivamente una columna. Una implementación típica simplemente actualizará el estado de la columna almacenado internamente. Obsérvese que no hay necesidad de llamar a UpdateColumn() desde este método ya que lo hace el propio wxHeaderCtrl.

La versión de la clase base no hace nada y debe ser sobrescrita si se llama a este método.

Parámetros

idx

El índice de la columna cuya visibilidad se ha cambiado.

show

El nuevo valor de visibilidad, true si la columna se muestra o false si no se oculta.

Método que puede ser implementado por las clases derivadas para permitir que al hacer doble clic en el separador de columna se redimensione la columna para ajustar su contenido.

Cuando se hace doble clic sobre un separador, el manejador por defecto del evento EVT_HEADER_SEPARATOR_DCLICK llama a esta función y refresca la columna si devuelve true, por lo que para implementar el redimensionamiento de la columna para ajustarla a su anchura al hacer doble clic sobre el encabezado es necesario implementar este método utilizando una lógica similar a la de este ejemplo:

class MyHeaderColumn : public wxHeaderColumn
{
public:
    ...
 
    void SetWidth(int width) { m_width = width; }
    virtual int GetWidth() const { return m_width; }
 
private:
    int m_width;
};
 
class MyHeaderCtrl : public wxHeaderCtrl
{
public:
protected:
    virtual wxHeaderColumn& GetColumn(unsigned int idx) const
    {
        return m_cols[idx];
    }
 
    virtual bool UpdateColumnWidthToFit(unsigned int idx, int widthTitle)
    {
        int widthContents = ... compute minimal width for column idx ...
        m_cols[idx].SetWidth(wxMax(widthContents, widthTitle));
        return true;
    }
 
    wxVector<MyHeaderColumn> m_cols;
};

La versión de la clase base simplemente devuelve false.

Parámetros

idx

El índice basado en cero de la columna a actualizar.

widthTitle

Contiene el ancho mínimo necesario para mostrar la propia cabecera de la columna y normalmente se utilizará como punto de partida para el cálculo del ancho de ajuste.

Valor de retorno

true para indicar que la columna fue redimensionada, es decir, GetColumn() devuelve ahora el nuevo valor de anchura, por lo que debe ser refrescada o false que significa que el control no llegó al doble clic separador.