Clase wxTreeCtrl

Constructor por defecto.

Constructor, crea y muestra un control de árbol.

Parámetros

parent

Ventana padre. No debe ser nullptr.

id

Identificador de la ventana. El valor wxID_ANY indica un valor por defecto.

pos

Posición de la ventana. Si se especifica wxDefaultPosition se elige una posición por defecto.

size

Tamaño de la ventana. Si se especifica wxDefaultSize, el tamaño de la ventana es el adecuado.

style

Estilo de la ventana.

validator

Validador de la ventana.

name

Nombre de la ventana.

Destructor, que destruye el control del árbol.

Añade el nodo raíz al árbol, devolviendo el nuevo elemento.

Los parámetros image y selImage son un índice dentro de la lista de imágenes normales que especifica la imagen a utilizar para los elementos seleccionados y no seleccionados, respectivamente. Si image > -1 y selImage es -1, se utiliza la misma imagen para los elementos seleccionados y no seleccionados.

Añade un elemento al final de la rama identificada por parent, devolviendo un nuevo id de elemento.

Los parámetros image y selImage son un índice dentro de la lista de imágenes normales que especifica la imagen a utilizar para los elementos seleccionados y no seleccionados, respectivamente. Si image > -1 y selImage es -1, se utiliza la misma imagen para los elementos seleccionados y no seleccionados.

Establece la lista de imágenes de botones.

Las imágenes de botones asignadas con este método serán borradas automáticamente por wxTreeCtrl según corresponda (es decir, toma posesión de la lista).

Establecer o asignar la lista de imágenes de botones habilita la visualización de botones de imagen. Una vez activada, la única forma de desactivar la visualización de imágenes de botones es establecer la lista de imágenes de botones en nullptr.

Esta función sólo está disponible en la versión genérica.

Establece el estado de la lista de imágenes.

La lista de imágenes asignada con este método será eliminada automáticamente por wxTreeCtrl según corresponda (es decir, toma posesión de la lista).

Nota: Es preferible utilizar SetStateImages() en el nuevo código.

Borra el elemento actualmente enfocado.

Colapsa el elemento dado.

Colapsa el elemento raíz.

Colapsa este elemento y todos sus hijos, recursivamente.

Colapsa el elemento dado y elimina todos los hijos.

Crea el control de árbol.

Ver el constructor para más detalles.

Elimina el elemento especificado.

Se generará un evento EVT_TREE_DELETE_ITEM.

Esta función puede hacer que falle una llamada posterior a GetNextChild().

Elimina todos los elementos del control.

Esta función genera eventos wxEVT_TREE_DELETE_ITEM para cada elemento que se elimina, incluido el raíz si se muestra, es decir, a menos que se utilice el estilo wxTR_HIDE_ROOT.

Elimina todos los hijos del elemento dado (pero no el propio elemento).

Se generará un evento wxEVT_TREE_DELETE_ITEM por cada elemento que se elimine.

Si ha llamado a SetItemHasChildren(), puede que se necesite llamarla de nuevo ya que DeleteChildren() no borra automáticamente la configuración.

Inicia la edición de la etiqueta del elemento dado.

Esta función genera un evento EVT_TREE_BEGIN_LABEL_EDIT que puede ser vetado para evitar que se inicie la edición.

Si se inicia, se muestra un control de texto, que puede recuperarse utilizando GetEditControl(), que permite al usuario editar la etiqueta de forma interactiva. En wxMSW, este control de texto se crea utilizando textCtrlClass, sin embargo este parámetro se ignora actualmente en los otros ports donde siempre se utiliza un wxTextCtrl plano.

Cuando la edición finaliza, se envía el evento EVT_TREE_END_LABEL_EDIT y este evento puede ser vetado también para evitar que la etiqueta cambie. Hay que tener en cuenta que este evento se envía tanto cuando el usuario acepta (por ejemplo, pulsando Enter) o cancela (por ejemplo, pulsando Escape) y su manejador puede utilizar wxTreeEvent::IsEditCancelled() para distinguir entre estas situaciones.

