Salome HOME
Merge branch 'Dev_1.2.0' of newgeom:newgeom into Dev_1.2.0
[modules/shaper.git] / src / XGUI / XGUI_Tools.h
index 0fe6b2f5ae080056ee526b8089bd66e3fd7d03a1..1a5c7b05f2b2103dc91e33dcc25025ef9a47742f 100644 (file)
@@ -1,63 +1,70 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
 
 #ifndef XGUI_Tools_H
 #define XGUI_Tools_H
 
+#include "XGUI.h"
 #include <QString>
+#include <QRect>
 
-/*!
-  \brief Convert the given parameter to the platform-specific library name.
+#include <ModelAPI_Feature.h>
 
-  The function appends platform-specific prefix (lib) and suffix (.dll/.so)
-  to the library file name.
-  For example, if \a str = "mylib", "libmylib.so" is returned for Linux and
-  mylib.dll for Windows.
+#include <memory>
 
-  \param str short library name
-  \return full library name
+/*!
+ \ingroup GUI
+ \brief Return directory part of the file path.
+
+ If the file path does not include directory part (the file is in the
+ current directory), null string is returned.
+
+ \param path file path
+ \param abs if true (default) \a path parameter is treated as absolute file path
+ \return directory part of the file path
+ */
+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 library( const QString& str );
+QString XGUI_EXPORT dir(const QString& path, bool isAbs = true);
 
 /*!
-  \brief Return directory part of the file path.
-
-  If the file path does not include directory part (the file is in the
-  current directory), null string is returned.
-
-  \param path file path
-  \param abs if true (default) \a path parameter is treated as absolute file path
-  \return directory part of the file path
-*/
-QString 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 file name part of the file path.
+ \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);
 
-  \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 file( const QString& path, bool withExt = true );
+/// The model concerning tools
 
 /*!
-  \brief Return extension part of the file path.
+ Returns true if the feature is a model object
+ \param theFeature a feature
+ */
+bool XGUI_EXPORT isModelObject(FeaturePtr theFeature);
 
-  \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 extension( const QString& path, bool full = false );
+/*!
+ Returns the string presentation of the given feature
+ \param theFeature a feature
+ */
+std::string XGUI_EXPORT featureInfo(FeaturePtr theFeature);
 
 
-/*!
-  \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 addSlash( const QString& path );
+};
 
-#endif
\ No newline at end of file
+#endif