Clase wxPropertyGrid

Constructor de dos pasos.

Llamar a Create() cuando se llame a este constructor para crear el wxPropertyGrid.

Constructor.

Los estilos que se utilizarán son estilos válidos para wxWindow

Destructor.

Añade una combinación de teclas determinada para activar una acción determinada.

A continuación se muestra un código de ejemplo para que al pulsar la tecla Intro se mueva el foco a la siguiente propiedad.

propGrid->AddActionTrigger(wxPGKeyboardAction::NextProperty,
                           WXK_RETURN);
propGrid->DedicateKey(WXK_RETURN);

Parámetros

Añade la propiedad dada a la selección.

Si no se utiliza el estilo adicional wxPG_EX_MULTIPLE_SELECTION, esto tiene el mismo efecto que llamar a SelectProperty().

Observaciones

La selección múltiple no es compatible con las categorías. Esto significa que si tiene propiedades seleccionadas, no puede añadir categorías a la selección, y si tiene categorías seleccionadas, no puede añadir otras propiedades a la selección. Esta función miembro fallará silenciosamente en estos casos, incluso devolviendo true.

Esta función estática habilita o deshabilita el uso automático de wxGetTranslation() para las siguientes cadenas: etiquetas de la lista wxEnumProperty, etiquetas de propiedades secundarias wxFlagsProperty.

El valor predeterminado es false.

Crea el editor de etiquetas wxTextCtrl para la columna dada, para la propiedad que está seleccionada actualmente.

Cuando la selección múltiple está habilitada, esto se aplica a cualquier propiedad que devuelva GetSelection().

Parámetros

colIndex

Etiqueta de la columna que se va a editar. Hay que tener en cuenta que no debe utilizar el valor 1, que está reservado para la columna de valores de propiedad.

Centra el divisor.

Parámetros

enableAutoResizing

Si es verdadero, se habilita el cambio automático de tamaño de las columnas (sólo aplicable si se utiliza el estilo de ventana wxPG_SPLITTER_AUTO_CENTER).

Cambia el valor de una propiedad, como si fuera desde un editor.

Utilizar esta función en lugar de SetPropertyValue() si se necesita que el valor se someta a un proceso de validación y también envíe wxEVT_PG_CHANGED.

Observaciones

Dado que esta función envía wxEVT_PG_CHANGED, no debe llamarse desde el controlador EVT_PG_CHANGED.

Valor de retorno

Devuelve true si el valor se ha cambiado correctamente.

Elimina todas las propiedades.

Implementa wxPropertyGridInterface.

Borra los desencadenantes de una acción determinada.

Parámetros

action

Acción que se va a borrar. Identificadores de acción de wxPropertyGrid.

Fuerza la actualización del valor de la propiedad desde el control del editor.

Hay que tener en cuenta que wxEVT_PG_CHANGING y wxEVT_PG_CHANGED se envían utilizando ProcessEvent, lo que significa que sus controladores de eventos se llamarán inmediatamente.

Valor de retorno

Devuelvetrue si se ha cambiado algo.

Creación en dos pasos.

Siempre que se cree el control sin ningún parámetro, utilizar Create para crearlo realmente. No acceder a los métodos públicos del control antes de llamar a esta función.

Asigna un código de tecla específico a wxPropertyGrid.

Esto significa que las pulsaciones de dichas teclas no se redirigirán a los controles del editor.

El uso de esta función permite, por ejemplo, navegar entre las propiedades utilizando las teclas de flecha, incluso cuando el foco está en el control del editor.

Anular en la clase derivada para ocultar un error mostrado por DoShowPropertyError().

Anular para personalizar el comportamiento de error de validación de propiedad.

Parámetros

property

Propiedad con un valor no válido introducido.

invalidValue

Valor que ha fallado en la validación.

Valor de retorno

Devuelve true si se permite al usuario cambiar a otra propiedad aunque la actual tenga un valor no válido.

Anular para personalizar el restablecimiento del estado de error de validación de la propiedad.

Observaciones

Se garantiza que la propiedad tiene establecida la bandera wxPGFlags::InvalidValue.

Registra una nueva clase de editor.