Habilita o deshabilita un pitido si no hay coincidencia para el texto introducido actualmente al buscar el elemento desde el teclado.

El valor predeterminado es no emitir un pitido en este caso, excepto en wxMSW, donde el pitido siempre es generado por el control nativo y no se puede desactivar, es decir, las llamadas a esta función no hacen nada allí.

Finaliza la edición de la etiqueta.

Si cancelEdit es true, se cancelará la edición.

Nota: Esta función sólo es compatible actualmente con Windows.

Desplaza y/o expande los elementos para asegurarse de que el elemento dado es visible.

Este método puede utilizarse, y funcionará, incluso mientras la ventana esté congelada (ver wxWindow::Freeze()).

Expande el elemento dado.

Expande todos los elementos del árbol.

Expande el elemento dado y todos sus hijos recursivamente.

Obtiene el rectángulo que delimita el elemento.

Si textOnly es true, sólo se devolverá el rectángulo alrededor de la etiqueta del elemento, de lo contrario también se tendrá en cuenta la imagen del elemento.

El valor devuelto es true si el rectángulo se ha recuperado correctamente o false si no (en este caso rect no se modifica) - por ejemplo, si el elemento es actualmente invisible.

Hay que tener en cuenta que las coordenadas del rectángulo son lógicas, no físicas. Así, por ejemplo, la coordenada x puede ser negativa si el árbol tiene una barra de desplazamiento horizontal y su posición no es 0.

Nota wxPerl: En wxPerl este método sólo toma los parámetros item y textOnly y devuelve un Wx::Rect (o undef).

Devuelve la lista de imágenes de los botones (de la que se toman las imágenes de los botones definidos por la aplicación).

Esta función sólo está disponible en la versión genérica.

Devuelve el número de elementos de la rama.

Si recursively es verdadero, devuelve el número total de descendientes, de lo contrario sólo se cuenta un nivel de hijos.

Devuelve el número de elementos del control.

Devuelve el control de edición que se está utilizando para editar una etiqueta.

Devuelve nullptr si no se está editando ninguna etiqueta.

Nota: Actualmente sólo está implementado para wxMSW.

Devuelve el primer hijo; llamar a GetNextChild() para obtener el siguiente hijo.

Para esta función de enumeración debe pasar un parámetro cookie que es opaco para la aplicación pero necesario para que la biblioteca haga estas funciones reentrantes (es decir, permitir más de una enumeración en un mismo objeto simultáneamente). La cookie pasada a GetFirstChild() y GetNextChild() debe ser la misma variable.

Devuelve un elemento de árbol inválido (es decir, wxTreeItemId::IsOk() devuelve false) si no hay más hijos.

Nota wxPerl: En wxPerl este método sólo toma el parámetro item, y devuelve una lista de 2 elementos (item, cookie).

Devuelve el primer elemento visible.

Devuelve el último elemento pulsado o seleccionado.

A diferencia de GetSelection(), puede utilizarse tanto si el control tiene el estilo wxTR_MULTIPLE como si no.

Devuelve la sangría actual del control de árbol en píxeles independientes de DPI.

Devuelve el color de fondo del elemento.

Devuelve los datos del elemento del árbol asociados al elemento.

Nota wxPerl: wxPerl proporciona el siguiente método abreviado:

GetPlData(item): devuelve los datos Perl asociados con el Wx::TreeItemData. Es lo mismo que tree->GetItemData(item)->GetData().

Devuelve la fuente de la etiqueta del elemento.

Si la fuente no se ha establecido explícitamente para el elemento especificado con SetItemFont(), devuelve una fuente wxNullFont no válida. GetFont() puede utilizarse para recuperar la fuente global de control del árbol utilizada para los elementos sin ninguna fuente específica.

Obtiene la imagen del elemento especificado.

Su valor puede ser:

• wxTreeItemIcon_Normal: para obtener la imagen normal del ítem.
• wxTreeItemIcon_Selected: para obtener la imagen del ítem seleccionado (es decir, la imagen que se muestra cuando el ítem está actualmente seleccionado).
• wxTreeItemIcon_Expanded: para obtener la imagen expandida (esto sólo tiene sentido para ítems que tienen hijos - entonces esta imagen se muestra cuando el ítem está expandido y la imagen normal se muestra cuando está colapsado).
• wxTreeItemIcon_SelectedExpanded: para obtener la imagen expandida seleccionada (que se muestra cuando se selecciona un ítem expandido).

Devuelve el elemento padre.

Obtiene el estado del elemento especificado.

Devuelve la etiqueta del elemento.

Devuelve el color de la etiqueta del artículo.

Devuelve el último hijo del elemento (o un elemento de árbol no válido si este elemento no tiene hijos).

Devuelve el siguiente hijo; llamar a GetFirstChild() para el primer hijo.

Para esta función de enumeración se debe pasar un parámetro cookie que es opaco para la aplicación pero necesario para que la biblioteca haga estas funciones reentrantes (es decir, permitir más de una enumeración en un mismo objeto simultáneamente). La cookie pasada a GetFirstChild() y GetNextChild() debe ser la misma.

Devuelve un elemento de árbol inválido si no hay más hijos.

Nota wxPerl: En wxPerl este método devuelve una lista de 2 elementos (item, cookie) en lugar de modificar sus parámetros.

Devuelve el siguiente hermano del elemento especificado; llamar a GetPrevSibling() para obtener el hermano anterior.

Devuelve un elemento de árbol no válido si no hay más hermanos.

Devuelve el siguiente elemento visible o un elemento no válido si este elemento es el último visible.

Nota: El propio elemento debe ser visible.

Devuelve el hermano anterior del elemento especificado; llamar a GetNextSibling() para obtener el siguiente hermano.

Devuelve un elemento de árbol no válido si no hay más hijos.

Devuelve el elemento visible anterior o un elemento inválido si este elemento es el primero visible.

Nota: El propio elemento debe ser visible.

Devuelve true si el control utilizará un cálculo rápido para el mejor tamaño, teniendo en cuenta sólo el primer y el último elemento.

Por defecto es false.

Devuelve el elemento raíz del control de árbol.

Devuelve la selección, o un ítem inválido si no hay selección.

Esta función sólo funciona con los controles sin estilo wxTR_MULTIPLE, utilizar GetSelections() para los controles que sí tienen este estilo o, si se desea un único elemento, utilizar GetFocusedItem().

Rellena el array de elementos del árbol pasado con los elementos actualmente seleccionados.

Esta función sólo puede invocarse si el control tiene el estilo wxTR_MULTIPLE.

Devuelve el número de elementos seleccionados.

Nota wxPerl: En wxPerl este método no toma parámetros y devuelve una lista de Wx::TreeItemId.

Devuelve el espaciado actual del control de árbol.

Es el número de DIP horizontales (píxeles independientes de DPI) entre los botones y las imágenes de estado.

Devuelve el número de imágenes de estado utilizadas por el control.

Devuelve el número de imágenes pasadas a la última llamada a SetStateImages() o 0 si nunca se había llamado.

Devuelve la lista de imágenes de estado (de la que se toman las imágenes de estado definidas por la aplicación).

Devuelve true si el control utiliza alguna imagen de estado.

Esto es equivalente a comparar el valor de retorno de GetStateImageCount() con 0, pero más claro.

Calcula qué elemento (si lo hay) se encuentra bajo el punto dado, devolviendo el id del elemento del árbol en este punto más la información extra flags.

flags es una lista de bits de lo siguiente:

