class: ewol::widget::ListFileSystem
Description:
Generic display folder class. This widget display the content of a single folder :Constructor and Destructor:
# ListFileSystem ();
+ virtual ~ListFileSystem ();
Synopsis:
+ ewol::object::Signal<std::string> signalFileSelect;
+ ewol::object::Signal<std::string> signalFileValidate;
+ ewol::object::Signal<std::string> signalFolderSelect;
+ ewol::object::Signal<std::string> signalFolderValidate;
# void init ();
+ DECLARE_WIDGET_FACTORY (ListFileSystem ,
"ListFileSystem" );
# std::shared_ptr<ewol::resource::ColorFile> m_colorProperty;
# int32_t m_colorIdText;
# int32_t m_colorIdBackground1;
# int32_t m_colorIdBackground2;
# int32_t m_colorIdBackgroundSelected;
# virtual etk::Color<> getBasicBG ();
# virtual uint32_t getNuberOfColomn ();
# virtual bool getTitle (int32_t _colomn,
std::string & _myTitle,
etk::Color<> & _fg,
etk::Color<> & _bg);
# virtual uint32_t getNuberOfRaw ();
# virtual bool getElement (int32_t _colomn,
int32_t _raw,
std::string & _myTextToWrite,
etk::Color<> & _fg,
etk::Color<> & _bg);
# virtual bool onItemEvent (int32_t _IdInput,
enum ewol::key::status _typeEvent,
int32_t _colomn,
int32_t _raw,
float _x,
float _y);
# std::vector<etk::FSNode*> m_list;
# void clearList ();
# virtual void regenerateView ();
# int32_t m_selectedLine;
+ virtual void setSelect (const std::string & _data);
+ std::string getSelect () const;
# ewol::object::Param<std::string> m_folder;
# ewol::object::Param<std::string,true> m_selectFile;
+ void setFolder (const std::string & _newFolder);
+ const std::string & getFolder () const;
# ewol::object::Param<bool> m_showFile;
+ void setShowFiles (bool _state);
+ bool getShowFiles () const;
# ewol::object::Param<bool> m_showFolder;
+ void setShowFolder (bool _state);
+ bool getShowFolder () const;
# ewol::object::Param<bool> m_showHidden;
+ void setShowHidden (bool _state);
+ bool getShowHidden () const;
# ewol::object::Param<bool> m_showTemporaryFile;
+ void setShowTemporaryFiles (bool _state);
+ bool getShowTemporaryFiles () const;
+ virtual void onParameterChangeValue (const ewol::object::ParameterRef & _paramPointer);
Object Hierarchy:
+std::enable_shared_from_this<Object>
+ewol::object::ParameterList
+ewol::object::SignalList
+--> +ewol::Object
+--> +ewol::Widget
+--> +ewol::widget::WidgetScrolled
+--> +ewol::widget::List
+--> ewol::widget::ListFileSystem
Detail:
signalFileSelect
+ ewol::object::Signal<std::string> signalFileSelect;
signalFileValidate
+ ewol::object::Signal<std::string> signalFileValidate;
signalFolderSelect
+ ewol::object::Signal<std::string> signalFolderSelect;
signalFolderValidate
+ ewol::object::Signal<std::string> signalFolderValidate;
ListFileSystem
# ListFileSystem ();
init
# void init ();
DECLARE_WIDGET_FACTORY
+ DECLARE_WIDGET_FACTORY (ListFileSystem ,
"ListFileSystem" );
~ListFileSystem
+ virtual ~ListFileSystem ();
m_colorProperty
# std::shared_ptr<ewol::resource::ColorFile> m_colorProperty;
theme color property.
m_colorIdText
# int32_t m_colorIdText;
Color of the text.
m_colorIdBackground1
# int32_t m_colorIdBackground1;
Color of the Background.
m_colorIdBackground2
# int32_t m_colorIdBackground2;
Color of the Background 2.
m_colorIdBackgroundSelected
# int32_t m_colorIdBackgroundSelected;
Color of line selected.
getBasicBG
# virtual etk::Color<> getBasicBG ();
getNuberOfColomn
# virtual uint32_t getNuberOfColomn ();
getTitle
# virtual bool getTitle (int32_t _colomn,
std::string & _myTitle,
etk::Color<> & _fg,
etk::Color<> & _bg);
getNuberOfRaw
# virtual uint32_t getNuberOfRaw ();
getElement
# virtual bool getElement (int32_t _colomn,
int32_t _raw,
std::string & _myTextToWrite,
etk::Color<> & _fg,
etk::Color<> & _bg);
onItemEvent
# virtual bool onItemEvent (int32_t _IdInput,
enum ewol::key::status _typeEvent,
int32_t _colomn,
int32_t _raw,
float _x,
float _y);
m_list
# std::vector<etk::FSNode*> m_list;
List of all element in the path. (they are filtered)
clearList
# void clearList ();
Clean the list of element.
regenerateView
# virtual void regenerateView ();
Regenerate the content of the view. this is actually not automation on the system update.
m_selectedLine
# int32_t m_selectedLine;
Current Line ID that is selected
setSelect
+ virtual void setSelect (const std::string & _data);
Select a specific file in the path
Parameter [input]: _data File to selested.
getSelect
+ std::string getSelect () const;
Get the current selected file/folder/... in the list
Return: the String of the element selected.
m_folder
# ewol::object::Param<std::string> m_folder;
Current folder that display point on.
m_selectFile
# ewol::object::Param<std::string,true> m_selectFile;
current selected file
setFolder
+ void setFolder (const std::string & _newFolder);
Set a folder to display (might be a valid folder !!!)
Parameter [input]: _newFolder Path on the folder to display content.
getFolder
+ const std::string & getFolder () const;
Get the element current displaying folder path.
Return: Path on the folder.
m_showFile
# ewol::object::Param<bool> m_showFile;
Show files elements
setShowFiles
+ void setShowFiles (bool _state);
Set the status of the displaying files or Not.
Parameter [input]: _state New state to apply on display the 'file'.
getShowFiles
+ bool getShowFiles () const;
Get the status of the displaying files or Not.
Return: The status on displaying the 'file'.
m_showFolder
# ewol::object::Param<bool> m_showFolder;
Display the folders elements
setShowFolder
+ void setShowFolder (bool _state);
Set the status of the displaying fodlers or Not.
Parameter [input]: _state New state to apply on display the 'folder'.
getShowFolder
+ bool getShowFolder () const;
Get the status of the displaying fodlers or Not.
Return: The status on displaying the 'folder'.
m_showHidden
# ewol::object::Param<bool> m_showHidden;
Display hidden elements
setShowHidden
+ void setShowHidden (bool _state);
Set the status of the displaying hidden files or folder or Not.
Parameter [input]: _state New state to apply on display the hidden element.
getShowHidden
+ bool getShowHidden () const;
Get the status of the displaying hidden files or folder or Not.
Return: The status on displaying the hidden element.
m_showTemporaryFile
# ewol::object::Param<bool> m_showTemporaryFile;
show the temporary files elements (XXX~, XXX.bck, XXX.pyc ...)
setShowTemporaryFiles
+ void setShowTemporaryFiles (bool _state);
Set the status of the displaying temporary file (xxx~, xxx.bck, xxx.pyc) or Not.
Parameter [input]: _state New state to apply on display temporary files.
getShowTemporaryFiles
+ bool getShowTemporaryFiles () const;
Get the status of the displaying temporary file (xxx~, xxx.bck, xxx.pyc) or Not.
Return: The status on displaying temporary files.
onParameterChangeValue
+ virtual void onParameterChangeValue (const ewol::object::ParameterRef & _paramPointer);
+std::enable_shared_from_this<Object>
+ewol::object::ParameterList
+ewol::object::SignalList
+--> +ewol::Object
+--> +ewol::Widget
+--> +ewol::widget::WidgetScrolled
+--> +ewol::widget::List
+--> ewol::widget::ListFileSystem
Detail:
signalFileSelect
+ ewol::object::Signal<std::string> signalFileSelect;
signalFileValidate
+ ewol::object::Signal<std::string> signalFileValidate;
signalFolderSelect
+ ewol::object::Signal<std::string> signalFolderSelect;
signalFolderValidate
+ ewol::object::Signal<std::string> signalFolderValidate;
ListFileSystem
# ListFileSystem ();
init
# void init ();
DECLARE_WIDGET_FACTORY
+ DECLARE_WIDGET_FACTORY (ListFileSystem ,
"ListFileSystem" );
~ListFileSystem
+ virtual ~ListFileSystem ();
m_colorProperty
# std::shared_ptr<ewol::resource::ColorFile> m_colorProperty;theme color property.
m_colorIdText
# int32_t m_colorIdText;Color of the text.
m_colorIdBackground1
# int32_t m_colorIdBackground1;Color of the Background.
m_colorIdBackground2
# int32_t m_colorIdBackground2;Color of the Background 2.
m_colorIdBackgroundSelected
# int32_t m_colorIdBackgroundSelected;Color of line selected.
getBasicBG
# virtual etk::Color<> getBasicBG ();
getNuberOfColomn
# virtual uint32_t getNuberOfColomn ();
getTitle
# virtual bool getTitle (int32_t _colomn,
std::string & _myTitle,
etk::Color<> & _fg,
etk::Color<> & _bg);
getNuberOfRaw
# virtual uint32_t getNuberOfRaw ();
getElement
# virtual bool getElement (int32_t _colomn,
int32_t _raw,
std::string & _myTextToWrite,
etk::Color<> & _fg,
etk::Color<> & _bg);
onItemEvent
# virtual bool onItemEvent (int32_t _IdInput,
enum ewol::key::status _typeEvent,
int32_t _colomn,
int32_t _raw,
float _x,
float _y);
m_list
# std::vector<etk::FSNode*> m_list;List of all element in the path. (they are filtered)
clearList
# void clearList ();Clean the list of element.
regenerateView
# virtual void regenerateView ();Regenerate the content of the view. this is actually not automation on the system update.
m_selectedLine
# int32_t m_selectedLine;Current Line ID that is selected
setSelect
+ virtual void setSelect (const std::string & _data);Select a specific file in the path
| Parameter [input]: | _data | File to selested. |
getSelect
+ std::string getSelect () const;Get the current selected file/folder/... in the list
| Return: | the String of the element selected. |
m_folder
# ewol::object::Param<std::string> m_folder;Current folder that display point on.
m_selectFile
# ewol::object::Param<std::string,true> m_selectFile;current selected file
setFolder
+ void setFolder (const std::string & _newFolder);Set a folder to display (might be a valid folder !!!)
| Parameter [input]: | _newFolder | Path on the folder to display content. |
getFolder
+ const std::string & getFolder () const;Get the element current displaying folder path.
| Return: | Path on the folder. |
m_showFile
# ewol::object::Param<bool> m_showFile;Show files elements
setShowFiles
+ void setShowFiles (bool _state);Set the status of the displaying files or Not.
| Parameter [input]: | _state | New state to apply on display the 'file'. |
getShowFiles
+ bool getShowFiles () const;Get the status of the displaying files or Not.
| Return: | The status on displaying the 'file'. |
m_showFolder
# ewol::object::Param<bool> m_showFolder;Display the folders elements
setShowFolder
+ void setShowFolder (bool _state);Set the status of the displaying fodlers or Not.
| Parameter [input]: | _state | New state to apply on display the 'folder'. |
getShowFolder
+ bool getShowFolder () const;Get the status of the displaying fodlers or Not.
| Return: | The status on displaying the 'folder'. |
m_showHidden
# ewol::object::Param<bool> m_showHidden;Display hidden elements
setShowHidden
+ void setShowHidden (bool _state);Set the status of the displaying hidden files or folder or Not.
| Parameter [input]: | _state | New state to apply on display the hidden element. |
getShowHidden
+ bool getShowHidden () const;Get the status of the displaying hidden files or folder or Not.
| Return: | The status on displaying the hidden element. |
m_showTemporaryFile
# ewol::object::Param<bool> m_showTemporaryFile;show the temporary files elements (XXX~, XXX.bck, XXX.pyc ...)
setShowTemporaryFiles
+ void setShowTemporaryFiles (bool _state);Set the status of the displaying temporary file (xxx~, xxx.bck, xxx.pyc) or Not.
| Parameter [input]: | _state | New state to apply on display temporary files. |
getShowTemporaryFiles
+ bool getShowTemporaryFiles () const;Get the status of the displaying temporary file (xxx~, xxx.bck, xxx.pyc) or Not.
| Return: | The status on displaying temporary files. |
onParameterChangeValue
+ virtual void onParameterChangeValue (const ewol::object::ParameterRef & _paramPointer);