X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FXGUI%2FXGUI_Tools.h;h=1a5c7b05f2b2103dc91e33dcc25025ef9a47742f;hb=ed67f7abf2985c7225b7862c076257825a421993;hp=d20260f8e3046847cc6d0b53c51f0f1e021e2190;hpb=057e426145a26c02a1c5d6e1c220f92a17d8e53d;p=modules%2Fshaper.git diff --git a/src/XGUI/XGUI_Tools.h b/src/XGUI/XGUI_Tools.h index d20260f8e..1a5c7b05f 100644 --- a/src/XGUI/XGUI_Tools.h +++ b/src/XGUI/XGUI_Tools.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D --> + #ifndef XGUI_Tools_H #define XGUI_Tools_H @@ -5,11 +7,12 @@ #include #include -#include +#include + +#include -class TopoDS_Shape; -class ModelAPI_Feature; /*! + \ingroup GUI \brief Return directory part of the file path. If the file path does not include directory part (the file is in the @@ -19,58 +22,49 @@ class ModelAPI_Feature; \param abs if true (default) \a path parameter is treated as absolute file path \return directory part of the file path */ -namespace XGUI_Tools -{ - QString XGUI_EXPORT dir(const QString& path, bool isAbs = true); - - /*! - \brief Return file name part of the file path. - - \param path file path - \param withExt if true (default) complete file name (with all - extension except the last) is returned, otherwise only base name - is returned - \return file name part of the file path - */ - QString XGUI_EXPORT file(const QString& path, bool withExt = true); - - /*! - \brief Return extension part of the file path. - - \param path file path - \param full if true complete extension (all extensions, dot separated) - is returned, otherwise (default) only last extension is returned - \return extension part of the file path - */ - QString XGUI_EXPORT extension(const QString& path, bool full = false); - - /*! - \brief Add a slash (platform-specific) to the end of \a path - if it is not already there. - \param path directory path - \return modified path (with slash added to the end) - */ - QString XGUI_EXPORT addSlash(const QString& path); - - /*! - Creates a rect with TopLeft = ( min(x1,x2), min(y1,y2) ) - and BottomRight = ( TopLeft + (x2-x1)(y2-y1) ) - */ - QRect XGUI_EXPORT makeRect(const int x1, const int y1, const int x2, const int y2); - - /// The model concerning tools - - /*! - Returns true if the feature is a model object - \param theFeature a feature - */ - bool XGUI_EXPORT isModelObject(boost::shared_ptr theFeature); - - /*! - Returns the string presentation of the given feature - \param theFeature a feature - */ - std::string XGUI_EXPORT featureInfo(boost::shared_ptr theFeature); -} +namespace XGUI_Tools { + +/** +* Returns directory name from name of file +* \param path a path to a file +* \param isAbs is absolute or relative path +*/ +QString XGUI_EXPORT dir(const QString& path, bool isAbs = true); + +/*! + \brief Return file name part of the file path. + + \param path file path + \param withExt if true (default) complete file name (with all + extension except the last) is returned, otherwise only base name + is returned + \return file name part of the file path + */ +QString XGUI_EXPORT file(const QString& path, bool withExt = true); + +/*! + \brief Add a slash (platform-specific) to the end of \a path + if it is not already there. + \param path directory path + \return modified path (with slash added to the end) + */ +QString XGUI_EXPORT addSlash(const QString& path); + +/// The model concerning tools + +/*! + Returns true if the feature is a model object + \param theFeature a feature + */ +bool XGUI_EXPORT isModelObject(FeaturePtr theFeature); + +/*! + Returns the string presentation of the given feature + \param theFeature a feature + */ +std::string XGUI_EXPORT featureInfo(FeaturePtr theFeature); + + +}; #endif