Clase wxSearchCtrl
Un control de búsqueda es un control compuesto con un botón de búsqueda, un control de texto y un botón de cancelación.
Jerarquía:
Este control se implementa de forma nativa en macOS y GTK 3.6 o posterior y de forma genérica para el resto de plataformas.
Hay que tenga en cuenta que esta clase proporciona muchos métodos similares a wxTextCtrl, pero no deriva necesariamente de wxTextCtrl en todos los ports (aunque sí en la versión genérica). Sólo se garantiza que los métodos definidos en la clase de interfaz wxTextEntry estén disponibles en todas las plataformas.
Estilos
Esta clase soporta los siguientes estilos:
- wxTE_PROCESS_TAB
- El control recibirá eventos wxEVT_CHAR para TAB pulsado - normalmente, TAB se utiliza para pasar al siguiente control en un diálogo en su lugar. Para el control creado con este estilo, todavía se puede utilizar Ctrl-Enter para pasar al siguiente control desde el teclado.
- wxTE_NOHIDESEL
- Por defecto, el control de texto de Windows no muestra la selección cuando no tiene el foco - utilizar este estilo para forzarlo a mostrarla siempre. No hace nada en otras plataformas.
- wxTE_LEFT
- El texto en el control será justificado a la izquierda (por defecto).
- wxTE_CENTRE
- El texto en el control estará centrado (actualmente sólo wxMSW y wxGTK2).
- wxTE_RIGHT
- El texto del control estará justificado a la derecha (actualmente sólo wxMSW y wxGTK2).
- wxTE_CAPITALIZE:
- En PocketPC y Smartphone, hace que la primera letra aparezca en mayúscula.
Eventos emitidos por esta clase
Las siguientes macros de manejadores de eventos redirigen los eventos a manejadores de funciones miembro 'func' con prototipos como:
void handlerFuncName(wxCommandEvent& event)
Macros de eventos para eventos emitidos por esta clase:
Para reaccionar a los cambios en el contenido del control, utilizar el evento wxEVT_TEXT, igual que se haría con wxTextCtrl. Sin embargo, se recomienda utilizar wxEVT_SEARCH para iniciar la búsqueda y evitar hacerlo demasiado pronto, mientras el usuario todavía está escribiendo (hay que tener en cuenta que wxEVT_SEARCH también se activa al pulsar Intro en el control).
- EVT_SEARCH(id, func)
- Responde a un evento wxEVT_SEARCH, generado cuando se pulsa el botón de búsqueda. Hay que tener en cuenta que esto no inicia una búsqueda por sí mismo, se necesita realizar la acción apropiada en el manejador de eventos. Se puede utilizar event.GetString() para recuperar la cadena a buscar en el código del manejador de eventos.
- EVT_SEARCH_CANCEL(id, func)
- Responde a un evento wxEVT_SEARCH_CANCEL, generado cuando se pulsa el botón de cancelar.
Funciones miembro
wxSearchCtrl()
wxSearchCtrl::wxSearchCtrl()
Constructor por defecto.
wxSearchCtrl()
wxSearchCtrl::wxSearchCtrl( wxWindow * parent, wxWindowID id, const wxString & value = wxEmptyString, const v & pos = wxDefaultPosition, const wxSize & size = wxDefaultSize, long style = 0, const wxValidator & validator = wxDefaultValidator, const wxString & name = wxSearchCtrlNameStr )
Constructor, crea y muestra un control de texto.
Parámetros
- parent
- Ventana padre. No debe ser NULL.
- id
- Identificador del control. Un valor de -1 denota un valor por defecto.
- value
- Valor de texto por defecto.
- pos
- Posición del control de texto.
- size
- Tamaño del control de texto.
- style
- Estilo de la ventana.
- validator
- Validador de la ventana.
- name
- Nombre de la ventana.
~wxSearchCtrl()
virtual wxSearchCtrl::~wxSearchCtrl()
Destructor, destruye el control de búsqueda.
Create()
bool wxSearchCtrl::Create( wxWindow * parent, wxWindowID id, const wxString & value = wxEmptyString, const v & pos = wxDefaultPosition, const wxSize & size = wxDefaultSize, long style = 0, const wxValidator & validator = wxDefaultValidator, const wxString & name = wxSearchCtrlNameStr )
GetDescriptiveText()
wxString wxSearchCtrl::GetDescriptiveText() const
Devuelve el texto mostrado cuando todavía no hay ninguna entrada del usuario.
GetMenu()
virtual wxMenu* wxSearchCtrl::GetMenu()
Devuelve un puntero al objeto menú del control de búsqueda o NULL si no hay ningún menú adjunto.
IsCancelButtonVisible()
virtual bool wxSearchCtrl::IsCancelButtonVisible() const
Devuelve el estado de visibilidad del botón de cancelación.
IsSearchButtonVisible()
virtual bool wxSearchCtrl::IsSearchButtonVisible() const
Devuelve el valor de visibilidad del botón de búsqueda.
Si hay un menú adjunto, el botón de búsqueda será visible independientemente del valor de visibilidad del botón de búsqueda.
SetDescriptiveText()
void wxSearchCtrl::SetDescriptiveText(const wxString & text)
Establece el texto que se mostrará en el control de búsqueda cuando el usuario aún no haya escrito nada en él.
SetMenu()
virtual void wxSearchCtrl::SetMenu(wxMenu * menu)
Establece el objeto menú del control de búsqueda.
Si ya existe un menú asociado al control de búsqueda, se eliminará.
Parámetros
- menu
- Menú a asociar al control de búsqueda.
ShowCancelButton()
virtual void wxSearchCtrl::ShowCancelButton(bool show)
Muestra u oculta el botón de cancelar.
Hay que tener en cuenta que esta función no hace nada en la versión GTK nativa del control: El botón "Cancelar" siempre se muestra automáticamente si el control no está vacío y se oculta si está vacío.
ShowSearchButton()
virtual void wxSearchCtrl::ShowSearchButton(bool show)
Establece el valor de visibilidad del botón de búsqueda en el control de búsqueda.
Si hay un menú adjunto, el botón de búsqueda será visible independientemente del valor de visibilidad del botón de búsqueda.
Hay que tener en cuenta que esta función no hace nada en la versión GTK nativa del control: El botón "Buscar" siempre se muestra allí.
Métodos y datos heredados
Esta clase hereda los métodos y datos miembro públicos y protegidos de wxObject, wxEvtHandler, wxWindow, wxControl y wxTextEntry.