CEGUI Wiki - Crazy Eddie's GUI System (Open Source) - User contributions [en]

Folder Selector

2009-05-17T11:40:52Z

Ivanovich78: Updated links. Added link to forum thread.

[[Folder Selector]]

Some times you may need to allow your application user to navigate trough system folders. This class allows you to easily integrate a folder selector in your game. 

Folder Selector uses DiskObject, a class that depends on <windows.h>. So, for now, there's no support for mac or linux users. 

----
 
'''Links''' 
* Image of the folder selector in action: [[http://ivan.org.es/cegui/fs_preview.JPG]] 
* A game currently using Folder Selector: [[http://www.ivan.org.es/showcase/gameview.php?id=2]] 
* Source, project for MSVC9.0 (with SDL & OpenGL) and a live-demo: [[http://ivan.org.es/cegui/FolderSelector.zip]] 

----
 
'''How to use it''' 
To use Folder Selector in your application, you must call the method:

void show(CEGUI::Window* root);

Where CEGUI::Window* root is a pointer to the window where you want the folder selector to be opened. A file called "fs.layout" contains the current layout used by folder selector. 
After that, the Folder Selector will be showed on the top and you just need to update CEGUI logic and render methods as usually. When the user selects a folder successfully or cancels the action, the folder selector hides again and your application takes the control back. 
If you want to know which folder has been selected by the user, you can subscribe to the PushButton::EventClicked as follows:
// Subscribes the folder selector OK button pusehd event
winMgr.getWindow("FolderSelector/Frame/Ok")->
subscribeEvent(PushButton::EventClicked,
Event::Subscriber(&handleClick));

And in your handle method, make a call to getResults() to know the selected folder:

bool handleClick(const CEGUI::EventArgs &e)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
String selectedFolder(fs.getResult()); // now selectedFolder contains the full path of the directory selected.
return 0;
}

Below you can see the FolderSelector methods and a more complete example of how to use it.

'''Public methods in FolderSelector.h'''

/**
@short makes the Folder selector to appear in CEGUI::Window
*/
void show(CEGUI::Window* root);

/**
@short hide Folder Selector
*/
void hide();

/**
@short Returns the last selected file
*/
std::string getResult();

/**
@short set the current folder
*/
void setFolder(std::string);

/**
@short sets the filter string. The string will be used to enable/disable OK
button when files in the current folder matches the filter string
(i.e., "*.jpg" string will enable OK button only when the current folder
contains files with extension .jpg). By default is "*", showing all files.
*/
void setFileFiler(std::string s){d_fileFilter = s;}

'''This is how the example looks:'''

#include "SDL.h"
#include "GUI_Menu.h"
#include "GUI_FolderSelector.h"
#define QUIT -1
#define MENU 0
#define FOLDER_SELECTOR 1
GUI_FolderSelector fs;
void init()
{
// ... This is just an example, complete code in downloadable file
}
void setupCEGUI()
{
// ... This is just an example, complete code in downloadable file
}
bool handleClick(const CEGUI::EventArgs &e)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
Window* btn = static_cast<Window*>(winMgr.getWindow("Root/Play"));
btn->setText(fs.getResult());
return 0;
}
int main(int argc, char **argv)
{
using namespace CEGUI;
// init SDL/OpenGL Framework
init();
// init CEGUI
setupCEGUI();
// create main menu
WindowManager& winMgr = WindowManager::getSingleton();
GUI_Menu menu("menu.layout");
//Main loop
do
{
menu.injectInput();
menu.render();
if (menu.getState() == FOLDER_SELECTOR)
{
// makes appear the folder selector
fs.show(CEGUI::System::getSingleton().getGUISheet());
// Subscribe OK button event
winMgr.getWindow("FolderSelector/Frame/Ok")->
subscribeEvent(PushButton::EventClicked,
Event::Subscriber(&handleClick));
// back to menu (fs will auto-hide when done)
menu.setState(MENU);
}
SDL_Delay(10);
} while (menu.getState() != QUIT);
return 0;
}

If you've got some trouble running the example just let me know at this thread:
http://www.cegui.org.uk/phpBB2/viewtopic.php?f=1&t=3597&start=0 
--[[User:Ivanovich78|Ivanovich78]] 21:47, 19 October 2008 (UTC)

Tutorials

2008-10-29T18:15:09Z

Ivanovich78: /* Miscellaneous HOW-TOs */ Moving folder selector to CodeSnippets

=== CrazyEddie's Beginner Guides ===
* [[The Beginner Guide to Getting CEGUI Rendering]] - How to initialise CEGUI to render properly.
* [[The Beginner Guide to Resource Groups]] - How to define resource group locations and specify default resource groups.
* [[The Beginner Guide to Loading Data Files and Initialisation]] - How to load some data files and perform basic system initialisation.
* [[The Beginner Guide to Creating a CEGUI Window]] - How to create a simple window and get it on screen.
* [[The Beginner Guide to Injecting Inputs]] - How to inject inputs into CEGUI and get interactive.
* [[HOWTO:_Use_the_Unified_Positions_and_Sizes_System|The Beginner Guide to the Unified Position and Size System (CEGUI >= 0.4.0)]]

=== Scripting with CEGUI ===
* [[Getting Started with Lua and CEGUI]] - How to initialise CEGUI with a Lua script module and configuration file.
* [[Handling Events from Lua]] - How to load Lua script files and bind CEGUI events to Lua functions.
* [[Writing CEGUI scripts]] - Code snippets
* [[Adding LuaScriptModule to Sample_FirstWindow]] - Experience adding scripting to an existing sample.
* [http://www.gpwiki.org/index.php/Crazy_Eddies_GUI_System:Tutorials:Creating_a_scriptable_interface_using_CEGUI Creating a scriptable interface using CEGUI]
* [[Custom_ScriptingModule]] - Creating a basic custom scripting module in CEGUI

=== Window System Examples ===
* [[Using CEGUI with SDL and OpenGL]] - Guidelines on how to get SDL, OpenGL and CEGUI running together.
* [[Using CEGUI with Producer and OpenGL]] - Guidelines on how to render and inject input to CEGUI from the Producer API.
* [http://artis.imag.fr/Membres/Xavier.Decoret/resources/CEGUI/ Using CEGUI with Qt/QGLViewer]
* [[Using CEGUI with GLUT]] - Some tips on using OpenGL's GLUT with CEGUI.

=== Extending CEGUI ===

* [[Using Expat XML parser within CEGUI]] - How to add support for another XML parser.

=== Skins - Tutorial For Artists ===
* [[Creating Skins]] - Extra notes for artists on how to create skins.
* [[The Beginners Guide to Falagard skinning - Part I]] - Learn by doing a Button.
* [[The Beginners Guide to Falagard skinning - Part II]] - More Falagard fun, this time with the Editbox.

=== Overviews ===
* [[Overview of GUI files]] - A quick introduction to all the XML files used by CEGUI.

=== Miscellaneous HOW-TOs ===
* [[Create ImageButtons]] - A few different ways to create image buttons.
* [[Create a CheckListboxItem]] - Create a CheckListBoxItem that you can use with ItemListbox.
* [[Identifying Multiple Event Sources From A Single Callback]]
* [[Cool_window_effects]] - A collection of cool "special" effects on (frame)windows.

Folder Selector

2008-10-19T21:47:02Z

Ivanovich78: Initial page creation.

[[Folder Selector]]

Some times you may need to allow your application user to navigate trough system folders. This class allows you to easily integrate a folder selector in your game. 

Folder Selector uses DiskObject, a class that depends on <windows.h>. So, for now, there's no support for mac or linux users. 

----
 
'''Links''' 
* Image of the folder selector in action: [[http://meteorgames.es/temp/fs_preview.JPG]] 
* A game currently using Folder Selector: [[http://meteorgames.es/gameview.php?id=2]] 
* Source, project for MSVC9.0 (with SDL & OpenGL) and a pre-compiled example: [[http://meteorgames.es/temp/FolderSelector.zip]] 

----
 
'''How to use it''' 
To use Folder Selector in your application, you must call the method:

void show(CEGUI::Window* root);

Where CEGUI::Window* root is a pointer to the window where you want the folder selector to be opened. A file called "fs.layout" contains the current layout used by folder selector. 
After that, the Folder Selector will be showed on the top and you just need to update CEGUI logic and render methods as usually. When the user selects a folder successfully or cancels the action, the folder selector hides again and your application takes the control back. 
If you want to know which folder has been selected by the user, you can subscribe to the PushButton::EventClicked as follows:
// Subscribes the folder selector OK button pusehd event
winMgr.getWindow("FolderSelector/Frame/Ok")->
subscribeEvent(PushButton::EventClicked,
Event::Subscriber(&handleClick));

And in your handle method, make a call to getResults() to know the selected folder:

bool handleClick(const CEGUI::EventArgs &e)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
String selectedFolder(fs.getResult()); // now selectedFolder contains the full path of the directory selected.
return 0;
}

Below you can see the FolderSelector methods and a more complete example of how to use it.

'''Public methods in FolderSelector.h'''

/**
@short makes the Folder selector to appear in CEGUI::Window
*/
void show(CEGUI::Window* root);

/**
@short hide Folder Selector
*/
void hide();

/**
@short Returns the last selected file
*/
std::string getResult();

/**
@short set the current folder
*/
void setFolder(std::string);

/**
@short sets the filter string. The string will be used to enable/disable OK
button when files in the current folder matches the filter string
(i.e., "*.jpg" string will enable OK button only when the current folder
contains files with extension .jpg). By default is "*", showing all files.
*/
void setFileFiler(std::string s){d_fileFilter = s;}

'''This is how the example looks:'''

#include "SDL.h"
#include "GUI_Menu.h"
#include "GUI_FolderSelector.h"
#define QUIT -1
#define MENU 0
#define FOLDER_SELECTOR 1
GUI_FolderSelector fs;
void init()
{
// ... This is just an example, complete code in downloadable file
}
void setupCEGUI()
{
// ... This is just an example, complete code in downloadable file
}
bool handleClick(const CEGUI::EventArgs &e)
{
using namespace CEGUI;
WindowManager& winMgr = WindowManager::getSingleton();
Window* btn = static_cast<Window*>(winMgr.getWindow("Root/Play"));
btn->setText(fs.getResult());
return 0;
}
int main(int argc, char **argv)
{
using namespace CEGUI;
// init SDL/OpenGL Framework
init();
// init CEGUI
setupCEGUI();
// create main menu
WindowManager& winMgr = WindowManager::getSingleton();
GUI_Menu menu("menu.layout");
//Main loop
do
{
menu.injectInput();
menu.render();
if (menu.getState() == FOLDER_SELECTOR)
{
// makes appear the folder selector
fs.show(CEGUI::System::getSingleton().getGUISheet());
// Subscribe OK button event
winMgr.getWindow("FolderSelector/Frame/Ok")->
subscribeEvent(PushButton::EventClicked,
Event::Subscriber(&handleClick));
// back to menu (fs will auto-hide when done)
menu.setState(MENU);
}
SDL_Delay(10);
} while (menu.getState() != QUIT);
return 0;
}

If you've got some trouble running the example just let me know. 
--[[User:Ivanovich78|Ivanovich78]] 21:47, 19 October 2008 (UTC)

Tutorials

2008-10-19T20:54:17Z

Ivanovich78: /* Miscellaneous HOW-TOs */ Add Folder Selector link