0031939: Coding - correction of spelling errors in comments [part 2]
[occt.git] / tools / View / View_PreviewParameters.hxx
1 // Created on: 2020-01-25
2 // Created by: Natalia ERMOLAEVA
3 // Copyright (c) 2020 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement. 
15
16 #ifndef View_PreviewParameters_H
17 #define View_PreviewParameters_H
18
19 #include <Standard.hxx>
20 #include <Standard_Macro.hxx>
21
22 #include <Prs3d_Drawer.hxx>
23
24 #include <Standard_WarningsDisable.hxx>
25 #include <QMap>
26 #include <QString>
27 #include <Standard_WarningsRestore.hxx>
28
29 //! \class View_PreviewParameters
30 //! Container of View tool bar actions
31 class View_PreviewParameters
32 {
33 public:
34
35   //! Constructor
36   Standard_EXPORT View_PreviewParameters ();
37
38   //! Destructor
39   virtual ~View_PreviewParameters() {}
40
41   //! Returns main control
42   const Handle(Prs3d_Drawer)& GetDrawer() const { return myDrawer; }
43
44   //! Saves state of preview parameters in a container in form: key, value. It saves:
45   //! - visibility of columns,
46   //! - columns width
47   //! \param theTreeView a view instance
48   //! \param theItems [out] properties
49   //! \param thePrefix preference item prefix
50   static void SaveState (View_PreviewParameters* theParameters,
51                          QMap<QString, QString>& theItems,
52                          const QString& thePrefix = QString())
53   { (void)theParameters; (void)theItems; (void)thePrefix; }
54
55   //! Restores state of preview parameters by a container
56   //! \param theTreeView a view instance
57   //! \param theKey property key
58   //! \param theValue property value
59   //! \param thePrefix preference item prefix
60   //! \return boolean value whether the property is applied to the tree view
61   static bool RestoreState (View_PreviewParameters* theParameters,
62                             const QString& theKey, const QString& theValue,
63                             const QString& thePrefix = QString())
64   { (void)theParameters; (void)theKey; (void)theValue; (void)thePrefix; return false; }
65
66 private:
67
68   Handle(Prs3d_Drawer) myDrawer; //!< attributes for preview presentation
69 };
70
71 #endif