gauge.h

Clase wxGauge

Un indicador o barra de progreso es una barra horizontal o vertical que muestra una cantidad (a menudo tiempo).

Jerarquía:

Jerarquía de la clase wxGauge

wxGauge soporta dos modos de trabajo: progreso determinado e indeterminado.

El primero es el modo de trabajo habitual (ver SetValue() y SetRange()) mientras que el segundo se puede utilizar cuando el programa está realizando algún proceso pero no se sabe cuánto se está avanzando. En este caso, puede llamar periódicamente a la función Pulse() para hacer que la barra de progreso cambie a modo indeterminado (gráficamente suele ser un conjunto de bloques que se mueven o rebotan en el control de la barra).

wxGauge soporta el cambio dinámico entre estos dos modos de trabajo.

No hay comandos de usuario para el gauge.

Estilos

Esta clase soporta los siguientes estilos:

wxGA_HORIZONTAL
Crea un gage horizontal.
wxGA_VERTICAL
Crea un gauge vertical.
wxGA_SMOOTH
Crea una barra de progreso suave con un paso de actualización de un píxel de ancho (no compatible con todas las plataformas).
wxGA_TEXT
Muestra el valor actual en porcentajes en el propio indicador. Este estilo solo está soportado en wxQt y se ignora en el resto de plataformas. Esta bandera soólo está disponible en wxWidgets 3.1.0 y posteriores.
wxGA_PROGRESS
Refleja el valor de gauge en el botón de la barra de tareas de la aplicación en Windows 7 y posteriores y en el icono del dock en macOS, se ignora en el resto de plataformas. Esta bandera solo está disponible en wxWidgets 3.1.0 y posteriores.

Funciones miembro

wxGauge()

wxGauge::wxGauge()

Constructor por defecto.

wxGauge()

wxGauge::wxGauge( wxWindow * parent, wxWindowID id, int range, const wxPoint & pos = wxDefaultPosition, const wxSize & size = wxDefaultSize, long style = wxGA_HORIZONTAL, const wxValidator & validator = wxDefaultValidator, const wxString & name = wxGaugeNameStr )

Constructor, crea y muestra un gauge.

Parámetros
parent
Ventana padre.
id
Identificador de la ventana.
range
Rango entero (valor máximo) del indicador. Ver SetRange() para más detalles sobre el significado de este valor cuando se utiliza el indicador en modo indeterminado.
pos
Posición de la ventana.
size
Tamaño de la ventana.
style
Estilo del indicador.
validator
Validador de la ventana.
name
Nombre de la ventana.
~wxGauge()

virtual wxGauge::~wxGauge()

Destructor, destruye el gauge.

Create()

bool wxGauge::Create( wxWindow * parent, wxWindowID id, int range, const wxPoint & pos = wxDefaultPosition, const wxSize & size = wxDefaultSize, long style = wxGA_HORIZONTAL, const wxValidator & validator = wxDefaultValidator, const wxString & name = wxGaugeNameStr )

Crea el indicador para la construcción en dos pasos.

Ver wxGauge() para más detalles.

GetRange()

int wxGauge::GetRange() const

Devuelve la posición máxima del gauge.

GetValue()

int wxGauge::GetValue() const

Devuelve la posición actual del gauge.

IsVertical()

bool wxGauge::IsVertical() const

Devuelve true si el indicador es vertical (tiene el estilo wxGA_VERTICAL) y false en caso contrario.

Pulse()

virtual void wxGauge::Pulse()

Cambia el indicador al modo indeterminado (si es necesario) y hace que el indicador se mueva un poco para indicar al usuario que se ha realizado algún progreso.

Nota: Después de llamar a esta función el valor devuelto por GetValue() es indefinido y por lo tanto se necesita llamar explícitamente a SetValue() si se desea restaurar el modo determinado.

SetRange()

void wxGauge::SetRange(int range)

Establece el rango (valor máximo) del gauge.

Esta función hace que el indicador cambie a modo determinado, si no lo está ya.

Cuando el gauge está en modo indeterminado, bajo wxMSW el valor va repetidamente de cero a rango y viceversa; bajo otras versiones cuando está en modo indeterminado, el ajuste de rango se ignora.

SetValue()

void wxGauge::SetValue(int pos)

Establece la posición del gauge.

La posición debe estar entre 0 y el rango del indicador devuelto por GetRange(), ambos inclusive.

Esta función hace que el gauge cambie a modo determinado, si antes estaba en modo indeterminado.

Parámetros
pos
Posición del nivel del indicador.

Métodos y datos heredados

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