Clase wxPGProperty

Destructor virtual.

Es habitual que las propiedades derivadas lo implementen.

Constructor predeterminado.

Está protegido porque wxPGProperty es sólo una clase base para otras clases de propiedades.

Constructor.

Está protegido porque wxPGProperty es sólo una clase base para otras clases de propiedades. Las clases de propiedades no abstractas deben tener un constructor de este estilo:

MyProperty( const wxString& label, const wxString& name, const T& value )
    : wxPGProperty(label, name)
{
    // La forma generalmente recomendada de establecer el valor inicial 
    // (ya que debería funcionar prácticamente en el 100 % de los casos).
    wxVariant variant;
    variant << value;
    SetValue(variant);
 
    // Si tiene propiedades secundarias privadas, crearlas aquí.
    // Por ejemplo:
    //     AddPrivateChild( new wxStringProperty("Subprop 1",
    //                                           wxPG_LABEL,
    //                                           value.GetSubProp1()));
}

Establece la propiedad de la celda de manera que se reduzca el número de copias exclusivas de los datos de la celda.

Se utiliza, por ejemplo, al establecer el mismo color de fondo para varias propiedades.

Parámetros

firstCol

Primera columna a la que afecta.

lastCol

Última columna a la que afecta.

preparedCell

Celda preparada previamente que se utiliza para aquellas cuyos datos coincidían con unmodCellData.

srcData

Si unmodCellData no coincidió, los datos válidos de la celda se fusionan en la celda (por lo general, generando una nueva copia exclusiva de los datos de la celda).

unmodCellData

Si los datos de la celda coinciden con esto, su celda ahora se establece en preparedCell.

ignoreWithFlags

Se omiten las propiedades con cualquiera de estas banderas.

recursively

Si es verdadero, aplicar esta operación de forma recursiva en las propiedades secundarias.

Adapta la variante de la lista al valor adecuado mediante llamadas consecutivas a ChildChanged().

Añade una nueva opción a la lista de opciones de la propiedad.

Parámetros

label

Etiqueta de la opción añadida.

value

Valor de la nueva opción. No especificar si se desea que sea igual al índice de la opción.

Valor de retorno

Índice de la opción añadida.

Añade una propiedad secundaria privada.

Si se utiliza en lugar de wxPropertyGridInterface::Insert() o wxPropertyGridInterface::AppendIn(), el tipo principal de la propiedad se configurará automáticamente como wxPGFlags::Aggregate. En otras palabras, todas las propiedades de esta propiedad pasarán a ser privadas.

Utilizar esta función miembro para añadir hijos independientes (es decir, normales) a una propiedad.

Valor de retorno

La propiedad secundaria añadida.

Observaciones

wxPropertyGrid no se actualiza automáticamente con esta función.

Determina, de forma recursiva, si todos los hijos no están sin especificar.

Parámetros

pendingList

Asume que los miembros de esta lista wxVariant son valores de sustitución pendientes.

Devuelve verdadero si los hijos de esta propiedad son valores de componente (por ejemplo, el tamaño de los puntos, el nombre de la cara y is_underlined son valores de componente de una fuente).

Establece o borra el indicador de propiedad dado.

Principalmente para uso interno.

Observaciones

Establecer un indicador de propiedad nunca tiene ningún efecto secundario y está destinado casi exclusivamente para uso interno. Por lo tanto, por ejemplo, si se desea desactivar una propiedad, llamar a

Enable(false)

en lugar de establecer el indicador wxPGFlags::Disabled.

Se invoca después de que se haya modificado el valor de una propiedad secundaria.

Debe devolver el nuevo valor de toda la propiedad (después de cualquier modificación justificada por el nuevo valor de la propiedad secundaria).

Hay que tener en cuenta que esta función se suele invocar en el momento en que el valor de esta propiedad, o de una propiedad secundaria determinada, aún está pendiente de cambio y, por lo tanto, no se debe confiar en el resultado de GetValue() o m_value.

Ejemplo de implementación en pseudocódigo:

wxVariant MyProperty::ChildChanged( wxVariant& thisValue,
                                    int childIndex,
                                    wxVariant& childValue ) const
{
    // Obtener referencia al tipo real de datos almacenados en la variante 
    // (TFromVariant solo existe si se utilizaron las macros wxVariant de 
    // wxPropertyGrid para crear la clase variante).
    T& data = TFromVariant(thisValue);
 
    // Copiar childValue en data.
    switch ( childIndex )
    {
        case 0:
            data.SetSubProp1( childvalue.GetLong() );
            break;
        case 1:
            data.SetSubProp2( childvalue.GetString() );
            break;
        ...
    }
 
    // Devolver el data alterado
    return data;
}

