/usr/include/oce/Message_ProgressSentry.hxx is in liboce-foundation-dev 0.15-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 | // This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to
// this header file considered to be the "object code" form of the original source.
#ifndef _Message_ProgressSentry_HeaderFile
#define _Message_ProgressSentry_HeaderFile
#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineAlloc_HeaderFile
#include <Standard_DefineAlloc.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif
#ifndef _Handle_Message_ProgressIndicator_HeaderFile
#include <Handle_Message_ProgressIndicator.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Handle_TCollection_HAsciiString_HeaderFile
#include <Handle_TCollection_HAsciiString.hxx>
#endif
class Message_ProgressIndicator;
class TCollection_HAsciiString;
//! This class is a tool allowing to manage opening/closing <br>
//! scopes in the ProgressIndicator in convenient and safe way. <br>
//! <br>
//! Its main features are: <br>
//! - Set all parameters for the current scale on the given <br>
//! ProgressIndicator and open a new scope at one line <br>
//! - Iterator-like interface to opening next scopes and <br>
//! check for user break <br>
//! - Automatic scope closing in destructor <br>
//! - Safe for NULL ProgressIndicator (just does nothing) <br>
class Message_ProgressSentry {
public:
DEFINE_STANDARD_ALLOC
Standard_EXPORT Message_ProgressSentry(const Handle(Message_ProgressIndicator)& PI,const Standard_CString name,const Standard_Real min,const Standard_Real max,const Standard_Real step,const Standard_Boolean isInf = Standard_False,const Standard_Real newScopeSpan = 0.0);
//! Creates an instance of ProgressSentry attaching it to <br>
//! the specified ProgressIndicator, selects parameters of <br>
//! the current scale, and opens a new scope with specified <br>
//! span (equal to step by default) <br>
Standard_EXPORT Message_ProgressSentry(const Handle(Message_ProgressIndicator)& PI,const Handle(TCollection_HAsciiString)& name,const Standard_Real min,const Standard_Real max,const Standard_Real step,const Standard_Boolean isInf = Standard_False,const Standard_Real newScopeSpan = 0.0);
//! Moves progress indicator to the end of the current scale <br>
//! and relieves sentry from its duty. Methods other than Show() <br>
//! will do nothing after this one is called. <br>
void Relieve() ;
~Message_ProgressSentry()
{
Relieve();
}
void Next(const Standard_CString name = 0) const;
void Next(const Standard_Real span,const Standard_CString name = 0) const;
//! Closes current scope and opens next one <br>
//! with either specified or default span <br>
void Next(const Standard_Real span,const Handle(TCollection_HAsciiString)& name) const;
//! Returns False if ProgressIndicator signals UserBreak <br>
Standard_Boolean More() const;
//! Forces update of progress indicator display <br>
void Show() const;
protected:
private:
Handle_Message_ProgressIndicator myProgress;
Standard_Boolean myActive;
};
#include <Message_ProgressSentry.lxx>
// other Inline functions and methods (like "C++: function call" methods)
#endif
|