Clase wxVariant

La clase wxVariant representa un contenedor para cualquier tipo.

Jerarquía:

El valor de una variante se puede cambiar en tiempo de ejecución, posiblemente a un tipo de valor diferente.

Nota: A partir de wxWidgets 2.9.1, wxAny se ha convertido en la clase variante preferida. Aunque la mayoría de los controles siguen utilizando wxVariant en su interfaz, se puede empezar a utilizar wxAny en el código gracias a una capa de conversión implícita. Consultar a continuación para obtener más información.

De forma estándar, wxVariant puede almacenar valores de tipo bool, wxChar, double, long, string, string list, time, date, void pointer, list of strings y list of variants. Sin embargo, una aplicación puede ampliar las capacidades de wxVariant derivando de la clase wxVariantData y utilizando la forma wxVariantData del constructor wxVariant o el operador de asignación para asignar estos datos a una variante. Los valores reales de los tipos definidos por el usuario deberán accederse a través del objeto wxVariantData, a diferencia de lo que ocurre con los tipos de datos básicos, en los que se pueden utilizar funciones de conveniencia como GetLong().

En Microsoft Windows, hay tres clases adicionales derivadas de wxVariantData (wxVariantDataCurrency, wxVariantDataErrorCode y wxVariantDataSafeArray) disponibles para la interoperabilidad con OLE VARIANT cuando se utiliza wxAutomationObject.

Los punteros a cualquier clase derivada de wxObject también se pueden almacenar fácilmente en un wxVariant. wxVariant utilizará entonces el sistema RTTI integrado en wxWidgets para establecer el nombre del tipo (devuelto por GetType()) y realizar comprobaciones de seguridad de tipos en tiempo de ejecución.

Esta clase es útil para reducir la programación de ciertas tareas, como un editor para diferentes tipos de datos o un protocolo de llamada a procedimientos remotos.

Un miembro opcional de nombre está asociado con un wxVariant. Esto podría utilizarse, por ejemplo, en clases de automatización CORBA u OLE, donde se requieren parámetros con nombre.

Hay que tener en cuenta que, a partir de wxWidgets 2.7.1, wxVariant cuenta con referencias.

Las macros de conveniencia wxDECLARE_VARIANT_OBJECT() y wxIMPLEMENT_VARIANT_OBJECT() permiten añadir fácilmente soporte para la conversión entre wxVariant y clases personalizadas. La primera de estas macros debe utilizarse dentro de la declaración de la clase y la segunda fuera de ella, en el archivo de implementación, por ejemplo:

// en el fichero de cabecera
class MyClass : public wxObject {
    ...
    wxDECLARE_VARIANT_OBJECT(MyClass);
};
 
// en el fichero de implementación
wxIMPLEMENT_VARIANT_OBJECT(MyClass);
 
// y entonces los objetos de MyClass se pueden usar con wxVariant de esta manera:
wxVariant variant;
MyClass value;
variant << value;
 
// o
value << variant;

Para que esto funcione, MyClass debe derivarse de wxObject, implementar el sistema RTTI de wxWidgets y admitir el operador de asignación y el operador de igualdad para sí mismo. Lo ideal sería que también se contara la referencia para que las operaciones de copia fueran económicas y rápidas. Esto se puede implementar más fácilmente utilizando la compatibilidad con el recuento de referencias que ofrece el propio wxObject. De forma predeterminada, wxWidgets ya implementa la conversión del operador de desplazamiento para algunas de sus clases relacionadas con el dibujo:

• wxColour.
• wxImage.
• wxIcon.
• wxBitmap.
• wxBitmapBundle.

Nota: También hay versiones heredadas de las macros anteriores sin el prefijo wx, que funcionan de forma ligeramente diferente. Utilizar las nuevas versiones en el nuevo código y considerar sustituir cualquier uso existente de las macros heredadas por las nuevas.

Hay que tener en cuenta que, a partir de wxWidgets 2.9.0, wxVariantData ya no hereda de wxObject y wxVariant ya no utiliza la clase wxList, insegura en cuanto al tipo, para las operaciones de lista, sino la clase wxVariantList, segura en cuanto al tipo. Además, wxVariantData ahora admite la función wxVariantData::Clone() para implementar la función Unshare(). wxVariantData::Clone() se implementa automáticamente mediante IMPLEMENT_VARIANT_OBJECT().

