X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FEvents%2FEvents_Error.h;h=561c987ce141be705eb03dc88f7b049babde742b;hb=04124521e59cba192ade65e98667188393ced5e4;hp=d3222a28e1ffb5566d4d1a72761c86b283ba3108;hpb=7bf19255421b34594c7b0a76d0ce28166d0ce895;p=modules%2Fshaper.git diff --git a/src/Events/Events_Error.h b/src/Events/Events_Error.h index d3222a28e..561c987ce 100644 --- a/src/Events/Events_Error.h +++ b/src/Events/Events_Error.h @@ -15,19 +15,32 @@ #include +/**\class Events_Error + * \ingroup EventsLoop + * \brief An error message event. + * + * Is generated by any algorithm or GUI of the application to inform the user about + * the problem. In GUI mode all such errors are collected in the message log window. + */ class EVENTS_EXPORT Events_Error : public Events_Message { char* myDescription; ///< pointer to the description of the error - public: +public: + /// default destructor virtual ~Events_Error(); + /// Identifier of this event (one for all errors) static Events_ID errorID(); + /// Specific error string char* description() const; + /// Allows to send an error quickly: it creates and sends the error object automatically static void send(char* theDescription, const void* theSender = 0); + /// Allows to send an error quickly: it creates and sends the error object automatically static void send(std::string theDescription, const void* theSender = 0); - protected: +protected: + /// Default constructor. Use "send" message for generation an error. Events_Error(char* theDescription, const void* theSender = 0); };