Valor de retorno

Devuelve el puntero a la instancia de la clase de editor que se debe utilizar.

Anular en la clase derivada para mostrar mensajes de error de forma personalizada (estos mensajes suelen ser el resultado de un fallo en la validación).

Observaciones

Si implementa esto, también se deberá implementar DoHidePropertyError(), posiblemente para no hacer nada, si el error no necesita ocultarse (por ejemplo, si se ha registrado o se ha mostrado en un cuadro de mensaje).

Dibuja el elemento, los hijos y los padres consecutivos siempre que no se cumpla la categoría.

Parámetros

p

Válido, es decir, no nulo, puntero de propiedad.

Llamada cuando se modifica el contenido del widget editor.

Por ejemplo, se llama cuando se cambia el texto en wxTextCtrl (utilizado en wxStringProperty y wxIntProperty).

Observaciones

Esta función sólo debe ser llamada por propiedades personalizadas.

Inverso de EditorsValueWasModified().

Observaciones

Esta función sólo debe ser llamada por propiedades personalizadas.

Activa o desactiva (muestra/oculta) las categorías según el parámetro enable.

Observaciones

Esta función deselecciona la propiedad seleccionada, si la hay. No se respeta la opción de fallo de validación wxPGVFBFlags::StayInProperty, es decir, la selección se borra incluso si el editor tenía un valor no válido.

Destruye el editor de etiquetas wxTextCtrl, si lo hay.

Parámetros

commit

Utilizar true (predeterminado) para almacenar el texto de la etiqueta editada en los datos de la celda de propiedad.

Desplaza y/o expande elementos para garantizar que el elemento dado sea visible.

Valor de retorno

Devuelve verdadero si realmente se ha realizado alguna acción.

Reduce el tamaño de las columnas al mínimo posible, conservando al mismo tiempo el contenido de la cuadrícula totalmente visible (etiquetas, imágenes).

Valor de retorno

El tamaño mínimo para que la cuadrícula siga mostrando todo.

Observaciones

No funciona bien con el estilo de ventana wxPG_SPLITTER_AUTO_CENTER.

    Esta función sólo funciona correctamente si el tamaño de la cuadrícula antes de la llamada ya era
    bastante grande.

    Hay que tener en cuenta que también se pueden obtener los anchos de columna calculados llamando a
    GetState()->GetColumnWidth() inmediatamente después de que esta función retorne.

Devuelve el color de fondo del título de la categoría actual.

Devuelve la fuente del título de la categoría actual.

Devuelve el color del texto del título de la categoría actual.

Devuelve el color de fondo de la celda actual.

Devuelve el color del texto de la celda actual cuando está desactivado.

Devuelve el color del texto de la celda actual.

Devuelve el número de columnas que hay actualmente en la cuadrícula.

Devuelve wxTextCtrl activo en la propiedad seleccionada actualmente, si existe.

Tiene en cuenta wxOwnerDrawnComboBox.

Devuelve el color del espacio vacío debajo de las propiedades.

Devuelve la altura de los caracteres más altos de la fuente utilizada.

Devuelve un puntero a sí mismo.

Función ficticia que permite que el mismo tipo de código utilice y wxPropertyGridManager.

Devuelve un rectángulo de imagen personalizada.

Parámetros

property

Devuelve el rectángulo de imagen para esta propiedad.

item

Qué opción de propiedad utilizar (cada opción puede tener una imagen diferente).

Devuelve el tamaño de la imagen personalizada delante de la propiedad.

Parámetros

property

Devuelve el rectángulo de imagen para esta propiedad. Si este argumento es nullptr, se devuelve el tamaño preferido.

item

Qué opción de propiedad utilizar (cada opción puede tener una imagen diferente).

Devuelve el editor de etiquetas actualmente activo, nullptr si no hay ninguno.

Devuelve el último elemento que se puede iterar utilizando los indicadores proporcionados.

Parámetros

flags

Véase Indicadores de wxPropertyGridIterator

Devuelve el color de las líneas entre celdas.

Devuelve el color de fondo del margen.

Devuelve el ancho del margen.

