Clase wxAccessible
La clase wxAccessible permite a las aplicaciones wxWidgets, y al propio wxWidgets, devolver información extendida sobre elementos de la interfaz de usuario a aplicaciones cliente como lectores de pantalla.
Jerarquía:
Esta es la principal forma en que wxWidgets implementa las características de accesibilidad.
En la actualidad, esta clase solo es compatible con Microsoft Active Accessibility.
Para utilizar esta clase, derivar de wxAccessible, implementar las funciones apropiadas y asociar un objeto de la clase con una ventana utilizando wxWindow::SetAccessible.
Todas las funciones devuelven una indicación de éxito, fallo o no implementado utilizando valores del tipo enum wxAccStatus.
Si se devuelve wxACC_NOT_IMPLEMENTED desde cualquier función, el sistema intentará implementar la funcionalidad apropiada. Sin embargo, esto no funcionará con todas las funciones.
La mayoría de las funciones trabajan con un id de objeto, que puede ser cero para referirse a "este" elemento UI, o mayor que cero para referirse al enésimo elemento hijo. Esto permite especificar elementos que no tienen un wxWindow o wxAccessible correspondiente; por ejemplo, la hoja de una ventana de división.
Para más detalles sobre la semántica de las funciones y tipos, consultar la documentación de Microsoft Active Accessibility 1.2.
Esta clase se compila en wxWidgets solo si el símbolo de configuración wxUSE_ACCESSIBILITY se establece en 1.
Funciones miembro
wxAccessible()
wxAccessible::wxAccessible(wxWindow * win = NULL)
Constructor, que toma una ventana opcional.
El objeto puede asociarse a una ventana posteriormente.
~wxAccessible()
wxAccessible::~wxAccessible()
Destructor.
DoDefaultAction()
virtual wxAccStatus wxAccessible::DoDefaultAction(int childId)
Realiza la acción por defecto para el objeto.
childId es 0 (la acción para este objeto) o mayor que 0 (la acción para un hijo).
Valor de retorno
wxACC_NOT_SUPPORTED si no existe una acción por defecto para esta ventana (por ejemplo, un control de edición).
GetChild()
virtual wxAccStatus wxAccessible::GetChild( int childId, wxAccessible ** child )
Obtiene el hijo especificado (empezando por 1).
Si child es NULL y el valor de retorno es wxACC_OK, significa que el child es un elemento simple y no un objeto accesible.
GetChildCount()
virtual wxAccStatus wxAccessible::GetChildCount(int * childCount)
Devuelve el número de hijos en childCount.
GetDefaultAction()
virtual wxAccStatus wxAccessible::GetDefaultAction( int childId, wxString * actionName )
Obtiene la acción por defecto para este objeto (0) o un hijo (mayor que 0).
Devuelve wxACC_OK incluso si no hay acción. actionName es la acción, o la cadena vacía si no hay acción. La cadena recuperada describe la acción que se realiza sobre un objeto, no lo que el objeto hace como resultado. Por ejemplo, un botón de la barra de herramientas que imprime un documento tiene una acción por defecto de "Pulsar" en lugar de "Imprime el documento actual".
GetDescription()
virtual wxAccStatus wxAccessible::GetDescription( int childId, wxString * description )
Devuelve la descripción de este objeto o de un hijo.
GetFocus()
virtual wxAccStatus wxAccessible::GetFocus( int * childId, wxAccessible ** child )
Obtiene la ventana con el foco del teclado.
Si childId es 0 y child es NULL, ningún objeto de esta subjerarquía tiene el foco. Si este objeto tiene el foco, child debe ser 'este'.
GetHelpText()
virtual wxAccStatus wxAccessible::GetHelpText( int childId, wxString * helpText )
Devuelve texto de ayuda para este objeto o un hijo, similar al texto de información sobre herramientas.
GetKeyboardShortcut()
virtual wxAccStatus wxAccessible::GetKeyboardShortcut( int childId, wxString * shortcut )
Devuelve el atajo de teclado para este objeto o hijo.
Devuelve, por ejemplo, ALT+K.
GetLocation()
virtual wxAccStatus wxAccessible::GetLocation( wxRect & rect, int elementId )
Devuelve el rectángulo de este objeto (id es 0) o de un elemento hijo (id es mayor que 0).
rect está en coordenadas de pantalla.
GetName()
virtual wxAccStatus wxAccessible::GetName( int childId, wxString * name )
Obtiene el nombre del objeto especificado.
GetParent()
virtual wxAccStatus wxAccessible::GetParent(wxAccessible ** parent)
Devuelve el padre de este objeto, o NULL.
GetRole()
virtual wxAccStatus wxAccessible::GetRole( int childId, wxAccRole * role )
Devuelve una constante de rol que describe este objeto.
Ver wxAccRole para una lista de estos roles.
GetSelections()
virtual wxAccStatus wxAccessible::GetSelections(wxVariant * selections)
Obtiene una variante que representa los hijos seleccionados de este objeto.
Los valores aceptables son:
- Una variante nula (IsNull() devuelve true) si no hay hijos seleccionados.
- Un puntero void* a un wxAccessible del objeto hijo seleccionado.
- Un número entero que representa el elemento hijo seleccionado, o 0 si este objeto está seleccionado (GetType() == "long").
- Una variante de lista (GetType() == "list") si se seleccionan varios objetos hijo
GetState()
virtual wxAccStatus wxAccessible::GetState( int childId, long * state )
Devuelve una constante de estado.
Ver wxAccStatus para una lista de estos estados.
GetValue()
virtual wxAccStatus wxAccessible::GetValue( int childId, wxString * strValue )
Devuelve una cadena localizada que representa el valor del objeto o hijo.
GetWindow()
wxWindow* wxAccessible::GetWindow()
Devuelve la ventana asociada a este objeto.
HitTest()
virtual wxAccStatus wxAccessible::HitTest( const wxPoint & pt, int * childId, wxAccessible ** childObject )
Devuelve un valor de estado y un id de objeto para indicar si el punto dado estaba en éste o en un objeto hijo.
Puede devolver un objeto hijo o un número entero que representa el elemento hijo, empezando por 1.
pt está en coordenadas de pantalla.
Navigate()
virtual wxAccStatus wxAccessible::Navigate( wxNavDir navDir, int fromId, int * toId, wxAccessible ** toObject )
Navega de fromId a toId o a toObject.
NotifyEvent()
static void wxAccessible::NotifyEvent( int eventType, wxWindow * window, wxAccObject objectType, int objectId )
Permite a la aplicación enviar un evento cuando algo cambia en un objeto accesible.
Select()
virtual wxAccStatus wxAccessible::Select( int childId, wxAccSelectionFlags selectFlags )
Selecciona el objeto o hijo.
Consultar wxAccSelectionFlags para obtener una lista de las acciones de selección.
SetWindow()
void wxAccessible::SetWindow(wxWindow * window)
Establece la ventana asociada a este objeto.
Métodos y datos heredados
Esta clase hereda los métodos y datos miembro públicos y protegidos de wxObject.