browser.cpp
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#include "gui/browser.h"
#include "gui/gui-manager.h"
#include "gui/widgets/edittext.h"
#include "gui/widgets/list.h"
#include "common/config-manager.h"
#include "common/system.h"
#include "common/algorithm.h"
#if defined(USE_SYSDIALOGS)
#include "common/dialogs.h"
#endif
#include "common/translation.h"
namespace GUI {
enum {
kChooseCmd = 'Chos',
kGoUpCmd = 'GoUp',
kHiddenCmd = 'Hidd',
kPathEditedCmd = 'Path'
};
/* We want to use this as a general directory selector at some point... possible uses
* - to select the data dir for a game
* - to select the place where save games are stored
* - others???
*/
BrowserDialog::BrowserDialog(const Common::U32String &title, bool dirBrowser)
: Dialog("Browser") {
_title = title;
_isDirBrowser = dirBrowser;
_fileList = nullptr;
_currentPath = nullptr;
_showHidden = false;
// Headline - TODO: should be customizable during creation time
new StaticTextWidget(this, "Browser.Headline", title);
// Current path - TODO: handle long paths ?
_currentPath = new EditTextWidget(this, "Browser.Path", Common::U32String(), Common::U32String(), 0, kPathEditedCmd);
// Add file list
_fileList = new ListWidget(this, "Browser.List");
_fileList->setNumberingMode(kListNumberingOff);
_fileList->setEditable(false);
_backgroundType = GUI::ThemeEngine::kDialogBackgroundPlain;
// Checkbox for the "show hidden files" state.
_showHiddenWidget = new CheckboxWidget(this, "Browser.Hidden", _("Show hidden files"), _("Show files marked with the hidden attribute"), kHiddenCmd);
// Buttons
if (g_system->getOverlayWidth() > 320)
new ButtonWidget(this, "Browser.Up", _("Go up"), _("Go to previous directory level"), kGoUpCmd);
else
new ButtonWidget(this, "Browser.Up", _c("Go up", "lowres"), _("Go to previous directory level"), kGoUpCmd);
new ButtonWidget(this, "Browser.Cancel", _("Cancel"), Common::U32String(), kCloseCmd);
new ButtonWidget(this, "Browser.Choose", _("Choose"), Common::U32String(), kChooseCmd);
}
int BrowserDialog::runModal() {
#if defined(USE_SYSDIALOGS)
// Try to use the backend browser
Common::DialogManager *dialogManager = g_system->getDialogManager();
if (dialogManager) {
if (ConfMan.getBool("gui_browser_native", Common::ConfigManager::kApplicationDomain)) {
Common::DialogManager::DialogResult result = dialogManager->showFileBrowser(_title, _choice, _isDirBrowser);
if (result != Common::DialogManager::kDialogError) {
return result;
}
}
}
#endif
// If all else fails, use the GUI browser
return Dialog::runModal();
}
void BrowserDialog::open() {
// Call super implementation
Dialog::open();
if (ConfMan.hasKey("browser_lastpath"))
_node = Common::FSNode(ConfMan.get("browser_lastpath"));
if (!_node.isDirectory())
_node = Common::FSNode(".");
_showHidden = ConfMan.getBool("gui_browser_show_hidden", Common::ConfigManager::kApplicationDomain);
_showHiddenWidget->setState(_showHidden);
// At this point the file list has already been refreshed by the kHiddenCmd handler
}
void BrowserDialog::handleCommand(CommandSender *sender, uint32 cmd, uint32 data) {
switch (cmd) {
//Search for typed-in directory
case kPathEditedCmd:
_node = Common::FSNode(Common::convertFromU32String(_currentPath->getEditString()));
updateListing();
break;
//Search by text input
case kChooseCmd:
if (_isDirBrowser) {
// If nothing is selected in the list widget, choose the current dir.
// Else, choose the dir that is selected.
int selection = _fileList->getSelected();
if (selection >= 0)
_choice = _nodeContent[selection];
else
_choice = _node;
setResult(1);
close();
} else {
int selection = _fileList->getSelected();
if (selection < 0)
break;
if (_nodeContent[selection].isDirectory()) {
_node = _nodeContent[selection];
updateListing();
} else {
_choice = _nodeContent[selection];
setResult(1);
close();
}
}
break;
case kGoUpCmd:
_node = _node.getParent();
updateListing();
break;
case kListItemActivatedCmd:
case kListItemDoubleClickedCmd:
if (_nodeContent[data].isDirectory()) {
_node = _nodeContent[data];
updateListing();
} else if (!_isDirBrowser) {
_choice = _nodeContent[data];
setResult(1);
close();
}
break;
case kListSelectionChangedCmd:
// We do not allow selecting directories in directory
// browser mode, thus we will invalidate the selection
// when the user selects an directory over here.
if (data != (uint32)-1 && _isDirBrowser && !_nodeContent[data].isDirectory())
_fileList->setSelected(-1);
break;
case kHiddenCmd:
// Update whether the user wants hidden files to be shown
_showHidden = _showHiddenWidget->getState();
// We save the state in the application domain to avoid cluttering and
// to prevent odd behavior.
ConfMan.setBool("gui_browser_show_hidden", _showHidden, Common::ConfigManager::kApplicationDomain);
// Update the file listing
updateListing();
break;
default:
Dialog::handleCommand(sender, cmd, data);
}
}
void BrowserDialog::updateListing() {
// Update the path display
_currentPath->setEditString(_node.getPath());
// We memorize the last visited path.
// Don't memorize a path that is not a directory
if (_node.isDirectory()) {
ConfMan.set("browser_lastpath", _node.getPath());
}
// Read in the data from the file system
if (!_node.getChildren(_nodeContent, Common::FSNode::kListAll, _showHidden))
_nodeContent.clear();
else
Common::sort(_nodeContent.begin(), _nodeContent.end());
// Populate the ListWidget
Common::U32StringArray list;
Common::U32String color = ListWidget::getThemeColor(ThemeEngine::kFontColorNormal);
for (Common::FSList::iterator i = _nodeContent.begin(); i != _nodeContent.end(); ++i) {
if (_isDirBrowser) {
if (i->isDirectory())
color = ListWidget::getThemeColor(ThemeEngine::kFontColorNormal);
else
color = ListWidget::getThemeColor(ThemeEngine::kFontColorAlternate);
}
if (i->isDirectory())
list.push_back(color + ListWidget::escapeString(Common::U32String(i->getName()) + "/"));
else
list.push_back(color + ListWidget::escapeString(Common::U32String(i->getName())));
}
_fileList->setList(list);
_fileList->scrollTo(0);
// Finally, redraw
g_gui.scheduleTopDialogRedraw();
}
} // End of namespace GUI