Parámetros

thisValue

Valor de esta propiedad. Se debe devolver el valor modificado (en versiones anteriores de wxPropertyGrid sólo era necesario volver a escribir el valor en este argumento).

childIndex

Índice del elemento secundario modificado (se puede utilizar Item(childIndex) para obtener la propiedad secundaria).

childValue

(Pendiente) valor de la propiedad secundaria.

Valor de retorno

Valor modificado de toda la propiedad.

Reimplementado en wxFlagsProperty y wxFontProperty.

Borrar las celdas asociadas a la propiedad.

Parámetros

ignoreWithFlags

No se borrarán las celdas de las propiedades que tengan estas banderas activadas.

recursively

Si es verdadero, aplicar esta operación de forma recursiva en las propiedades secundarias.

Elimina los hijos de la propiedad.

Elimina la entrada del control wxPGChoices y del editor de la propiedad (si está activo).

Si se elimina el elemento seleccionado, el valor se establece en "sin especificar".

Esto es utilizado por Insert, etc.

Devuelve el valor de un atributo.

Sobrescribir si se necesita un manejo personalizado de los atributos.

La implementación predeterminada simplemente devuelve el variant nullptr.

Devuelve un puntero a una instancia del editor utilizado.

Devuelve el puntero al wxValidator que debe utilizarse con el editor de esta propiedad (nullptr si no hay validador).

Si se establece el validador explícitamente mediante SetPropertyValidator, se anulará esta configuración.

En la mayoría de los casos, un código como este debería funcionar correctamente (se utilizan macros para mantener una instancia de validador real, por lo que en la segunda llamada la función sale dentro de la primera macro):

wxValidator* wxMyPropertyClass::DoGetValidator () const
{
    WX_PG_DOGETVALIDATOR_ENTRY()
 
    wxMyValidator* validator = new wxMyValidator(...);
 
    ... preparar validador...
 
    WX_PG_DOGETVALIDATOR_EXIT(validator)
}

Observaciones

Se puede obtener el validador de nombres de archivo común devolviendo wxFileProperty::GetClassValidator(). wxDirProperty, por ejemplo, lo utiliza.

Reimplementado en wxDirProperty, wxFileProperty, wxFloatProperty, wxUIntProperty y wxIntProperty.

Anular para devolver un valor distinto de m_value como valor.

Reimplementar esta función miembro para añadir un tratamiento especial para los atributos de esta propiedad.

Valor de retorno

Devuelve false para que el atributo se almacene automáticamente en m_attributes. La implementación predeterminada simplemente hace eso y nada más.

Observaciones

Para establecer realmente los valores de los atributos de la propiedad desde la aplicación, utilizar wxPGProperty::SetAttribute() en su lugar.

Reimplementado en wxArrayStringProperty, wxFileProperty, wxEditorDialogProperty, wxFlagsProperty, wxBoolProperty, wxFloatProperty, wxUIntProperty, wxNumericProperty, wxStringProperty, wxDateProperty y wxSystemColourProperty.

Elimina todas las propiedades secundarias.

Activa o desactiva la propiedad.

Las propiedades desactivadas suelen aparecer con texto gris.

Parámetros

enable

Si es falso, la propiedad se desactiva.

Llamada para habilitar o deshabilitar el uso de valores comunes (valores enteros que se pueden seleccionar para las propiedades en lugar de sus valores normales) para esta propiedad.

Los valores comunes están deshabilitados de forma predeterminada para todas las propiedades.

Se asegura de que m_cells tenga un tamaño igual a column+1 (o más).

Compone texto a partir de los valores de las propiedades secundarias.

Devuelve el valor del atributo de propiedad, variant nula si no se encuentra.

Observaciones

Para los atributos integrados, devuelve una variant nula si se establece el estilo adicional wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES.

Devuelve el atributo nombrado, como cadena, si se encuentra.

De lo contrario, se devuelve defVal.

Observaciones

Para los atributos integrados, devuelve defVal si se establece el estilo adicional wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES.

Devuelve el atributo nombrado, como flotante de precisión doble, si se encuentra.

De lo contrario, se devuelve defVal.

Observaciones

Para los atributos integrados, devuelve defVal si se establece el estilo adicional wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES.

Devuelve el atributo nombrado, como un entero largo, si se encuentra.

De lo contrario, se devuelve defVal.

Observaciones

Para los atributos integrados, devuelve defVal si se establece el estilo adicional wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES.