Dado que wxVariantData ya no deriva de wxObject, cualquier código que compruebe el tipo de datos utilizando wxDynamicCast() requerirá un ajuste. Se puede utilizar la macro wxDynamicCastVariantData() con los mismos argumentos que wxDynamicCast(), para utilizar la información de tipo RTTI de C++ en lugar de la RTTI de wxWidgets.

Capa de conversión de wxVariant a wxAny

wxAny es una clase variante más moderna basada en plantillas. No es directamente compatible con wxVariant, pero existe una capa de conversión transparente.

A continuación se muestra un ejemplo de cómo utilizar estas conversiones con la clase de propiedad wxPGProperty de wxPropertyGrid (que actualmente utiliza wxVariants tanto internamente como en la API pública):

// Obtener el valor de la propiedad como wxAny en lugar de wxVariant.
wxAny value = property->GetValue();
 
// Haz algo con ello.
DoSomethingWithString(value.As<wxString>());
 
// Escribir nuevo valor en la propiedad
value = "New Value";
property->SetValue(value);

Algunas advertencias:

• En wxAny, no hay tipos separados para manejar enteros de diferentes tamaños, por lo que convertir wxAny con un valor "long long" producirá un wxVariant de tipo "long" cuando el valor sea lo suficientemente pequeño como para caber sin desbordamiento. De lo contrario, se utiliza el tipo variante "longlong". También hay que tener en cuenta que wxAny que contiene enteros sin signo siempre se convertirá al tipo wxVariant "ulonglong".
• A diferencia de wxVariant, wxAny no almacena una cadena de nombre (que rara vez se necesita).
• Debido a la conversión implícita de wxVariant a wxAny, wxAny no suele contener valores de tipo wxVariant. En otras palabras, any.CheckType<wxVariant>() nunca puede devolver verdadero.

Las funciones de conversión proporcionadas funcionarán automáticamente con todos los tipos wxVariant integrados, así como con todos los tipos especificados por el usuario generados mediante IMPLEMENT_VARIANT_OBJECT(). Para las clases wxVariantData creadas manualmente, deberá utilizar las macros proporcionadas de la siguiente manera:

// Declarar wxVariantData para el tipo de datos Foo
class wxVariantDataFoo: public wxVariantData
{
public:
    // interfaz
    // ...
 
    DECLARE_WXANY_CONVERSION()
protected:
    // almacenamiento de datos, etc.
    // ...
};
 
IMPLEMENT_TRIVIAL_WXANY_CONVERSION(Foo, wxVariantDataFoo)

Funciones miembro

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

wxVariant()

~wxVariant()

Append()

Clear()

ClearList()

Convert()

Convert()

Convert()

Convert()

Convert()

Convert()

Convert()

Convert()

Delete()

GetAny()

GetArrayString()

GetBool()

GetChar()

GetCount()

GetData()

GetDateTime()

GetDouble()

GetList()

GetLong()

GetLongLong()

GetName()

GetString()

GetType()

GetULongLong()

GetVoidPtr()

GetWxObjectPtr()

Insert()

IsNull()

IsType()

IsValueKindOf()

MakeNull()

MakeString()

Member()

NullList()

SetData()

Unshare()

Operadores miembro

operatordouble()

operatorlong()

operatorvoid*()

operatorwxChar()

operatorwxDateTime()

operatorwxLongLong()

operatorwxString()

operatorwxULongLong()

operator!=()

operator!=()

operator!=()

operator!=()

operator!=()

operator!=()

operator!=()

operator!=()

operator!=()

operator!=()

operator!=()

operator!=()

operator!=()

operator!=()

operator=()

operator=()

operator=()

operator=()

operator=()

operator=()

operator=()

operator=()

operator=()

operator=()

operator=()

operator=()

operator=()

operator=()

operator=()

operator==()

operator==()

operator==()

operator==()

operator==()

operator==()

operator==()

operator==()

operator==()

operator==()

operator==()

operator==()

operator==()

operator==()

operator[]()

operator[]()

Métodos y datos heredados

Esta clase hereda los métodos y datos miembro públicos y protegidos de wxObject.