PBToolboxAI v5 ← Site

shellexplorer — u_pbt_shellexplorer #

← Referência dos componentes · Índice do guia

A árvore da shell do Windows: Ambiente de trabalho, Este PC, unidades, pastas, Rede — com os ícones reais do posto.

▶ Ver ao vivo — Aplicação de demonstração, mosaico Shell explorer : a pré-visualização, o código que o produz e esta página, lado a lado.


Em resumo #

Userobjectu_pbt_shellexplorer
Serve paraEscolher uma pasta, ou navegar, sem sair da aplicação
PrincípioVocê diz onde começar; a shell diz o que há, e você recebe o que o utilizador escolheu

Arranque rápido #

// Open event of the window : the tree starts where the application works
uo_tree.is_root = "C:\Projects"

Depois, no evento ue_selected da árvore:

// Event ue_selected : the folder the user chose, by its display name
st_folder.text = as_name

A shell, não o sistema de ficheiros #

O componente não enumera directórios: interroga a shell (IShellFolder). É isso que põe na árvore Este PC, a Rede, a Reciclagem e as pastas virtuais — a árvore que o utilizador já conhece, em vez de uma lista de unidades.

Cada nó é identificado pelo seu nome de análise: um caminho para o que está no disco, uma forma ::{GUID} para o resto. É a única chave que a shell sabe reler — logo a única a guardar.

🚨 ue_selected dá-lhe o nome ALÉM do caminho, e isso não é uma comodidade. O nome apresentado de uma pasta virtual não é o fim do seu caminho: «Este PC» não tem fim. Uma aplicação que corta o caminho mostrará ::{20D04FE0-…} ao seu utilizador.

A árvore constrói-se à medida que se percorre: um ramo só é pedido ao abrir. Ler um disco inteiro para desenhar uma árvore congelaria a aplicação durante minutos numa unidade de rede — e esse é o caso normal nas aplicações onde esta biblioteca vive.

// Event ue_selected : the path AND the display name
st_path.text = as_path
st_name.text = as_name

Propriedades #

PropriedadeTipoPredefiniçãoPapel
is_rootstring""Onde a árvore começa (constantes ROOT_*). Vazio = a raiz da shell. Um caminho começa aí em vez disso
ib_show_filesbooleanfalseMostra também os ficheiros. Falso por predefinição: uma árvore serve para escolher um lugar, e uma pasta com quatro mil ficheiros já não é um lugar
ib_show_hiddenbooleandefinição do ExploradorMostra os ficheiros e pastas ocultos. Enquanto a aplicação não a definir, segue a definição «Itens ocultos» do Explorador do posto — e relê-a. Os ficheiros protegidos do sistema só seguem o Explorador
is_file_filterstring""Que ficheiros são mostrados quando ib_show_files é verdadeiro: padrões separados por ponto e vírgula (*.pdf;*.docx), comparados com o nome real do ficheiro. As pastas aparecem sempre, para que o utilizador chegue ao ficheiro. Vazio = todos. Definido enquanto ib_show_files é falso, não relê nada: parte com os ficheiros
ib_enabledbooleantrueFalso: a árvore fica visível, esbatida, e já não responde ao clique nem ao teclado; sai da ordem de tabulação. A aplicação continua a controlá-la (of_select, of_expand, of_refresh)
is_theme_stylestring""Estilo visual do componente (constantes THEME_STYLE_*); vazio = o da aplicação, seguido a cada mudança
is_theme_modestring""Variante clara ou escura (constantes THEME_MODE_*); vazio = a da aplicação, seguida a cada mudança
il_theme_accentlong-1Cor de destaque deste componente (-1 = destaque da aplicação, ou o do tema)
is_tooltipstring""Dica simples mostrada ao passar sobre o componente
is_super_tooltip_titlestring""Título da dica enriquecida (tem precedência sobre is_tooltip)
is_super_tooltip_textstring""Texto da dica enriquecida (marcação rica aceite)
is_super_tooltip_imagestring""Imagem da dica enriquecida

