Classe: TListBoxCria um objeto do tipo lista de itens com barra de rolagem. CreateMétodo construtor da classe.TListBox(): Create ( [ oWnd], [ nRow], [ nCol], [ bSetGet], [ aItems], [ nWidth], [ nHeight], [ bChange], [ bValid], [ nClrForeuParam10], [ nClrBackuParam11], [ lPixel], [ uParam13], [ bLDBLClick], [ oFont], [ uParam16], [ uParam17], [ bWhen], [ uParam19], [ uParam20], [ uParam21], [ uParam22], [ bRClick] ) --> oObjeto Nome | Tipo | Descrição | Obrigatório | Referência | oWnd | Objeto | Indica a janela ou controle visual onde o objeto será criado. | | | nRow | Numérico | Indica a coordenada vertical em pixels ou caracteres. | | | nCol | Numérico | Indica a coordenada horizontal em pixels ou caracteres. | | | bSetGet | Bloco de código | Indica o bloco de código, no formato {|u| if( Pcount( )>0, := u, ) }, que será executado para atualizar a variável (essa variável deve ser do tipo caracter). Desta forma, se a lista for seqüencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado. | | | aItems | Vetor | Indica uma lista de itens e caracteres que serão apresentados. Essa lista pode ter os seguintes formatos: Seqüencial (Exemplo: {"item1","item2",...,"itemN"}) ou Indexada (Exemplo: {"a=item1","b=item2",...,"n=itemN"}). | | | nWidth | Numérico | Indica a largura em pixels do objeto. | | | nHeight | Numérico | Indica a altura em pixels do objeto. | | | bChange | Bloco de código | Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. | | | bValid | Objeto | Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro (.T.), se o conteúdo é válido; caso contrário, falso (.F.). | | | nClrForeuParam10 | Numérico | Indica a cor de fundo do objetoCompatibilidade. | | | nClrBackuParam11 | Numérico | Indica a cor do texto do objetoCompatibilidade. | | | lPixel | Lógico | Indica se considera as coordenadas passadas em pixels (.T.) ou caracteres (.F.). | | | uParam13 | Lógico | Compatibilidade. | | | bLDBLClick | Bloco de código | Indica o bloco de código que será executado quando clicar duas vezes, com o botão esquerdo do mouse, sobre o objeto. | | | oFont | Objeto | Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. | | | uParam16 | Caracter | Compatibilidade. | | | uParam17 | Lógico | Compatibilidade. | | | bWhen | Bloco de código | Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro (.T.) se o controle permanecer habilitado; caso contrário, retornará falso (.F.). | | | uParam19 | Lógico | Compatibilidade. | | | uParam20 | Bloco de código | Compatibilidade. | | | uParam21 | Lógico | Compatibilidade. | | | uParam22 | Lógico | Compatibilidade. | | | bRClick | Bloco de código | Indica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto. | | |
oObjeto(objeto)- Retorna o objeto criado.
oList := TListBox():Create(oDlg,001,110,{|u|if(Pcount()>0,nList:=u,nList)},; aItems,100,100,,,,,.T.) NewMétodo construtor da classe.TListBox(): New ( [ nRow], [ nCol], [ bSetGet], [ aItems], [ nWidth], [ nHeight], [ bChange], [ oWnd], [ bValid], [ nClrForeuParam10], [ nClrBackuParam11], [ lPixel], [ uParam13], [ bLDBLClick], [ oFont], [ uParam16], [ uParam17], [ bWhen], [ uParam19], [ uParam20], [ uParam21], [ uParam22], [ bRClick] ) --> oObjeto Nome | Tipo | Descrição | Obrigatório | Referência | nRow | Numérico | Indica a coordenada vertical em pixels ou caracteres. | | | nCol | Numérico | Indica a coordenada horizontal em pixels ou caracteres. | | | bSetGet | Bloco de código | Indica o bloco de código, no formato {|u| if( Pcount( )>0, := u, ) }, que será executado para atualizar a variável (essa variável deve ser do tipo caracter). Desta forma, se a lista for seqüencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado. | | | aItems | Vetor | Indica uma lista de itens e caracteres que serão apresentados. Essa lista pode ter os seguintes formatos: Seqüencial (Exemplo: {"item1","item2",...,"itemN"}) ou Indexada (Exemplo: {"a=item1","b=item2",...,"n=itemN"}). | | | nWidth | Numérico | Indica a largura em pixels do objeto. | | | nHeight | Numérico | Indica a altura em pixels do objeto. | | | bChange | Bloco de código | Indica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual. | | | oWnd | Objeto | Indica a janela ou controle visual onde o objeto será criado. | | | bValid | Bloco de código | Indica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro (.T.), se o conteúdo é válido; caso contrário, falso (.F.). | | | nClrForeuParam10 | Numérico | Indica a cor de fundo do objetoCompatibilidade. | | | nClrBackuParam11 | Numérico | Indica a cor do texto do objetoCompatibilidade. | | | lPixel | Lógico | Indica se considera as coordenadas passadas em pixels (.T.) ou caracteres (.F.). | | | uParam13 | Lógico | Compatibilidade. | | | bLDBLClick | Bloco de código | Indica o bloco de código que será executado quando clicar duas vezes, com o botão esquerdo do mouse, sobre o objeto. | | | oFont | Objeto | Indica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual. | | | uParam16 | Caracter | Compatibilidade. | | | uParam17 | Lógico | Compatibilidade. | | | bWhen | Bloco de código | Indica o bloco de código que será executado quando a mudança de foco da entrada de dados, no objeto criado, estiver sendo realizada. Se o retorno for verdadeiro (.T.), o objeto continua habilitado; caso contrário, falso (.F.). | | | uParam19 | Array of Record | Compatibilidade. | | | uParam20 | Bloco de código | Compatibilidade. | | | uParam21 | Lógico | Compatibilidade. | | | uParam22 | Lógico | Compatibilidade. | | | bRClick | Bloco de código | Indica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto. | | |
oObjeto()- Retorna o objeto criado.
oList := TListBox():New(001,001,{|u|if(Pcount()>0,nList:=u,nList)},; aItems,100,100,,oDlg,,,,.T.) ChangeExecuta o bloco de código, configurado no parâmetro <bChange>, ao mudar de linha.TListBox(): Change ( ) --> DelExclui um item.TListBox(): Del ( < nPos> ) --> Nome | Tipo | Descrição | Obrigatório | Referência | nPos | Numérico | Indica a posição do item que será excluído. Observação: Essa posição deve ser maior que 0 e menor ou igual que o número de itens. | X | |
GetPosRetorna a posição do item selecionado na lista.TListBox(): GetPos ( ) --> nRet nRet(numerico)- Retorna a posição do item selecionado.
oList:GetPos() // Result: 1 GetSelTextRetorna o texto do item selecionado na lista.TListBox(): GetSelText ( ) --> cRetTexto cRetTexto(caracter)- Retorna o texto do item selecionado na lista.
oList:GetSelText() // Result: "Item 1" GoBottomPosiciona no último item da lista.TListBox(): GoBottom ( ) --> GoTopPosiciona no primeiro item da lista.TListBox(): GoTop ( ) --> InsertInsere um novo item.TListBox(): Insert ( < cText>, < nPos> ) --> Nome | Tipo | Descrição | Obrigatório | Referência | cText | Caracter | Indica o texto do item que será inserido. | X | | nPos | Numérico | Indica a posição do novo item, deslocando o item (anterior) daquela posição para baixo. Obs.: É necessário que exista um item naquela posição para inserir outro em seu lugar. | X | |
oList:Insert("Novo item", 2) Exemplo do método Insert LenRetorna o número de itens.TListBox(): Len ( ) --> nRet nRet(numerico)- Retorna o número de itens.
ModifyAltera o texto do item.TListBox(): Modify ( < cText>, < nPos> ) --> Nome | Tipo | Descrição | Obrigatório | Referência | cText | Caracter | Indica o novo texto do item. | X | | nPos | Numérico | Indica a posição do item que terá seu texto alterado. Observação: A posição deve ser maior que 0 e menor ou igual que o número de itens. | X | |
oList:Modify("Item 2 modificado", 2) Exemplo do método Modify ResetLimpa todos os itens da ListBox.TListBox(): Reset ( ) --> SelectForça a seleção de um item.TListBox(): Select ( [ nItem] ) --> Nome | Tipo | Descrição | Obrigatório | Referência | nItem | Numérico | Indica a posição do item que será selecionado. | | |
SetArrayDefine o vetor de itens para a lista. Caso exista uma definição anterior ela será substituida.TListBox(): SetArray ( < aVetor> ) --> Nome | Tipo | Descrição | Obrigatório | Referência | aVetor | Vetor | Indica um array, no formato texto, com os itens para a lista. | X | |
oList:SetArray({'Item novo 1','Item novo 2','Item novo 3','Item novo 4'}) SetItemsDefine o array de itens para a lista. Caso exista uma definição anterior ela será substituída.TListBox(): SetItems ( < aVetor> ) --> Nome | Tipo | Descrição | Obrigatório | Referência | aVetor | Vetor | Indica o array, no formato texto, que contêm os itens para a lista. | X | |
oList:SetItems({'Item novo 1','Item novo 2','Item novo 3','Item novo 4'}) Propriedade | Descrição | Tipo | aItems | Indica a lista de itens para seleção. | Vetor | nAt | Indica a posição do item selecionado. | Numérico |
Sempre que um item é selecionado, uma variável é atualizada com o conteúdo do item. Bloco de código |
---|
theme | Eclipse |
---|
language | cpp |
---|
title | Exemplo |
---|
linenumbers | true |
---|
| #INCLUDE "TOTVS.CH"
USER FUNCTION TListBox()
DEFINE DIALOG oDlg TITLE "Exemplo TListBox" FROM 180,180 TO 550,700 PIXEL
aItems := {'Item 1','Item 2','Item 3','Item 4'}
nList := 1
// Usando o New
oList1 := TListBox():New(001,001,{|u|if(Pcount()>0,nList:=u,nList)},;
aItems,100,100,,oDlg,,,,.T.)
// Usando o Create
oList2 := TListBox():Create(oDlg,001,110,{|u|if(Pcount()>0,nList:=u,nList)},;
aItems,100,100,,,,,.T.)
ACTIVATE DIALOG oDlg CENTERED
RETURN |
Exemplo da classe TListBox Advanced Protheus 6.09 , Advanced Protheus 7.10 , Microsiga Protheus 8.11 , Microsiga Protheus 11 , Protheus 10 , TOTVS Application Server 10 , ByYou Application Server |