Devuelve un almacenamiento similar a un mapa de los atributos de la propiedad.

Observaciones

Si se establece el estilo adicional wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES, los atributos integrados no se incluyen en el almacenamiento.

Devuelve los atributos como una lista wxVariant.

Observaciones

Si se establece el estilo adicional wxPG_EX_WRITEONLY_BUILTIN_ATTRIBUTES, los atributos integrados no se incluyen en la lista.

Devuelve el nombre base de la propiedad (es decir, el nombre del padre no se añade en ningún caso).

Devuelve wxPGCell de la columna dada, creando una si es necesario.

Devuelve wxPGCell de la columna dada.

Observaciones

La versión const de esta función miembro devuelve el objeto wxPGCell "predeterminado" si la propiedad en sí no contiene datos de celda.

Devuelve la instancia wxPGCellRenderer utilizada para la columna de propiedad dada (etiqueta=0, valor=1).

La implementación predeterminada devuelve el renderizador del editor para todas las columnas.

Devuelve el número de propiedades secundarias.

Devuelve la altura de los hijos, de forma recursiva y teniendo en cuenta el estado expandido/colapsado.

Parámetros

lh

Altura de línea. Pasa aquí el resultado de GetGrid()->GetRowHeight().

iMax

Sólo se utiliza (internamente) al buscar las posiciones y de las propiedades.

Devuelve una referencia de sólo lectura a la lista de opciones de la propiedad.

Devuelve la opción seleccionada actualmente.

Sólo se aplica a propiedades que tienen opciones.

Debe reimplementarse en la clase derivada si el valor de la propiedad no se asigna directamente a una opción. Los enteros como índice, booleanos y cadenas suelen hacerlo.

Reimplementado en wxFlagsProperty y wxEnumProperty.

Devuelve los datos del cliente (void*) de una propiedad.

Obtiene el objeto cliente gestionado de una propiedad.

Devuelve el editor utilizado para una columna determinada.

nullptr si no hay editor.

Devuelve el valor común seleccionado para esta propiedad.

-1 para ninguno.

Devuelve el valor predeterminado de la propiedad.

Si el tipo de valor de la propiedad no es uno integrado y no se ha definido el atributo "DefaultValue", esta función suele devolver el variant Null.

Devuelve el número de valores comunes mostrados para esta propiedad.

Devuelve el texto mostrado de la propiedad.

Devuelve wxPGEditor que se utilizará y creará cuando se seleccione la propiedad.

Devuelve un valor más preciso que DoGetEditorClass().

Devuelve una instancia de una nueva instancia de wxPGEditorDialogAdapter, que se utiliza cuando el usuario pulsa el botón (opcional) situado junto al control del editor.

La implementación predeterminada devuelve nullptr (es decir, no se genera ninguna acción cuando se pulsa el botón).

Reimplementado en wxEditorDialogProperty.

Obtiene indicadores como una cadena delimitada por "|".

Hay que tener en cuenta que los nombres de los indicadores no van precedidos de "wxPGFlags".

Parámetros

flagsMask

La cadena sólo incluirá los indicadores combinados por este parámetro.

Devuelve la cuadrícula de propiedades donde se encuentra la propiedad.

Devuelve el propietario wxPropertyGrid, pero sólo si hay uno actualmente en una página que muestra esta propiedad.

Devuelve el texto de ayuda o descripción de la propiedad.

Devuelve el texto de sugerencia de la propiedad (que se muestra en la celda de valor vacía).

Convierte el ancho de la imagen en un desplazamiento completo de la imagen, con márgenes.

Devuelve la posición en la matriz principal.

Devuelve la propiedad en la coordenada y virtual dada.

Devuelve la etiqueta de la propiedad.

Devuelve la última propiedad secundaria visible, de forma recursiva.

Devuelve el padre de nivel más alto que no sea categoría ni raíz.

Útil cuando se tienen propiedades anidadas con hijos.

Observaciones

Si el padre inmediato es raíz o categoría, devolverá la propia propiedad.

Devuelve la longitud máxima permitida del texto que el usuario puede introducir en el editor de texto de la propiedad.

Observaciones

Se devuelve 0 si la longitud no está limitada explícitamente y el texto puede ser tan largo como lo permita el widget de control de texto nativo subyacente.

Devuelve el nombre de la propiedad con todos los padres (que no sean de categoría ni raíz).

Devuelve el wxPGCell de la columna dada, creando una si es necesario.

Devuelve el padre de la propiedad.

Devuelve la propiedad secundaria (directa) con el nombre dado (o nullptr si no se encuentra).

