Issue #394 Undo-ing a Sketch element

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

diff --git a/src/XGUI/XGUI_Tools.h b/src/XGUI/XGUI_Tools.h
index fa1c78af5652a8760b24c5639f76099e8d8a08bb..7db64558ac26448911c1dd19bbbf343af1116f1f 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
 
 #ifndef XGUI_Tools_H
 #define XGUI_Tools_H
 


@@ -7,10 +9,10 @@
 
 #include <ModelAPI_Feature.h>
 
 
 #include <ModelAPI_Feature.h>
 

-#include <boost/shared_ptr.hpp>
+#include <memory>

 
 

-class TopoDS_Shape;

 /*!
 /*!

+ \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


@@ -20,63 +22,47 @@ class TopoDS_Shape;
  \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
  */

-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.
+namespace XGUI_Tools {

 
 

-   \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);
+/**
+* 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 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);
+/*!
+ \brief Return file name part of the file 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);
+ \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);

 
 

-  /// The model concerning tools
+/*!
+ \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);

 
 

-  /*!
-   Returns true if the feature is a model object
-   \param theFeature a feature
-  */
-  bool XGUI_EXPORT isModelObject(FeaturePtr theFeature);
+/// The model concerning tools

 
 

-  /*!
-   Returns the string presentation of the given feature
-   \param theFeature a feature
-  */
-  std::string XGUI_EXPORT featureInfo(FeaturePtr theFeature);
+/*!
+ Returns true if the feature is a model object
+ \param theFeature a feature
+ */
+bool XGUI_EXPORT isModelObject(FeaturePtr theFeature);

 
 

-  /**
-  * Returns pointer on real feature
-  */
-  FeaturePtr realFeature(const FeaturePtr theFeature);
+/*!
+ Returns the string presentation of the given feature
+ \param theFeature a feature
+ */
+std::string XGUI_EXPORT featureInfo(FeaturePtr theFeature);

 }
 
 #endif
 }
 
 #endif