Merge branch 'Dev_1.2.0' of newgeom:newgeom into Dev_1.2.0

[modules/shaper.git] / src / XGUI / XGUI_Tools.h

diff --git a/src/XGUI/XGUI_Tools.h b/src/XGUI/XGUI_Tools.h
index e8e3495e8225d186d5fb8dc96cffb71f085af781..1a5c7b05f2b2103dc91e33dcc25025ef9a47742f 100644 (file)
--- 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,20 +7,12 @@
 #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.
-
- \param str short library name
- \return full library name
- */
-QString XGUI_EXPORT library(const QString& str);
+#include <memory>
 
 /*!
+ \ingroup GUI
  \brief Return directory part of the file path.
 
  If the file path does not include directory part (the file is in the
@@ -28,6 +22,13 @@ QString XGUI_EXPORT library(const QString& str);
  \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 XGUI_EXPORT dir(const QString& path, bool isAbs = true);
 
 /*!
@@ -41,16 +42,6 @@ QString XGUI_EXPORT dir(const QString& path, bool isAbs = true);
  */
 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.
@@ -59,10 +50,21 @@ QString XGUI_EXPORT extension(const QString& path, bool full = false);
  */
 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) )    
+/// 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
  */
-QRect XGUI_EXPORT makeRect(const int x1, const int y1, const int x2, const int y2);
+std::string XGUI_EXPORT featureInfo(FeaturePtr theFeature);
+
+
+};
 
 #endif