Parámetros

name

Nombre de la propiedad secundaria que se busca.

Devuelve la propiedad secundaria (directa) con el nombre dado (o nullptr si no se encuentra), con el índice sugerido.

Parámetros

name

Nombre de la propiedad secundaria que se busca.

hintIndex

Comienza a buscar la propiedad secundaria en este índice.

Observaciones

No admite el ámbito (es decir, la notación Parent.Child).

Obtiene la versión asignable del validador de la propiedad.

Devuelve el valor de la propiedad.

Devuelve la representación textual del valor de la propiedad.

Parámetros

flags

Si wxPGPropValFormatFlags::Null (valor predeterminado), se devuelve la cadena mostrada. Si se establece wxPGPropValFormatFlags::FullValue, devuelve el valor completo de la cadena almacenable en lugar del valor visualizable. Si se establece wxPGPropValFormatFlags::EditableValue, devuelve el valor de la cadena que debe ser editable en textctrl. Si se establece wxPGPropValFormatFlags::CompositeFragment, devuelve el texto adecuado para mostrar como parte de la representación de texto compuesto de la propiedad de cadena.

Observaciones

En versiones anteriores, esta función se sobrescribía para convertir el valor de la propiedad en una representación de cadena. Ahora esta función la gestiona ValueToString(), y sobrescribirla provocará un error de assert en tiempo de ejecución.

Reimplementada en wxPropertyCategory.

Devuelve el mapa de bits que aparece junto al texto del valor.

Sólo devuelve un mapa de bits no nulo si se ha establecido uno con SetValueImage().

Devuelve el tipo de valor utilizado por esta propiedad.

Devuelve la coordenada a la parte superior y de la propiedad.

Hay que tener en cuenta que no se tiene en cuenta la posición de las barras de desplazamiento.

Comprueba si hay alguna propiedad secundaria.

Devuelve verdadero si la propiedad tiene el indicador establecido.

Devuelve verdadero si la propiedad tiene todos los indicadores especificados establecidos.

Devuelve verdadero si la propiedad tiene al menos un elemento secundario visible.

Oculta o muestra la propiedad.

Parámetros

hide

true para ocultar, false para mostrar.

flags

De forma predeterminada, los cambios se aplican de forma recursiva. Establecer este parámetro en wxPGPropertyValuesFlags::DontRecurse para evitarlo.

Devuelve el índice de la propiedad secundaria dada.

wxNOT_FOUND si la propiedad dada no es secundaria de esta.

Utilizar esta función miembro para añadir hijos independientes (es decir, normales) a una propiedad.

Valor de retorno

La propiedad secundaria insertada.

Observaciones

wxPropertyGrid no se actualiza automáticamente con esta función.

Inserta una nueva opción en la lista de opciones de la propiedad.

Parámetros

label

Texto para la nueva opción.

index

Posición de inserción. Utilizar wxNOT_FOUND para añadir.

value

Valor para la nueva opción. No especificarlo si se desea que sea igual al índice de la opción.

Convierte un entero (posiblemente una selección) en un valor wxVariant adecuado para esta propiedad.

Parámetros

variant

Al entrar en la función, este es el valor antiguo (no debería ser wxVariant nulo en casos normales). El valor traducido debe asignarse de nuevo a él.

number

Entero que se va a traducir a variante.

flags

Si se establece wxPGPropValFormatFlags::FullValue, devuelve el valor completo y almacenable en lugar del valor visible.

Valor de retorno

Devuelve verdadero si el valor wxVariant resultante era diferente.

Observaciones

Si no se supone que la propiedad utilice choice, spinctrl u otro editor con valores basados en enteros, no es necesario implementar este método.

La implementación predeterminada simplemente asigna el entero dado a m_value.

Si la propiedad utiliza el control choice y muestra un cuadro de diálogo en algunos elementos de elección, es preferible mostrar ese cuadro de diálogo en IntToValue en lugar de en OnEvent.

Es posible que se desee tener en cuenta que m_value es una variante Null si el valor de la propiedad no está especificado (lo que normalmente sólo ocurre si ha habilitado explícitamente ese comportamiento de clasificación).

Reimplementado en wxEnumProperty, wxBoolProperty, wxUIntProperty, wxIntProperty y wxSystemColourProperty.

Devuelve verdadero si esta propiedad es realmente una wxPropertyCategory.

Devuelve verdadero si la propiedad secundaria está seleccionada.

Devuelve verdadero si la propiedad está habilitada.

Devuelve verdadero si la propiedad tiene hijos visibles.