Uma propriedade escrita com o valor que já tem não relê nada da shell: uma janela pode aplicar as suas definições em cada abertura sem pagar por isso.


Métodos #

MétodoPapel
long of_expand ( string as_path )Abre um ramo, e os ramos fechados acima dele: uma só chamada para um caminho profundo, mesmo ainda não desenhado, a partir de qualquer raiz (sob o Ambiente de trabalho, C:\ alcança-se por Este PC). Uma pasta criada depois de lido o seu pai encontra-se relendo esse pai uma vez. Maiúsculas e barra invertida final não contam. Um caminho inalcançável, ou que não é um ramo, dispara ue_path_not_found. Como o chevron, dispara ue_expanded para cada ramo que se abre pelo caminho (nenhum para um ramo já aberto). Devolve 0 depois de enviado, -5 para um caminho vazio, -2 se o componente não estiver criado
long of_collapse ( string as_path )Fecha um ramo. Os seus filhos ficam, por isso reabri-lo não custa nada. Uma selecção dentro dele sobe para o ramo. Como um clique no seu chevron, dispara ue_collapsed, e ue_selected quando a selecção sobe para o ramo; nada se o ramo já estiver fechado ou não estiver desenhado (não há nada a fechar). Um caminho desenhado duas vezes fecha UMA linha, a que of_select alcançaria. Devolve 0 depois de aplicado, -5 para um caminho vazio, -2 se o componente não estiver criado
long of_select ( string as_path )Selecciona um nó. Os ramos acima dele abrem-se, a selecção fica à vista; um nó ainda não desenhado alcança-se como com of_expand, um inalcançável dispara ue_path_not_found. Como um clique, dispara ue_selected (nada se o nó já estiver seleccionado); of_selected_key relê-o depois de chegar. Devolve 0 depois de enviado, -5 para um caminho vazio, -2 se o componente não estiver criado
long of_refresh ( { string as_path } )Relê a árvore a partir da shell — depois de a aplicação ter escrito no disco. Os ramos abertos reabrem-se e a selecção volta, encontrados pelo seu caminho; o que já não existe é abandonado, e uma selecção desaparecida dispara ue_selected com dois textos vazios. Com um caminho, só esse ramo é relido (um ramo nunca aberto não tem nada a reler). Devolve 0 uma vez pedido, -5 para um caminho vazio, -2 se o componente não estiver criado
string of_selected_key ( )O nome de análise do nó escolhido. A única chave que a shell sabe reler
string of_selected_name ( )O nome apresentado, tal como o Explorador o mostra. Nunca o deduza do caminho
boolean of_selected_is_folder ( )Verdadeiro quando o nó escolhido é uma pasta, falso para um ficheiro ou sem selecção. Os eventos só dão o caminho
boolean of_has ( string as_keys )Verdadeiro quando este caminho está desenhado na árvore, aberto ou não. Um caminho é UMA chave: as suas barras invertidas não são níveis. Maiúsculas não contam, nem / escrito em vez de \ (C:/Data é C:\Data). A raiz (o seu caminho, ou "") está lá assim que a shell a leu
long of_count ( { string as_keys } )Sem caminho: quantas linhas a árvore mostra (um ramo fechado esconde os seus filhos). Com um caminho: quantos filhos foram lidos sob ele — 0 enquanto nunca foi aberto, pois um ramo só é lido ao abrir. A raiz também conta, pelo seu caminho ou por "": of_count(is_root) é o número de nós do primeiro nível, esteja o que estiver aberto por baixo
string of_keys_at ( string as_keys, long al_index )O caminho do filho de posição al_index (a partir de 1) sob um caminho, "" fora dos limites. Um caminho de filho já está inteiro: volta tal qual para of_has, of_count, of_select ou of_expand. of_keys_at(is_root, i) percorre o primeiro nível; of_keys_at(al_index) percorre da mesma forma as linhas mostradas
long of_reset ( )Volta à raiz da shell, só pastas, nada seleccionado. Devolve 0 depois de aplicado, -2 se o componente não estiver criado

