NAME

TUI::StdDlg::ChDirDialog - common dialog for selecting a directory

HIERARCHY

TObject
  TView
    TGroup
      TWindow
        TDialog
          TChDirDialog

SYNOPSIS

use TUI::StdDlg;

my $dlg = new_TChDirDialog(
  $options,
  $histId
);

my $result = $deskTop->execView($dlg);

DESCRIPTION

TChDirDialog implements the standard Turbo Vision dialog used for selecting and changing directories.

The dialog presents a directory list, an input line for the directory path, and command buttons. It allows navigation through the directory hierarchy using keyboard and mouse input and returns the selected directory to the caller.

VARIABLES

The following global variables define the default labels and messages used by TChDirDialog.

$changeDirTitle

Title text of the change directory dialog.

$dirNameText

Label text for the directory name input field.

$dirTreeText

Label text for the directory tree view.

$okText

Label text for the confirmation button.

$chdirText

Label text for the change directory action.

$revertText

Label text for the revert action.

$helpText

Label text for the help command.

$drivesText

Label text for the drives selection area.

$invalidText

Message text displayed for an invalid directory.

CONSTRUCTOR

new

my $dlg = TChDirDialog->new(
  options => $options,
  histId  => $histId
);

Creates a new change-directory dialog.

options

Dialog option flags controlling behavior and appearance (Int).

histId

History identifier used for directory input history (Int).

new_TChDirDialog

my $dlg = new_TChDirDialog($options, $histId);

Factory-style constructor using positional arguments.

METHODS

dataSize

my $size = $dlg->dataSize();

Returns the number of scalar values transferred via getData and setData.

getData

$dlg->getData(\@record);

Stores the selected directory into the supplied record.

handleEvent

$dlg->handleEvent($event);

Processes keyboard and command events for directory navigation and selection.

setData

$dlg->setData(\@record);

Initializes the dialog state from external input.

shutDown

$dlg->shutDown();

Releases dialog resources during shutdown.

valid

my $bool = $dlg->valid($command);

Checks whether the dialog should accept the specified command.

SEE ALSO

TUI::StdDlg::DirListBox, TUI::StdDlg::DirEntry, TUI::Dialogs::Dialog

AUTHORS

Borland International (original Turbo Vision design)
J. Schneider <brickpool@cpan.org> (Perl implementation and maintenance)

CONTRIBUTORS

Eric Woodruff

COPYRIGHT AND LICENSE

Copyright (c) 1990-1994, 1997 by Borland International

Copyright (c) 1995, 2026 the "AUTHORS" and "CONTRIBUTORS" as listed above.

This software is licensed under the MIT license (see the LICENSE file, which is part of the distribution).