Devuelve verdadero si esta propiedad es realmente una wxRootProperty.

Devuelve verdadero si candidateParent es algún antecesor de esta propiedad.

Usarlo, por ejemplo, para detectar si el elemento se encuentra dentro de una sección colapsada.

Devuelve verdadero si se trata de una subpropiedad.

Devuelve verdadero si la propiedad tiene wxTextCtrl editable cuando se selecciona.

Observaciones

Aunque las propiedades deshabilitadas no se muestran en el editor, aquí siguen devolviendo verdadero, ya que la deshabilitación se considera una condición temporal (a diferencia de ser de sólo lectura o tener habilitada la edición limitada).

Devuelve verdadero si el valor de la propiedad se considera no especificado.

Esto suele significar que el valor es una variante nula.

Devuelve verdadero si todos los padres están expandidos.

Devuelve la propiedad secundaria en el índice i.

Devuelve la última subpropiedad.

Anular para pintar una imagen delante del texto del valor de la propiedad o del elemento de la lista desplegable (pero sólo si también se anula wxPGProperty::OnMeasureImage).

Si OnMeasureImage() de la propiedad devuelve un tamaño cuya altura es != 0 pero menor que la altura de la fila ( < 0 tiene un significado especial), wxPropertyGrid llama a este método para dibujar una imagen personalizada en un área limitada delante del control del editor o del texto/gráficos del valor, y si el control tiene una lista desplegable, la imagen también se dibuja allí (incluso en el caso de que OnMeasureImage() devuelva una altura mayor que la altura de la fila).

Nota: Lo siguiente se aplica cuando OnMeasureImage() devuelve una altura "flexible" (utilizando la macro wxPG_FLEXIBLE_SIZE(W,H)), lo que implica elementos de altura variable: Si (rect.x+rect.width) es < 0, entonces se trata de una llamada a un elemento de medida, lo que significa que dc no es válido y lo único que se debe hacer es establecer paintdata.m_drawnHeight en la altura de la imagen del elemento en el índice paintdata.m_choiceItem. Esta llamada se puede realizar incluso una vez cada vez que se muestra el menú desplegable.

Parámetros

dc

wxDC sobre el que pintar.

rect

Cuadro reservado para gráficos personalizados. Incluye el rectángulo circundante, si lo hay. Si x+width es < 0, entonces se trata de una llamada a un elemento de medida (véase más arriba).

paintdata

Estructura wxPGPaintData con muchos datos útiles sobre el elemento pintado.

struct wxPGPaintData
{
    // wxPropertyGrid.
    const wxPropertyGrid*   m_parent;
 
    // Normalmente -1, de lo contrario, índice del elemento de la lista desplegable que se debe dibujar.
    int                     m_choiceItem;
 
    // Establecer el ancho dibujado en OnCustomPaint (opcional).
    int                     m_drawnWidth;
 
    // En una llamada a un elemento de medida, establecer en la altura del elemento en el índice m_choiceItem.
    int                     m_drawnHeight;
};

Observaciones

• En realidad, se puede superar el ancho del rectángulo, pero si se hace, paintdata.m_drawnWidth debe establecerse en el ancho total dibujado en píxeles.
• Por motivos técnicos, la altura del rectángulo será la predeterminada, incluso si se ha especificado una altura personalizada durante la llamada de medición.
• Se garantiza que el pincel será del color de fondo predeterminado. Ya se ha utilizado para borrar el fondo del área que se está pintando. Se puede modificar.
• Se garantiza que el lápiz será de 1 de ancho y de color "negro" (o el color adecuado) para dibujar el rectángulo del marco. También se puede cambiar.

Reimplementado en wxImageFileProperty, wxCursorProperty y wxSystemColourProperty.

Los eventos recibidos por los widgets del editor se procesan aquí.

Hay que tener en cuenta que la clase del editor suele procesar la mayoría de los eventos. Algunos, como los eventos de pulsación de botones de la clase TextCtrlAndButton, se pueden gestionar aquí. Además, si se desea una gestión personalizada de los eventos habituales, también se puede hacer (por ejemplo, wxSystemColourProperty gestiona de forma personalizada wxEVT_CHOICE para mostrar el cuadro de diálogo del selector de color cuando se realiza una selección "personalizada").

Si el evento provoca un cambio en el valor, se debe llamar a SetValueInEvent() para establecer el nuevo valor.

El parámetro event es el wxEvent asociado.

Valor de retorno

Debe devolver true si se debe informar de cualquier cambio en el valor.

Observaciones

