guiFileTreeCtrl.h

Engine/source/gui/controls/guiFileTreeCtrl.h
Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _GUI_FILETREECTRL_H_
25#define _GUI_FILETREECTRL_H_
26
27#include "platform/platform.h"
28#include "gui/controls/guiTreeViewCtrl.h"
29
30class GuiFileTreeCtrl : public GuiTreeViewCtrl
31{
32private:
33
34   // Utility functions
35   void recurseInsert( Item* parent, StringTableEntry path );
36   void addPathToTree( StringTableEntry path );
37
38protected:
39   String               mSelPath;
40   String               mFileFilter;
41   String               mRootPath;
42   Vector< String>     mFilters;
43
44   void _initFilters();
45   
46   static bool _setFileFilterValue( void *object, const char *index, const char *data );
47
48public:
49
50   typedef GuiTreeViewCtrl Parent;
51   
52   enum
53   {
54      Icon_Folder = 1,
55      Icon_FolderClosed = 2,
56      Icon_Doc = 3
57   };
58   
59   GuiFileTreeCtrl();
60
61   bool onWake();
62   bool onVirtualParentExpand(Item *item);
63   void onItemSelected( Item *item );
64   const String& getSelectedPath() { return mSelPath; }
65   bool setSelectedPath( const char* path );
66      
67   bool matchesFilters(const char* filename);
68   void updateTree();
69
70   DECLARE_CONOBJECT( GuiFileTreeCtrl );
71   DECLARE_DESCRIPTION( "A control that displays a hierarchical tree view of a path in the game file system.\n"
72                        "Note that to enable expanding/collapsing of directories, the control must be\n"
73                        "placed inside a GuiScrollCtrl." );
74
75   static void initPersistFields();
76};
77
78#endif //_GUI_FILETREECTRL_H_
79