• wxTREE_HITTEST_ABOVE: Por encima del área del cliente.
• wxTREE_HITTEST_BELOW: Debajo del área de cliente.
• wxTREE_HITTEST_NOWHERE: En el área de cliente pero por debajo del último elemento.
• wxTREE_HITTEST_ONITEMBUTTON: En el botón asociado a un ítem.
• wxTREE_HITTEST_ONITEMICON: En el bitmap asociado a un ítem.
• wxTREE_HITTEST_ONITEMINDENT: En la sangría asociada a un ítem.
• wxTREE_HITTEST_ONITEMLABEL: En la etiqueta (string) asociada a un ítem.
• wxTREE_HITTEST_ONITEMRIGHT: En el área a la derecha de un ítem.
• wxTREE_HITTEST_ONITEMSTATEICON: En el icono de estado de un ítem de la vista de árbol que se encuentra en un estado definido por el usuario.
• wxTREE_HITTEST_TOLEFT: A la derecha del área de cliente.
• wxTREE_HITTEST_TORIGHT: A la izquierda del área de cliente.

Nota wxPerl: En wxPerl este método sólo toma el parámetro point y devuelve una lista de 2 elementos (item, flags).

Inserta un elemento después de uno dado (anterior).

Los parámetros image y selImage son un índice dentro de la lista de imágenes normales que especifica la imagen a utilizar para los elementos seleccionados y no seleccionados, respectivamente. Si image > -1 y selImage es -1, se utiliza la misma imagen para los elementos seleccionados y no seleccionados.

Inserta un elemento antes de otro identificado por su posición (pos).

pos debe ser menor o igual que el número de hijos.

Los parámetros image y selImage son un índice dentro de la lista de imágenes normales que especifica la imagen a utilizar para los elementos seleccionados y no seleccionados, respectivamente. Si image > -1 y selImage es -1, se utiliza la misma imagen para los elementos seleccionados y no seleccionados.

Devuelve true si el elemento dado está en negrita.

Devuelve true si el control está vacío (es decir, no tiene elementos, ni siquiera el raíz).

Devuelve true si el elemento está expandido (sólo tiene sentido si tiene hijos).

Devuelve true si el elemento está seleccionado.

Devuelve true si el elemento está visible en la pantalla.

Devuelve true si el elemento tiene hijos.

Anular esta función en la clase derivada para cambiar el orden de los elementos en el control de árbol.

La función debe devolver un valor negativo, cero o positivo si el primer elemento es menor, igual o mayor que el segundo.

Hay que tener en cuenta que se deben utilizar las macros wxDECLARE_DYNAMIC_CLASS() y wxIMPLEMENT_DYNAMIC_CLASS() si se sobrescribe esta función porque, de lo contrario, la clase base considera que no está sobrescrita y utiliza la comparación por defecto, es decir, ordena los elementos alfabéticamente, lo que le permite optimizar completamente las llamadas a la función virtual.

Añade un elemento como primer hijo de parent, devolviendo un nuevo id de elemento.

Los parámetros image y selImage son un índice dentro de la lista de imágenes normales que especifica la imagen a utilizar para los elementos seleccionados y no seleccionados, respectivamente. Si image > -1 y selImage es -1, se utiliza la misma imagen para los elementos seleccionados y no seleccionados.

Desplaza el elemento especificado a la vista.

Hay que tener en cuenta que este método no funciona mientras la ventana está congelada (véase wxWindow::Freeze()), al menos en MSW.

Selecciona todos los hijos inmediatos del padre dado.

Esta función sólo puede utilizarse con controles multiselección.

Selecciona el elemento dado.

En controles de selección múltiple, también se puede utilizar para deseleccionar un elemento actualmente seleccionado si el valor de select es false.

Hay que tener en cuenta que llamar a este método generará eventos wxEVT_TREE_SEL_CHANGING y wxEVT_TREE_SEL_CHANGED y que el cambio podría ser vetado por el controlador de eventos anterior.

Establece la lista de imágenes de los botones (de la que se toman las imágenes de los botones definidos por la aplicación).

Las imágenes de botones asignadas con este método no serán borradas por el destructor de wxTreeCtrl, deberán borrarse explícitamente. Configurar o asignar la lista de imágenes de botones habilita la visualización de botones de imagen. Una vez activada, la única forma de desactivar la visualización de imágenes de botones es establecer la lista de imágenes de botones a nullptr.

Nota: Esta función sólo está disponible en la versión genérica.

Establece el elemento actualmente enfocado.

Parámetros

item