Si la propiedad utiliza un control de selección y muestra un cuadro de diálogo en algunos elementos de selección, es preferible mostrar ese cuadro de diálogo en IntToValue en lugar de en OnEvent.

Reimplementado en wxSystemColourProperty.

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

Este método debe sobrescribirse para devolver un valor no predeterminado si se va a llamar a OnCustomPaint.

Parámetros

item

Normalmente -1, pero puede ser un índice de la lista de elementos de la propiedad.

Observaciones

El comportamiento predeterminado es devolver wxSize(0,0), lo que significa que no hay imagen.

El ancho o alto predeterminado de la imagen se indica con la dimensión -1.

También se puede devolver wxPG_DEFAULT_IMAGE_SIZE, que es igual a wxDefaultSize.

Reimplementado en wxImageFileProperty, wxCursorProperty y wxSystemColourProperty.

Esta función virtual se invoca después de establecer m_value.

Observaciones

Si m_value se ha establecido en la variante Null (es decir, valor no especificado), no se invocará OnSetValue().

m_value puede ser de cualquier tipo de variante. Normalmente, las propiedades sólo admiten internamente un tipo de variante, por lo que OnSetValue() ofrece una buena oportunidad para convertir los valores admitidos en el tipo interno.

La implementación predeterminada no realiza ninguna acción.

Reimplementada en wxEditEnumProperty, wxArrayStringProperty, wxFileProperty, wxFlagsProperty, wxEnumProperty, wxStringProperty, wxDateProperty, wxMultiChoiceProperty, wxImageFileProperty, wxSystemColourProperty y wxFontProperty.

Se llama cada vez que falla la validación con un valor pendiente determinado.

Observaciones

Si implementa en una clase de propiedad personalizada, recordar llamar también a la implementación base, ya que pueden utilizarla para revertir la propiedad al estado anterior al cambio.

Si se crea el editor de la propiedad, esto fuerza su recreación.

Útil en SetAttribute, etc. Devuelve verdadero si realmente hizo algo.

Actualiza los valores de las propiedades secundarias.

Se llama automáticamente después de establecer el valor.

Reimplementado en wxFlagsProperty y wxFontProperty.

Si el editor de la propiedad está activo, actualiza su valor.

Establece un atributo para esta propiedad.

Parámetros

name

Identificador de texto del atributo. Consultar Identificadores de atributos de propiedad de wxPropertyGrid.

value

Valor del atributo.

Observaciones

Establecer el valor del atributo en la variante Null simplemente lo eliminará del conjunto de atributos de la propiedad.

Establece si el usuario puede cambiar el valor de la propiedad a no especificado modificando el valor del control del editor (normalmente borrándolo).

Actualmente, esto puede funcionar con las siguientes propiedades: wxIntProperty, wxUIntProperty, wxFloatProperty, wxEditEnumProperty.

Parámetros

enable

Si se habilita o deshabilita este comportamiento (está deshabilitado por defecto).

Establece el color de fondo de la propiedad.

Parámetros

color

Color de fondo que se va a utilizar.

flags

El valor predeterminado es wxPGPropertyValuesFlags::Recurse, lo que hace que el color se establezca de forma recursiva. Omitir esta bandera para establecer sólo el color de la propiedad en cuestión y no el de ninguna de sus propiedades secundarias.

Observaciones

A diferencia de wxPropertyGridInterface::SetPropertyBackgroundColour(), esto no actualiza automáticamente la visualización.

Establece la información de celda para una columna determinada.

Establece un nuevo conjunto de opciones para la propiedad.

Observaciones

Esta operación deselecciona la propiedad y borra su valor.

Establece la opción seleccionada y cambia el valor de la propiedad.

Intenta conservar el tipo de valor, aunque actualmente, si no es una cadena, se fuerza a entero.

Si newValue es wxNOT_FOUND (-1), el valor de la propiedad se restablece a no especificado, como si se hubiera llamado a SetValueToUnspecified().

Establece los datos del cliente (void*) de una propiedad.

Observaciones

Estos datos del cliente sin tipo deben eliminarse manualmente.

Establece el objeto cliente de una propiedad.

Establece el valor común seleccionado para esta propiedad.

-1 para ninguno.

Establece los colores predeterminados del texto y el fondo de la propiedad.

Parámetros

flags

El valor predeterminado es wxPGPropertyValuesFlags::Recurse, lo que hace que los colores se establezcan de forma recursiva. Omitir esta bandera para establecer sólo los colores de la propiedad en cuestión y no los de sus elementos secundarios.

Observaciones

