VTreeItem

Heredado por: VTreeItemRegister

Esta clase es usada para gestionar cada una de los ítems que forman un control de la clase VTreeWidget.

Cada ítem puede contener una o varias columnas de datos en la que podemos incluir textos, etiquetas y un icono.

Los ítems se construyen con un padre que se corresponde con un ítem de primer nivel en el objeto de la clase VTreeWidget u otro ítem de la clase VTreeWidgetItem de nivel superior.

Cada columna en un ítem puede tener su propio color de fondo fijado con la función setBackgroundColor() y su color de texto fijado con la función setForegroundColor().

La principal diferencia entre los ítems de nivel principal y el resto de ítems inferiores del árbol es que los ítems de nivel superior o principal no tiene ítem padre, esta información puede ser útil a la hora de insertar o borrar ítems del árbol. Los ítem hijos pueden ser eliminados con la función deleteChild() o añadidos con la función addChild().

Cada ítem, por defecto es seleccionable, activable, etc. Esta configuración en el ítem se realiza a través de flags que pueden ser alterados con la función setFlags() aplicando los valores que se encuentran en el enum ItemFlag de esta clase.

Esta clase se ha incorporado al API en la versión 7.16.

Funciones

Generales

Retorno	Función
Number	columnCount()
Number	flags()
Boolean	isExpanded()
Boolean	isHidden()
Boolean	isRegisterType()
Boolean	isSelected()
VTreeItem	parentItem()
void	setExpanded( Boolean expanded )
void	setFlags( Number flags )
void	setHidden( Boolean hidden )
void	setSelected( Boolean select )

De columna

Retorno	Función
Number	backgroundColor( Number column )
Number	checkState( Number column )
VFont	font( Number column )
Number	foregroundColor( Number column )
void	setBackgroundColor( Number column, Number r, Number g, Number b, Number a = 255 )
void	setCheckState( Number column, Number state )
void	setFont( Number column, VFont font )
void	setForegroundColor( Number column, Number r, Number g, Number b, Number a = 255 )
void	setIcon( Number column, VImage image )
void	setStatusTip( Number column, String text )
void	setText( Number column, String text )
void	setTextAlignment( Number column, Number alignFlags )
void	setToolTip( Number column, String text )
void	setWhatsThis( Number column, String text )
String	statusTip( Number column )
String	text( Number column )
Number	textAlignment()
String	toolTip( Number column )
String	whatsThis( Number column )

Child items

Retorno	Función
VTreeItem	addChild()
VTreeItemRegister	addChildRegister( VRegister reg, VItemRegisterPatern patern )
Number	addChildRegisterList( VRegisterList regList, VItemRegisterPatern patern )
VTreeItem	child( Number index )
Number	childCount()
void	deleteChild( Number index )

Enumeraciones

Flags de alineamiento

• AlignLeft = 0x0001

• AlignRight = 0x0002

• AlignHCenter = 0x0004

• AlignJustify = 0x0008

• AlignAbsolute = 0x0010

• AlignTop = 0x0020

• AlignBottom = 0x0040

• AlignVCenter = 0x0080

• AlignCenter = AlignVCenter | AlignHCenter

ItemFlag

• 0 = No tiene fijada ninguna propiedad

• 1 = Puede ser seleccionado

• 2 = Puede ser editado

• 16 = Puede ser marcado o desmarcado por el usuario

• 32 = El usuario puede interactuar con el ítem

• 64 = El ítem se puede marcar con 3 estados independientes

Documentación de funciones

Funciones generales

Number columnCount()

Devuelve el nº de columnas declaradas en el ítem.

Number flags()

Devuelve el valor de los flags configurados para el ítem. Ver enum ItemFlag para conocer todos los valores configurables.

Boolean isExpanded()

Devuelve true si el ítem está expandido y false si está contraído.

Boolean isHidden()

Devuelve true el ítem está oculto y false si está visible.

Boolean isRegisterType()

Devuelve true si es un ítem de la clase VTreeItemRegister y false si es ítem de la clase VTreeItem.

Esta clase se ha incorporado al API en la versión 7.17.

Boolean isSelected()

Devuelve true si el ítem está seleccionado y false en caso contrario.

VTreeItem parentItem()

Devuelve el ítem padre del ítem en curso o nulo si es un top level ítem.

Esta clase se ha incorporado al API en la versión 7.17.

void setExpanded( Boolean expanded )

Se fija si el ítem se expandir (true) o se debe contraer (false).

Parámetros:

• expanded: True para expandirlo o false para contraerlo.

void setFlags( Number flags )

Permite configurar diferentes valores del ítem como si es seleccionable, editable, arrastrable, etc. Ver enum ItemFlag para conocer todos los valores configurables.

Parámetros:

• flags: Valor numérico que combina los valores del enum ItemFlag.

void setHidden( Boolean hidden )

Se fija si el ítem debe ocultarse (true) o visualizarse (false).

Parámetros:

• hidden: True para ocultar o false para visualizarlo.

void setSelected( Boolean select )

Se fija si el ítem se mostrará seleccionado (true) o no seleccionado (false).

Parámetros:

• select: True para seleccionarlo o false para desseleccionarlo.

Funciones de columna

Number backgroundColor( Number column )

Devuelve el valor numérico que se corresponde con la representación decimal del valor hexadecimal de un color en formato RGBA.

Parámetros:

• column: Nº de columna del ítem.

Number checkState( Number column )

Devuelve el check de estado de la columna especificada en el parámetro del ítem en curso.

Parámetros:

• column: Número de la columna.

VFont font( Number column )

Obtiene un objeto de la clase VFont con las características de la funete de la columna especificada en el parámetro.

