X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FcreaDevManagerLib%2FmodelCDMFile.h;h=e1908a3bbc18086206c0921d527cbc3c6d07efb6;hb=78a3d08edf8e9b8b11ba87c5a6a4f9211ae107d3;hp=228447f661a09aa42e3b7f39a4981908ec86b49e;hpb=609d8d48cae96384e664ec6b000e8ecfcbad6459;p=crea.git diff --git a/lib/creaDevManagerLib/modelCDMFile.h b/lib/creaDevManagerLib/modelCDMFile.h index 228447f..e1908a3 100644 --- a/lib/creaDevManagerLib/modelCDMFile.h +++ b/lib/creaDevManagerLib/modelCDMFile.h @@ -40,15 +40,47 @@ #include "modelCDMIProjectTreeNode.h" +/** + * Class representing a file node in the project hierarchy. + */ class modelCDMFile : public modelCDMIProjectTreeNode { public: + /** + * Default constructor + */ modelCDMFile(); - modelCDMFile(const std::string& path, const int& level = 3); + /** + * Constructor of the File node class + * @param parent Parent node of the file node. + * @param path Full path to the file node + * @param name File name of the file node. + * @param level Hierarchy level of the file node. By default 3. + */ + modelCDMFile(modelCDMIProjectTreeNode* parent, const std::string& path, const std::string& name, const int& level = 3); + /** + * Destructor + */ ~modelCDMFile(); + /** + * Opens the file node with the provided command. + * @param result Result message of the operation. + * @param command Command to open the file. + * @return True if the operation was successful. + */ bool OpenFile(std::string* & result, const std::string& command = ""); + /** + * Refreshes the file properties and checks that the file exists. + * @param result Result message of the operation. + * @return True if the operation was successful. + */ virtual const bool Refresh(std::string*& result); + /** + * Opens the file node in the default file explorer. + * @param result Result message of the operation. + * @return True if the operation was successful. + */ const bool OpenInFileExplorer(std::string*& result) const; };