[beast/devel: 40/77] BSE: add Bse::Server::user_message(UserMessage) to send messages to UI

[Tim Janik <timj src gnome org>]

commit f7df55bb60e87c9a96c309c558d142382bcdf1ef
Author: Tim Janik <timj gnu org>
Date:   Tue Apr 9 02:16:39 2013 +0200

    BSE: add Bse::Server::user_message(UserMessage) to send messages to UI

 bse/bseapi.idl |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)
---
diff --git a/bse/bseapi.idl b/bse/bseapi.idl
index 5ab21c4..0206d4a 100644
--- a/bse/bseapi.idl
+++ b/bse/bseapi.idl
@@ -12,11 +12,29 @@ interface TestObject {
   signal void   echo_reply      (String msg);           ///< Signal emitted in response to echo_test().
 };
 
+enum UserMessageType {
+  ERROR = 1,    ///< Indicate a message about an error condition.
+  WARNING,      ///< Indicate a message about a possibly harmful condition.
+  INFO,         ///< Indicate an informational message.
+  DEBUG,        ///< Indicate a debugging message (usually insignificant).
+};
+
+/// Structure for submission of user interface messages from BSE.
+record UserMessage {
+  UserMessageType type;         ///< Severity classification for this message.
+  String          title;        ///< Usually GUI window title.
+  String          text1;        ///< Primary message to the user, should be limited to 80-100 chars.
+  String          text2;        ///< Explanatory (secondary) message no limitations recommended.
+  String          text3;        ///< Possibly (technical) details or machine error message.
+  String          label;        ///< Message class label, used to enable/disable this type of message.
+};
+
 /** Main Bse remote origin object.
  * The Bse::Server object controls the main BSE thread and keeps track of all objects
  * used in the BSE context.
  */
 interface Server {
+  signal void   user_message    (UserMessage umsg);     ///< Notification signal for user messages from BSE.
   TestObject    get_test_object () = 0;                 ///< Retrieve object for API, signal, etc tests.
 };