Parámetros:

• column: Número de columna.

Esta clase se ha incorporado al API en la versión 7.17.

Number foregroundColor( Number column )

Devuelve el valor numérico que se corresponde con la representación decimal del valor hexadecimal de un color en formato RGBA.

Parámetros:

• column: Nº de columna del ítem.

void setBackgroundColor( Number column, Number r, Number g, Number b, Number a = 255 )

Fija el color de fondo de una columna del ítem pasándole por separado los colores del formato RGBA del color de fondo.

Parámetros:

• column: Nº de columna del ítem.

• r: Nº que se corresponde con la representación decimal del color rojo.

• g: Nº que se corresponde con la representación decimal del color verde.

• b: Nº que se corresponde con la representación decimal del color azul.

• a: Nº que se corresponde con la representación decimal del canal alfa o transparencia.

void setCheckState( Number column, Number state )

Fija el estado de una columana del ítem en curso.

Parámetros:

• column: Número de la columna.

• state: Número que se corresponde con el valor del estado de la columna.

void setFont( Number column, VFont font )

Fija la fuente de la columna.

Propiedades:

• column: Número de columna.

• font: Objeto de la clase VFont que representa a la fuente.

Esta clase se ha incorporado al API en la versión 7.17.

void setForegroundColor( Number column, Number r, Number g, Number b, Number a = 255 )

Fija el color del texto de una columna del ítem pasándole por separado los colores del formato RGBA del color de fondo.

Parámetros:

• column: Nº de columna del ítem.

• r: Nº que se corresponde con la representación decimal del color rojo.

• g: Nº que se corresponde con la representación decimal del color verde.

• b: Nº que se corresponde con la representación decimal del color azul.

• a: Nº que se corresponde con la representación decimal del canal alfa o transparencia.

void setIcon( Number column, VImage image )

Fija el icono que se mostrará en una columna del ítem.

Parámetros:

• column: Nº de columna del ítem.

• image: Objeto de la clase VImage que contiene el icono a visualizar.

void setStatusTip( Number column, String text )

Fija el texto que se mostrará en la barra de estado cuando se pone el ratón encima de la columna del ítem.

Parámetros:

• column: Nº de columna del ítem.

• text: Texto a visualizar en la barra de estado de la ventana.

void setText( Number column, String text )

Fija el texto que se mostrará en una columna del ítem.

Parámetros:

• column: Nº de columna del ítem.

• text: Texto a visualizar.

void setTextAlignment( Number column, Number alignFlags )

Configura la alineación de los textos en una columna del ítem en curso.

Parámetros:

• column: Número de la columna del ítem.

• alignFlags: Número de el valor de los flags de alineamiento. Ver enum de flags de alineamiento.

void setToolTip( Number column, String text )

Fija el texto que se mostrará en el tooltip cuando se ponga el ratón encima de una columna del ítem.

Parámetros:

• column: Nº de columna del ítem.

• text: Texto a visualizar en el tooltip.

void setWhatsThis( Number column, String text )

Fija el texto que se mostrará en la ventana de ayuda cuando se pone el ratón encima de la columna del ítem y está activado el modo "What's this?".

Parámetros:

• column: Nº de columna del ítem.

• text: Texto a visualizar en la ventana de ayuda.

String statusTip( Number column )

Devuelve el texto a visualizar en la barra de estado cuando se sitúa el ratón encima de una columna del ítem.

Parámetros:

• column: Nº de columna del ítem.

String text( Number column )

Devuelve el texto que contiene una columna del ítem.

Parámetros:

• column: Nº de columna del ítem.

Number textAlignment()

Devuelve un número que se corresponde con el valor de alineamiento de texto del ítem y columna en curso, ver enum flags de alineamiento.

String toolTip( Number column )

Devuelve el texto a visualizar en el tooltip cuando se sitúa el ratón encima de una columna del ítem.

Parámetros:

• column: Nº de columna del ítem.

String whatsThis( Number column )

Devuelve el texto a visualizar en la ventan de ayuda cuando se sitúa el ratón encima de una columna del ítem y está activado el modo "What's this?".

Parámetros:

• column: Nº de columna del ítem.

Child items

VTreeItem addChild()

Devuelve un nuevo objeto de la clase VTreeWidgetItem que se corresponderá con un ítem hijo al ítem actual.

VTreeItemRegister addChildRegister( VRegister reg, VItemRegisterPatern patern )

Añade al control un ítem hijo del ítem en curso con el registro y patrón especificados en los parámetros y devuelve un objeto de la clase VTreeItemRegister con el ítem creado.

Parámetros:

• reg: Registro, objeto de la clase VRegister.

• patern: Patrón, objeto de la clase VItemRegisterPatern.

Esta clase se ha incorporado al API en la versión 7.17.

Number addChildRegisterList( VRegisterList regList, VItemRegisterPatern patern )

Añade al control un grupo de ítems hijos del ítem en curso con la lista de registros y patrón especificados en los parámetros y devuelve el número de ítems creados.

Parámetros:

• regList: Registro, objeto de la clase VRegisterList.

• patern: Patrón, objeto de la clase VItemRegisterPatern.

Esta clase se ha incorporado al API en la versión 7.17.

VTreeItem child( Number index )

Devueve un objeto de la clase VTreeWidgetItem correspondiente al ítem que ocupa la posición especificada en el parámetro.

Parámetros:

• index: Nº del ítem.

Number childCount()

Devuelve el nº de ítems hijos.

void deleteChild( Number index )

Eliminar el ítem especificado en el parámetro.

Parámetros:

• index: Nº del ítem a eliminar.