A diferencia de wxPropertyGridInterface::SetPropertyColoursToDefault(), esto no actualiza automáticamente la visualización.

Establece el valor predeterminado de una propiedad.

Sinónimo de

    SetAttribute("DefaultValue", value);

Establece el editor para una propiedad.

Parámetros

editor

Para editores integrados, utilizar wxPGEditor_X, donde X es el nombre del editor integrado (TextCtrl, Choice, etc. Consultar la documentación de wxPGEditor para obtener la lista completa).

Para editores personalizados, utilizar el puntero que ha recibido de wxPropertyGrid::RegisterEditorClass().

Establece el editor de una propiedad, por nombre de editor.

Establece o borra el indicador de propiedad dado, de forma recursiva.

Esta función está destinada principalmente al uso interno.

Establece indicadores a partir de una cadena delimitada por "|".

Hay que tener en cuenta que los nombres de los indicadores no van precedidos de "wxPGFlags".

Establece la cadena de ayuda de la propiedad, que se muestra, por ejemplo, en el cuadro de texto de descripción de wxPropertyGridManager.

Establece la etiqueta de la propiedad.

Observaciones

Las propiedades bajo el mismo padre pueden tener las mismas etiquetas. Sin embargo, los nombres de las propiedades deben seguir siendo únicos. A diferencia de wxPropertyGridInterface::SetPropertyLabel(), esto no actualiza automáticamente la visualización.

Establece la longitud máxima del texto que el usuario puede introducir en el editor de texto asociado a la propiedad.

No afecta a la representación textual del valor ya almacenado cuando se establece el límite, ni afecta a la longitud de la representación textual del valor establecido mediante programación, por ejemplo, con SetValue() o wxPropertyGridInterface::SetPropertyValue(). Si maxLen es 0, la longitud no está limitada y el texto puede ser tan largo como lo permita el widget de control de texto nativo subyacente.

Valor de retorno

Devuelve true si se ha establecido la longitud máxima.

Establece el indicador "¿está modificado?" de la propiedad.

Afecta a los hijos de forma recursiva.

Establece un nuevo nombre (base) para la propiedad.

Cambia el tipo de padre que es esta propiedad para sus hijos.

Parámetros

flag

Utilizar uno de los siguientes valores: wxPGFlags::MiscParent (para padres genéricos), wxPGFlags::Category (para categorías) o wxPGFlags::Aggregate (para clases de propiedades derivadas con hijos privados).

Observaciones

Por lo general, no es necesario llamar a esta función.

Establece el color del texto de la propiedad.

Parámetros

color

Color del texto que se va a utilizar.

flags

El valor predeterminado es wxPGPropertyValuesFlags::Recurse, lo que hace que el color se establezca de forma recursiva. Omitir esta bandera para establecer sólo el color de la propiedad en cuestión y no el de ninguna de sus propiedades secundarias.

Observaciones

A diferencia de wxPropertyGridInterface::SetPropertyTextColour(), esto no actualiza automáticamente la visualización.

Establece wxValidator para una propiedad.

Llamar para establecer el valor de la propiedad.

A diferencia de los métodos de wxPropertyGrid, esto no actualiza automáticamente la visualización.

Observaciones

Utilizar wxPropertyGrid::ChangePropertyValue() si se necesita ejecutar el proceso de validación y enviar el evento de cambio de propiedad.

Si se necesita cambiar el valor de la propiedad en un evento, basándose en la entrada del usuario, utilizar SetValueInEvent() en su lugar.

Parámetros

value

El valor que se va a establecer.

pList

Puntero a la variante de lista que contiene los valores secundarios. Se utiliza para indicar qué elementos secundarios deben marcarse como modificados. Normalmente se utiliza nullptr.

flags

wxPGSetValueFlags::RefreshEditor está establecido por defecto, para actualizar el editor y volver a dibujar las propiedades.

Convierte un entero en un valor y, si tiene éxito, llama a SetValue() sobre él.

El comportamiento predeterminado es no hacer nada.

Parámetros

valor

Entero del que obtener el valor.

indicadores

Si tiene wxPGPropValFormatFlags::FullValue, entonces el valor dado es un valor real y no un índice.

Valor de retorno

true si se ha cambiado el valor.

Convierte una cadena en un valor y, si tiene éxito, llama a SetValue() sobre ella.

El comportamiento predeterminado es no hacer nada.

Parámetros

text

Cadena de la que se obtiene el valor.

flags

