caret.h

Clase wxCaret

Un caret es un cursor parpadeante que muestra la posición en la que aparecerá el texto escrito.

Los controles de texto suelen tener su propio caret, pero wxCaret proporciona una forma de utilizar un caret en otras ventanas.

Actualmente, el caret aparece como un rectángulo del tamaño dado. En el futuro, será posible especificar un mapa de bits que se utilizará para la forma del signo de intercalación.

Un signo de intercalación siempre está asociado a una ventana y el signo de intercalación actual puede recuperarse utilizando wxWindow::GetCaret(). El mismo signo de intercalación no puede reutilizarse en dos ventanas diferentes.

Funciones miembro

wxCaret()

wxCaret::wxCaret()

Constructor por defecto.

wxCaret()

wxCaret::wxCaret( wxWindow * window, int width, int height )

Crea un signo de intercalación con el tamaño dado (en píxeles) y lo asocia a la ventana.

wxCaret()

wxCaret::wxCaret( wxWindow * window, const wxSize & size )

Crea un signo de intercalación con el tamaño dado (en píxeles) y lo asocia a la ventana.

Create()

bool wxCaret::Create( wxWindow * window, const wxSize & size )

Crea un caret con el tamaño dado (en píxeles) y lo asocia a la ventana (igual que los constructores equivalentes)

Create()

bool wxCaret::Create( wxWindow * window, int width, int height )

Crea un caret con el tamaño dado (en píxeles) y lo asocia a la ventana (igual que los constructores equivalentes)

GetBlinkTime()

static int wxCaret::GetBlinkTime()

Devuelve el tiempo de parpadeo que se mide en milisegundos y es el tiempo transcurrido entre 2 inversiones del signo de intercalación (el tiempo de parpadeo del signo de intercalación es el mismo para todos los signos de intercalación, por lo que esta función es estática).

GetPosition()

wxPoint wxCaret::GetPosition() const

Obtiene la posición del cursor (en píxeles).

Nota: En wxPerl hay dos métodos en lugar de un único método sobrecargado:

  • GetPosition(): devuelve un objeto Wx::Point.
  • GetPositionXY(): devuelve una lista de 2 elementos (x, y).
GetPosition()

void wxCaret::GetPosition( int * x, int * y ) const

Obtiene la posición del cursor (en píxeles).

Nota: En wxPerl hay dos métodos en lugar de un único método sobrecargado:

  • GetPosition(): devuelve un objeto Wx::Point.
  • GetPositionXY(): devuelve una lista de 2 elementos (x, y).
GetSize()

wxSize wxCaret::GetSize() const

Obtiene el tamaño del caret.

Nota: En wxPerl hay dos métodos en lugar de un único método sobrecargado:

  • GetSize(): devuelve un objeto Wx::Size.
  • GetSizeWH(): devuelve una lista de 2 elementos (anchura, altura).
GetSize()

void wxCaret::GetSize( int * width, int * height ) const

Obtiene el tamaño del caret.

Nota: En wxPerl hay dos métodos en lugar de un único método sobrecargado:

  • GetSize(): devuelve un objeto Wx::Size.
  • GetSizeWH(): devuelve una lista de 2 elementos (anchura, altura).
GetWindow()

wxWindow* wxCaret::GetWindow() const

Obtiene la ventana a la que está asociado el signo de intercalación.

Hide()

virtual void wxCaret::Hide()

Oculta el cursor, igual que Show(false).

IsOk()

bool wxCaret::IsOk() const

Devuelve true si la carita se ha creado correctamente.

IsVisible()

bool wxCaret::IsVisible() const

Devuelve true si el signo de intercalación está visible y false si está permanentemente oculto (si está parpadeando y no se muestra actualmente pero se mostrará después del próximo parpadeo, este método devuelve true).

Move()

void wxCaret::Move(const wxPoint & pt)

Mueve el cursor a la posición dada (en coordenadas lógicas).

Move()

void wxCaret::Move( int x, int y )

Mueve el cursor a la posición dada (en coordenadas lógicas).

SetBlinkTime()

static void wxCaret::SetBlinkTime(int milliseconds)

Establece el tiempo de parpadeo de todas los carets.

Aviso

En Windows, esta función cambiará el tiempo de parpadeo de todos los carets permanentemente (hasta la próxima vez que se llame), incluso para los carets de otras aplicaciones.

SetSize()

void wxCaret::SetSize(const wxSize & size)

Cambia el tamaño del signo de intercalación.

SetSize()

void wxCaret::SetSize( int width, int height )

Cambia el tamaño del signo de intercalación.

Show()

virtual void wxCaret::Show(bool show = true)

Muestra u oculta el cursor.

Hay que tener en cuenta que si el signo de intercalación se ocultó N veces, debe mostrarse también N veces para reaparecer en la pantalla.