Devuelve la wxWindow, sobre el que se pintan las propiedades y que debe utilizarse como elemento principal para los controles del editor.

Devuelve la "propiedad raíz".

No tiene nombre, etc., y no es visible. Sólo es útil para acceder a sus elementos secundarios.

Devuelve la altura de una sola fila de la cuadrícula (en píxeles).

Devuelve la propiedad seleccionada actualmente.

Devuelve la propiedad seleccionada actualmente.

Devuelve el color de fondo de la selección actual.

Devuelve el color del texto seleccionado actualmente.

Devuelve la función de ordenación de la propiedad (el valor predeterminado es nullptr).

Devuelve la posición x actual del divisor.

Devuelve wxStatusBar que utiliza este wxPropertyGrid.

Se puede reimplementar esta función miembro en la clase derivada para anular el comportamiento predeterminado de utilizar la barra de estado de wxFrame de nivel superior, si la hay.

Devuelve el valor más actualizado de la propiedad seleccionada.

Esto devolverá un valor diferente de GetSelectedProperty()->GetValue() sólo cuando el editor de texto esté activo y la cadena editada por el usuario represente un valor de propiedad válido y no confirmado.

Devuelve la apariencia actual de las celdas con valores no especificados.

Devuelve una representación textual (visual) del valor de la propiedad no especificada.

Parámetros

flags

Sólo para uso interno.

Devuelve el espaciado vertical actual.

Devuelve información sobre una posición arbitraria en la cuadrícula.

Parámetros

pt

Coordenadas en el espacio de la cuadrícula virtual. Es posible que se necesite utilizar wxScrolled<T>::CalcScrolledPosition() para convertir las coordenadas del cliente wxPropertyGrid en algo que esta función miembro pueda utilizar.

Devuelve verdadero si el usuario ha modificado alguna propiedad.

Devuelve true si un control del editor de propiedades tiene el foco.

Devuelve verdadero si el valor del editor se ha marcado como modificado.

