src/XGUI/XGUI_Tools.h

   1 #ifndef XGUI_Tools_H
   2 #define XGUI_Tools_H
   3
   4 #include "XGUI.h"
   5 #include <QString>
   6 #include <QRect>
   7
   8 #include <boost/shared_ptr.hpp>
   9
  10 class TopoDS_Shape;
  11 class ModelAPI_Feature;
  12 /*!
  13  \brief Return directory part of the file path.
  14
  15  If the file path does not include directory part (the file is in the
  16  current directory), null string is returned.
  17
  18  \param path file path
  19  \param abs if true (default) \a path parameter is treated as absolute file path
  20  \return directory part of the file path
  21  */
  22 namespace XGUI_Tools
  23 {
  24   QString XGUI_EXPORT dir(const QString& path, bool isAbs = true);
  25
  26   /*!
  27    \brief Return file name part of the file path.
  28
  29    \param path file path
  30    \param withExt if true (default) complete file name (with all
  31    extension except the last) is returned, otherwise only base name
  32    is returned
  33    \return file name part of the file path
  34    */
  35   QString XGUI_EXPORT file(const QString& path, bool withExt = true);
  36
  37   /*!
  38    \brief Return extension part of the file path.
  39
  40    \param path file path
  41    \param full if true complete extension (all extensions, dot separated)
  42    is returned, otherwise (default) only last extension is returned
  43    \return extension part of the file path
  44    */
  45   QString XGUI_EXPORT extension(const QString& path, bool full = false);
  46
  47   /*!
  48    \brief Add a slash (platform-specific) to the end of \a path
  49    if it is not already there.
  50    \param path directory path
  51    \return modified path (with slash added to the end)
  52    */
  53   QString XGUI_EXPORT addSlash(const QString& path);
  54
  55   /*!
  56    Creates a rect with TopLeft = ( min(x1,x2), min(y1,y2) )
  57    and BottomRight = ( TopLeft + (x2-x1)(y2-y1) )
  58    */
  59   QRect XGUI_EXPORT makeRect(const int x1, const int y1, const int x2, const int y2);
  60
  61   /// The model concerning tools
  62
  63   /*!
  64    Returns true if the feature is a model object
  65    \param theFeature a feature
  66   */
  67   bool XGUI_EXPORT isModelObject(boost::shared_ptr<ModelAPI_Feature> theFeature);
  68
  69   /*!
  70    Returns the string presentation of the given feature
  71    \param theFeature a feature
  72   */
  73   std::string XGUI_EXPORT featureInfo(boost::shared_ptr<ModelAPI_Feature> theFeature);
  74 }
  75
  76 #endif