0031189: Draw Harness, ViewerTest - send messages to Message::DefaultMessenger()
[occt.git] / src / Message / Message.hxx
index 4be7113..19ec2d8 100644 (file)
 #ifndef _Message_HeaderFile
 #define _Message_HeaderFile
 
-#include <Standard.hxx>
-#include <Standard_DefineAlloc.hxx>
-#include <Standard_Handle.hxx>
-
-#include <Standard_Integer.hxx>
-#include <Standard_Real.hxx>
-class Message_Messenger;
-class TCollection_AsciiString;
-class Message_Msg;
-class Message_MsgFile;
-class Message_Messenger;
-class Message_Algorithm;
-class Message_Printer;
-class Message_PrinterOStream;
-class Message_ProgressIndicator;
-class Message_ProgressScale;
-class Message_ProgressSentry;
-
+#include <Message_Messenger.hxx>
 
 //! Defines
 //! - tools to work with messages
 //! - basic tools intended for progress indication
-class Message 
+class Message
 {
 public:
 
   DEFINE_STANDARD_ALLOC
 
-  
   //! Defines default messenger for OCCT applications.
   //! This is global static instance of the messenger.
   //! By default, it contains single printer directed to std::cout.
   //! It can be customized according to the application needs.
+  //!
+  //! The following syntax can be used to print messages:
+  //! @begincode
+  //!   Message::DefaultMessenger()->Send ("My Warning", Message_Warning);
+  //!   Message::SendWarning ("My Warning"); // short-cut for Message_Warning
+  //!   Message::SendWarning() << "My Warning with " << theCounter << " arguments";
+  //!   Message::SendFail ("My Failure"); // short-cut for Message_Fail
+  //! @endcode
   Standard_EXPORT static const Handle(Message_Messenger)& DefaultMessenger();
-  
+
+public:
+  //!@name Short-cuts to DefaultMessenger
+
+  static Message_Messenger::StreamBuffer Send(Message_Gravity theGravity)
+  {
+    return DefaultMessenger()->Send (theGravity);
+  }
+
+  static void Send(const TCollection_AsciiString& theMessage, Message_Gravity theGravity)
+  {
+    DefaultMessenger()->Send (theMessage, theGravity);
+  }
+
+  static Message_Messenger::StreamBuffer SendFail()    { return DefaultMessenger()->SendFail ();    }
+  static Message_Messenger::StreamBuffer SendAlarm()   { return DefaultMessenger()->SendAlarm ();   }
+  static Message_Messenger::StreamBuffer SendWarning() { return DefaultMessenger()->SendWarning (); }
+  static Message_Messenger::StreamBuffer SendInfo()    { return DefaultMessenger()->SendInfo ();    }
+  static Message_Messenger::StreamBuffer SendTrace()   { return DefaultMessenger()->SendTrace ();   }
+
+  static void SendFail    (const TCollection_AsciiString& theMessage) { return DefaultMessenger()->SendFail    (theMessage); }
+  static void SendAlarm   (const TCollection_AsciiString& theMessage) { return DefaultMessenger()->SendAlarm   (theMessage); }
+  static void SendWarning (const TCollection_AsciiString& theMessage) { return DefaultMessenger()->SendWarning (theMessage); }
+  static void SendInfo    (const TCollection_AsciiString& theMessage) { return DefaultMessenger()->SendInfo    (theMessage); }
+  static void SendTrace   (const TCollection_AsciiString& theMessage) { return DefaultMessenger()->SendTrace   (theMessage); }
+
+public:
+
   //! Returns the string filled with values of hours, minutes and seconds.
   //! Example:
   //! 1. (5, 12, 26.3345) returns "05h:12m:26.33s",
@@ -59,36 +76,6 @@ public:
   //! 3. (0,  0,  4.5   ) returns "4.50s"
   Standard_EXPORT static TCollection_AsciiString FillTime (const Standard_Integer Hour, const Standard_Integer Minute, const Standard_Real Second);
 
-
-
-
-protected:
-
-
-
-
-
-private:
-
-
-
-
-friend class Message_Msg;
-friend class Message_MsgFile;
-friend class Message_Messenger;
-friend class Message_Algorithm;
-friend class Message_Printer;
-friend class Message_PrinterOStream;
-friend class Message_ProgressIndicator;
-friend class Message_ProgressScale;
-friend class Message_ProgressSentry;
-
 };
 
-
-
-
-
-
-
 #endif // _Message_HeaderFile