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 e60684c753eb711e2515c46313776f0c88cd4658..1a5c7b05f2b2103dc91e33dcc25025ef9a47742f 100644 (file)
@@ -1,23 +1,18 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 #ifndef XGUI_Tools_H
 #define XGUI_Tools_H
 
 #ifndef XGUI_Tools_H
 #define XGUI_Tools_H
 
+#include "XGUI.h"
 #include <QString>
 #include <QRect>
 
 #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 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
  \brief Return directory part of the file path.
 
  If the file path does not include directory part (the file is in the
@@ -27,7 +22,14 @@ QString 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
  */
  \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);
+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.
 
 /*!
  \brief Return file name part of the file path.
@@ -38,17 +40,7 @@ QString dir(const QString& path, bool isAbs = true);
  is returned
  \return file name part of the file path
  */
  is returned
  \return file name part of the file path
  */
-QString 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 extension(const QString& path, bool full = false);
+QString XGUI_EXPORT file(const QString& path, bool withExt = true);
 
 /*!
  \brief Add a slash (platform-specific) to the end of \a path
 
 /*!
  \brief Add a slash (platform-specific) to the end of \a path
@@ -56,12 +48,23 @@ QString extension(const QString& path, bool full = false);
  \param path directory path
  \return modified path (with slash added to the end)
  */
  \param path directory path
  \return modified path (with slash added to the end)
  */
-QString addSlash(const QString& path);
+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);
 
 
-/*! 
- Creates a rect with TopLeft = ( min(x1,x2), min(y1,y2) )
- and BottomRight = ( TopLeft + (x2-x1)(y2-y1) )    
+/*!
+ Returns the string presentation of the given feature
+ \param theFeature a feature
  */
  */
-QRect makeRect(const int x1, const int y1, const int x2, const int y2);
+std::string XGUI_EXPORT featureInfo(FeaturePtr theFeature);
+
+
+};
 
 #endif
 
 #endif