Eventos #

EventoDisparado quando
ue_selected (string as_path, string as_name)Um nó é seleccionado — pelo utilizador (clique, teclado) ou por of_select / of_collapse: o seu caminho e o seu nome apresentado. Disparado também com dois textos vazios quando uma releitura descobre que o nó seleccionado desapareceu
ue_expanded (string as_path)Um ramo abre-se — pelo utilizador (chevron, duplo clique, teclado) ou por of_expand / of_select, uma vez por cada ramo aberto pelo caminho. O evento parte antes de os filhos chegarem — a shell é interrogada nesse momento, e numa partilha de rede demora
ue_activated (string as_path)Duplo clique, ou tecla Enter. É aí que uma aplicação abre a pasta, a carrega, ou fecha um selector. Num ramo também o abrem ou fecham: segue-se ue_expanded ou ue_collapsed
ue_error (string as_path, string as_reason, string as_message)A shell recusa um ramo ou a raiz — unidade desligada, pasta sem direitos, partilha que não responde em 30 segundos —: as_path é o seu caminho ("" para o Ambiente de trabalho), as_reason uma constante REASON_* que o seu código pode testar (REASON_ACCESS_DENIED, REASON_TIMEOUT, REASON_NOT_FOUND, REASON_UNREADABLE), as_message o texto da shell para uma pessoa, caminho : texto ((root) : … para o Ambiente de trabalho). O ramo fecha-se (ue_collapsed) e é pedido de novo na próxima abertura; uma raiz ilegível di-lo na árvore
ue_collapsed (string as_path)Um ramo fecha-se — pelo utilizador, por of_collapse, ou pela própria árvore quando um ramo anunciado aberto por ue_expanded volta vazio ou é recusado pela shell. Uma selecção dentro dele sobe para o ramo, e ue_selected comunica-o
ue_path_not_found (string as_path, string as_action, string as_reason)Um of_expand ou of_select não pôde ser servido. as_action vale expand ou select; as_reason uma constante REASON_* (ver abaixo): o caminho não existe, a árvore não o mostra, está fora da raiz, é a raiz, não é um ramo, ultrapassa o limite da demonstração, ou o seu ramo é ilegível
ue_node_rclicked (string as_path, long al_x, long al_y)Um clique direito num nó — seleccionado primeiro, como no Explorador, por isso ue_selected vem antes quando a selecção muda —, ou a tecla do menu de contexto (ou Shift + F10) no nó seleccionado. al_x, al_y são píxeis do ecrã (pelo teclado, o canto inferior esquerdo do nó), os que um contextmenu recebe: uo_menu.of_show(al_x, al_y); para um menu PowerBuilder, PopMenu(PointerX(), PointerY()) da sua janela

Os ícones vêm da lista de imagens do sistema do posto, não de nós: um ficheiro .dwg leva o ícone do AutoCAD se o AutoCAD estiver instalado, e o genérico se não. É o que o utilizador espera, e nada mais o pode dar.


Porque falha um caminho ou um ramo: as constantes REASON_* #

ue_path_not_found e ue_error dão o seu motivo como constante de u_pbt_shellexplorer, a mesma nos dois eventos e em todas as línguas do Windows: teste-a, nunca o texto.