Si se establece wxPGPropValFormatFlags::FullValue, la función establece el valor completo y almacenable en lugar del valor visible (pueden ser diferentes). La bandera wxPGPropValFormatFlags::ProgrammaticValue se utiliza para indicar que el valor se establece mediante programación (es decir, la operación no es provocada por la entrada del usuario). Si se establece wxPGPropValFormatFlags::ReportError, se debe realizar una acción especial si la cadena no se ha podido convertir correctamente a un valor válido (por ejemplo, se puede establecer un valor especial en este caso).

Valor de retorno

true si se ha cambiado el valor.

Establece wxBitmap tomado del primero de wxBitmapBundle.

Este mapa de bits puede ser ignorado por los renderizadores de celdas personalizados.

Llamar a esta función en OnEvent(), OnButtonClick(), etc. para cambiar el valor de la propiedad en función de la entrada del usuario.

Observaciones

Este método es const, ya que en realidad no modifica el valor, sino que envía la variante dada como valor pendiente, almacenado en wxPropertyGrid.

Establece el valor de la propiedad como no especificado (es decir, variante Null).

Llamar con false en OnSetValue() para cancelar los cambios de valor después de todo (es decir, cancelar el true devuelto por StringToValue() o IntToValue()).

Convierte el texto en un valor wxVariant adecuado para esta propiedad.

Parámetros

variant

Al entrar en la función, este es el valor antiguo (no debería ser wxVariant nulo en casos normales). El valor traducido debe asignarse de nuevo a él.

text

Texto que se va a traducir a variante.

flags

Si se establece wxPGPropValFormatFlags::FullValue, devuelve el valor completo y almacenable en lugar del valor visible (pueden ser diferentes). Si se establece wxPGPropValFormatFlags::CompositeFragment, el texto se interpreta como parte del valor de cadena de la propiedad compuesta (tal y como lo genera ValueToString() llamado con esta misma bandera).

Valor de retorno

Devuelve verdadero si el valor wxVariant resultante era diferente.

Observaciones

La implementación predeterminada convierte los tokens delimitados por punto y coma en valores secundarios. Sólo funciona para propiedades con elementos secundarios.

Es posible que se desee tener en cuenta que m_value es una variante nula si el valor de la propiedad no está especificado (lo que normalmente sólo ocurre si ha habilitado explícitamente ese comportamiento de clasificación).

Reimplementado en wxArrayStringProperty, wxDirProperty, wxLongStringProperty, wxFileProperty, wxEditEnumProperty, wxEnumProperty, wxBoolProperty, wxFloatProperty, wxUIntProperty, wxIntProperty, wxStringProperty, wxDateProperty, wxMultiChoiceProperty, wxSystemColourProperty, wxFlagsProperty y wxPGRootProperty.

Actualiza los valores compuestos de las propiedades no categóricas principales, de forma recursiva.

Devuelve la propiedad superior actualizada.

Observaciones

No se debe llamar a SetValue() (ya que se puede llamar en él).

Devuelve verdadero si la cuadrícula contenedora utiliza wxPG_EX_AUTO_UNSPECIFIED_VALUES.

Implementar esta función en la clase derivada para comprobar el valor.

Devolver true si está bien. Devolver false impide que se produzcan eventos de cambio de propiedad.

Observaciones

La implementación predeterminada siempre devuelve true.

Reimplementado en wxEditEnumProperty, wxEnumProperty, wxFloatProperty, wxUIntProperty y wxIntProperty.

Convierte el valor de la propiedad en una representación de texto.

Parámetros

value

Valor que se va a convertir.

flags

Si wxPGPropValFormatFlags::Null (valor predeterminado), se devuelve la cadena mostrada. Si se establece wxPGPropValFormatFlags::FullValue, devuelve el valor completo de la cadena almacenable en lugar del valor visualizable. Si se establece wxPGPropValFormatFlags::EditableValue, devuelve el valor de la cadena que debe ser editable en textctrl. Si se establece wxPGPropValFormatFlags::CompositeFragment, devuelve el texto adecuado para mostrar como parte de la representación de texto compuesto de la propiedad de cadena.

Observaciones

La implementación predeterminada llama a GenerateComposedValue().

Reimplementado en wxArrayStringProperty, wxDirProperty, wxLongStringProperty, wxFileProperty, wxFlagsProperty, wxEnumProperty, wxBoolProperty, wxFloatProperty, wxUIntProperty, wxIntProperty, wxStringProperty, wxDateProperty, wxMultiChoiceProperty, wxCursorProperty, wxColourProperty, wxSystemColourProperty, wxFontProperty y wxPropertyCategory.

Este miembro es público, por lo que el código envolvente de enlaces de lenguaje de scripting puede acceder a él libremente.