Devuelve verdadero si la actualización está congelada (es decir, se ha llamado a Freeze(), pero aún no a Thaw()

Se recomienda llamar a esta función cada vez que el código provoque un cambio en el elemento padre de nivel superior de wxPropertyGrid.

El controlador OnIdle() de wxPropertyGrid debería ser capaz de detectar la mayoría de los cambios, pero no es perfecto.

Parámetros

newTLP

Nuevo elemento padre de nivel superior que se va a establecer. La ventana del elemento padre de nivel superior anterior debería seguir existiendo como la actual.

Observaciones

Esta función se llama automáticamente desde wxPropertyGrid:: Reparent() y wxPropertyGridManager::Reparent(). Sólo es necesario utilizarla si se cambia indirectamente el padre de wxPropertyGrid.

Actualiza cualquier control de editor activo.

Vuelve a dibujar la propiedad dada.

Parámetros

p

Puntero de propiedad válido, es decir, no nulo.

Implementa wxPropertyGridInterface.

Reenvía a DoRegisterEditorClass con nombre vacío.

Elimina la propiedad dada de la selección.

Si la propiedad no está seleccionada, se producirá un error de assert.

Restablece todos los colores a los valores originales del sistema.

Restablece los tamaños de las columnas y las posiciones de los divisores, basándose en las proporciones.

Parámetros

enableAutoResizing

Si es verdadero, se habilita el cambio automático de tamaño de las columnas (sólo aplicable si se utiliza el estilo de ventana wxPG_SPLITTER_AUTO_CENTER).

Selecciona una propiedad.

El widget del editor se crea automáticamente, pero no se enfoca a menos que el foco sea verdadero.

Parámetros

id

Propiedad a seleccionar (nombre o puntero).

focus

Si es verdadero, mueve el foco del teclado al editor creado inmediatamente.

Valor de retorno

Devuelve verdadero si la selección se ha completado correctamente. Normalmente sólo falla si el valor actual del editor no es válido.

Observaciones

En wxWidgets 2.9 y versiones posteriores, esta función ya no envía wxEVT_PG_SELECTED.

Esto borra cualquier selección anterior.

Establece el color de fondo del título de la categoría.

Establece el color del texto del título de la categoría.

Establece el color de fondo predeterminado de las celdas; se aplica a las celdas de propiedades.

Hay que tener en cuenta que es posible que el aspecto de los widgets del editor no se vea afectado.

Establece el color del texto de las celdas para las propiedades desactivadas.

Establece el color predeterminado del texto de las celdas; se aplica al nombre de la propiedad y al texto del valor.

Hay que tener en cuenta que es posible que el aspecto de los widgets del editor no se vea afectado.

Establecer el número de columnas (2 o más).

Establece la categoría "actua": Append añadirá propiedades que no pertenecen a ninguna categoría debajo de ella.

Establece el color del espacio vacío debajo de las propiedades.

Establece el color de las líneas entre celdas.

Establece el color de fondo del margen.

Establecer una selección completamente nueva a partir de una lista determinada de propiedades.

Establece el color de fondo de la selección: se aplica al fondo del nombre de la propiedad seleccionada.

Establece el color de primer plano de la selección; se aplica al texto del nombre de la propiedad seleccionada.

Establece la función de ordenación de propiedades.

Parámetros

sortFunction

La función de ordenación que se va a utilizar. Debe devolver un valor superior a 0 si la posición de p1 es posterior a p2. Así, por ejemplo, al comparar nombres de propiedades, se puede utilizar la siguiente implementación:

int MyPropertySortFunction(wxPropertyGrid* propGrid,
                           wxPGProperty* p1,
                           wxPGProperty* p2)
{
    return p1->GetBaseName().compare( p2->GetBaseName() );
}

Observaciones

La función de ordenación de propiedades predeterminada ordena las propiedades por sus etiquetas (sin distinguir entre mayúsculas y minúsculas).

Mueve el divisor lo más a la izquierda posible, sin impedir que se muestren todas las etiquetas por completo.

Parámetros

privateChildrenToo

Si es falso, seguirá permitiendo que se recorten los hijos privados.

Establece la coordenada x del divisor.

Observaciones

La posición del divisor no puede exceder el tamaño de la cuadrícula, por lo que establecerla durante la creación del formulario puede fallar, ya que el tamaño inicial de la cuadrícula suele ser menor que la posición deseada del divisor, especialmente cuando se utilizan controladores de tamaño.

Establece la apariencia de las celdas de valor que representan un valor de propiedad no especificado.

La apariencia predeterminada es en blanco.

Observaciones

Si se establece el valor no especificado para que tenga alguna representación textual, esto anulará el atributo "InlineHelp".

Debe llamarse en wxPGEditor::CreateControls() si la ventana principal del editor es wxTextCtrl, justo antes de crear el control de texto.

Parámetros

text

Valor inicial del texto del wxTextCtrl creado.

Establece el espaciado vertical.

Puede ser 1, 2 o 3, un valor relativo a la altura de la fuente. El valor 2 debería ser el predeterminado en la mayoría de las plataformas.

Establece el ancho virtual para esta página en particular.

El ancho -1 indica que el ancho virtual debe estar desactivado.

Muestra un breve mensaje de error relacionado con una propiedad.

Desenfoca o cierra el editor si estaba abierto, pero no deselecciona la propiedad.

Llamar a esto desde wxPGProperty::OnEvent() para provocar que el valor de la propiedad cambie después de que la función regrese (con true como valor de retorno).

ValueChangeInEvent() debe usarse si se desea que la aplicación pueda usar wxEVT_PG_CHANGING para vetar potencialmente el valor dado.

Se puede utilizar esta función miembro, por ejemplo, para detectar en wxPGProperty::OnEvent() si wxPGProperty::SetValueInEvent() ya se ha llamado en a href="/winapi/wxwidgets/wxclass/wxPGEditor#OnEvent">wxPGEditor::OnEvent().

En realidad, sólo detecta si el valor se ha modificado utilizando wxPGProperty::SetValueInEvent(), que suele utilizarse cuando se muestra un cuadro de diálogo "selector". Si el valor se ha escrito por "medios normales" en wxPGProperty::StringToValue() o IntToValue(), esta función devolverá falso (por otro lado, wxPGProperty::OnEvent() ni siquiera se llama en esos casos).