ConstanteO que diz
REASON_NOT_FOUNDO caminho não existe
REASON_NOT_SHOWNO caminho existe, a árvore não o mostra: um ficheiro enquanto ib_show_files é falso, um elemento oculto, um ficheiro excluído por is_file_filter
REASON_OUTSIDE_ROOTO caminho não está sob is_root
REASON_THE_ROOTO caminho é a própria raiz: não é um nó da árvore
REASON_NOT_A_BRANCHof_expand de um ficheiro, ou de uma pasta sem filhos
REASON_ACCESS_DENIEDA shell recusa: sem direitos
REASON_TIMEOUTSem resposta em 30 segundos (uma partilha desaparecida); esse servidor responde depois timeout de imediato durante 30 segundos, até uma leitura bem-sucedida; of_refresh e F5 tentam de novo de imediato
REASON_UNREADABLEQualquer outra recusa da shell: as_message de ue_error dá o seu texto
REASON_DEMO_LIMITModo de demonstração: além dos nós desenhados por nível

Teclado e rato #


Exemplos #

Começar noutro sítio que não o ambiente de trabalho #

// Only the drives, nothing above them
uo_tree.is_root = u_pbt_shellexplorer.ROOT_COMPUTER

// Or somewhere the application already knows
uo_tree.is_root = "C:\Projects"

Abrir o que o utilizador validou #

// Event ue_activated : a double-click, or Enter
of_open_folder(as_path)

Dizer porque um ramo não se abre #

// Event ue_error : test the reason, never the text of the shell
if as_reason = u_pbt_shellexplorer.REASON_TIMEOUT then
    st_status.text = "The network folder " + as_path + " does not answer"
else
    st_status.text = as_message
end if

Abrir o seu menu com um clique direito #

// The entries of the menu, once : uo_menu is a contextmenu of the window, and
// is_menu_path a string instance variable that keeps the folder right-clicked
uo_menu.of_add_item(/*keys*/ "open", /*text*/ "Open")
uo_menu.of_add_item(/*keys*/ "refresh", /*text*/ "Refresh")
// event ue_node_rclicked of uo_tree : (string as_path, long al_x, long al_y)
// The folder is selected first, as in the Explorer : the menu opens where the
// user clicked (from the keyboard, under the folder)
is_menu_path = as_path
uo_menu.of_show(/*x*/ al_x, /*y*/ al_y)
// event ue_item_selected of uo_menu : (string as_keys)
// The entry chosen acts on the folder right-clicked
choose case as_keys
    case "open"
        of_open_folder(is_menu_path)
    case "refresh"
        uo_tree.of_refresh(/*path*/ is_menu_path)
end choose

Boas práticas #

Herdado da base comum #

Estes membros existem em todos os componentes visuais — não são próprios deste. São detalhados uma só vez, nos capítulos transversais; esta tabela apenas diz onde os ler.

MembrosFunçãoDetalhado em
of_resetRepor o componente a zero3.6 Repor um componente a zero: of_reset()
of_register_shortcut · of_clear_shortcutsAtalhos de teclado do componente3.5 Os atalhos de teclado
of_is_created · of_is_ready · of_get_last_errorSe nasceu, se está pronto, o que falhou3.7 Diagnóstico
of_save_as_png · of_save_as_jpgExportar a renderização como imagem3.8 Exportar a representação como imagem
of_set_redrawAgrupar as alterações num único repinte3.10 Boas práticas
of_preload_iconsÍcones mostrados sem atrasoApresentação instantânea: of_icon
of_set_translationTraduzir uma legenda do componente5.2 Adaptar uma etiqueta: of_set_translation
of_focus_webviewDar o foco ao componente6.4 Teclado e focus
of_print · of_print_to_pdfImprimir, ou escrever um PDF6.9 Imprimir
of_set_property · of_get_property · of_component_nameControlar uma propriedade pelo nome3.1 O motor de propriedades
is_accessible_name · is_accessible_descriptionO nome e a descrição que um leitor de ecrã diz3.4 Propriedades e eventos opcionais

Duas ajudas não são herdadas: of_icon e of_escape_markup vivem em n_pbt_utils. Declare um — n_pbt_utils lnv_utils, nada a criar — e chame-as nele.


← Referência dos componentes · Índice do guia