El elemento a convertir en el actual. Debe ser válido.

Establece la sangría para el control de árbol, en DIP (píxeles independientes de DPI).

Establece el color del fondo del elemento.

Hace que el elemento aparezca en negrita si el parámetro bold es verdadero o lo restablece al estado normal.

Establece los datos de cliente del elemento.

Hay que tener en cuenta que los datos del cliente previamente asociados con el elemento (si los hay) no son liberados por esta función y por lo tanto llamar a esta función varias veces para el mismo elemento dará lugar a fugas de memoria a menos que se elimine el puntero de datos del elemento antiguo.

Nota de wxPerl: wxPerl proporciona el siguiente método abreviado:

SetPlData(item, data): establece los datos Perl asociados con el Wx::TreeItemData. Es lo mismo que tree->GetItemData(item)->SetData(data).

Proporciona al elemento la información visual para las acciones de arrastrar y soltar, lo que resulta útil si se arrastra algo desde el exterior al control de árbol (a diferencia de una operación DnD dentro del control de árbol, que ya está implementada internamente).

Establece la fuente del elemento.

Todos los elementos del árbol deben tener la misma altura para evitar el recorte de texto, por lo que la altura de las fuentes debe ser la misma para todos ellos, aunque los atributos de fuente pueden variar.

Fuerza la aparición del botón junto al elemento.

Esto es útil para permitir al usuario expandir los elementos que no tienen hijos ahora, pero en su lugar añadirlos sólo cuando sea necesario, minimizando así el uso de memoria y el tiempo de carga.

Establece la imagen del elemento especificado.

Ver GetItemImage() para la descripción del parámetro which.

Establece el estado del elemento especificado.

El valor de state puede ser un índice en la lista de imágenes de estado, o uno de los valores especiales:

• wxTREE_ITEMSTATE_NONE: para desactivar el estado del ítem (no se mostrará la imagen de estado).
• wxTREE_ITEMSTATE_NEXT: para establecer el siguiente estado del ítem.
• wxTREE_ITEMSTATE_PREV: para establecer el estado anterior del ítem.

Establece la etiqueta del elemento.

Establece el color del texto del elemento.

Si se pasa true, especifica que el control utilizará un cálculo rápido para el mejor tamaño, mirando sólo el primer y último elemento.

En caso contrario, tendrá en cuenta todos los elementos. El valor por defecto es false.

Establece el espaciado para el control de árbol.

El espaciado es el número de DIPs horizontales (píxeles independientes de DPI) entre los botones y las imágenes de estado. Esto no tiene efecto bajo wxMSW.

Establece la lista de imágenes de estado (de la que se toman las imágenes de estado definidas por la aplicación).

La lista de imágenes asignada con este método no será borrada por el destructor de wxTreeCtrl, debe borrarda explícitamente.

Nota: Es preferible utilizar SetStateImages() en el nuevo código.

Establece las imágenes a utilizar para los estados de los elementos definidos por la aplicación.

Esta función toma un vector de objetos wxBitmapBundle que pueden especificar múltiples versiones del mismo icono para diferentes resoluciones de pantalla para cada estado. Si el vector está vacío, no se muestra ninguna imagen de estado.

Establece los indicadores de modo asociados a la visualización del control de árbol.

El nuevo modo tiene efecto inmediato.

Nota: Sólo genérico; MSW ignora los cambios.

Ordena los hijos del elemento dado utilizando OnCompareItems().

Se debe anular ese método para cambiar el orden de clasificación (el valor predeterminado es el orden alfabético ascendente sensible a mayúsculas/minúsculas).

Alterna el elemento dado entre los estados contraído y expandido.

Alterna el elemento dado entre los estados seleccionado y no seleccionado.

Sólo para controles multiselección.

Elimina la selección del elemento actualmente seleccionado (si existe).

Esta función se comporta igual que Unselect() si el control no tiene el estilo wxTR_MULTIPLE, o elimina la selección de todos los elementos si tiene este estilo.

Deselecciona el elemento dado.

Sólo funciona en controles multiselección.