tizen_src/ewk/efl_integration/public/ewk_console_message_internal.h

   1 // Copyright 2014 Samsung Electronics. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /**
   6  * @file    ewk_console_message_internal.h
   7  * @brief   Describes the Console Message API.
   8  */
   9
  10 #ifndef ewk_console_message_internal_h
  11 #define ewk_console_message_internal_h
  12
  13 #include <Eina.h>
  14 #include <tizen.h>
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 /** Creates a type name for @a _Ewk_Console_Message. */
  21 typedef struct _Ewk_Console_Message Ewk_Console_Message;
  22
  23 /// Creates a type name for Ewk_Console_Message_Level.
  24 typedef enum {
  25     EWK_CONSOLE_MESSAGE_LEVEL_NULL,
  26     EWK_CONSOLE_MESSAGE_LEVEL_LOG,
  27     EWK_CONSOLE_MESSAGE_LEVEL_WARNING,
  28     EWK_CONSOLE_MESSAGE_LEVEL_ERROR,
  29     EWK_CONSOLE_MESSAGE_LEVEL_DEBUG,
  30     EWK_CONSOLE_MESSAGE_LEVEL_INFO,
  31 } Ewk_Console_Message_Level;
  32
  33 /**
  34  * Returns the log severity of the console message from the Console Message object
  35  *
  36  * @param message console message object
  37  *
  38  * @return Ewk_Console_Message_Level indicating the console message level,
  39            LogMessageLevel = 1,
  40            WarningMessageLevel = 2,
  41            ErrorMessageLevel = 3,
  42            DebugMessageLevel = 4,
  43            InfoMessageLevel = 5
  44  */
  45 EXPORT_API Ewk_Console_Message_Level ewk_console_message_level_get(const Ewk_Console_Message *message);
  46
  47 /**
  48  * Returns the console message text from the Console Message object
  49  *
  50  * @param message console message object
  51  *
  52  * @return console message text on success or empty string on failure
  53  */
  54 EXPORT_API Eina_Stringshare* ewk_console_message_text_get(const Ewk_Console_Message *message);
  55
  56 /**
  57  * Returns line no of the console message from the Console Message object
  58  *
  59  * @param message console message object
  60  *
  61  * @return the line number of the message on success or 0 on failure
  62  */
  63 EXPORT_API unsigned ewk_console_message_line_get(const Ewk_Console_Message *message);
  64
  65 /**
  66  * Returns the source of the console message from the Console Message object
  67  *
  68  * @param message console message object
  69  *
  70  * @return source of the console message on success or empty string on failure
  71  */
  72 EXPORT_API Eina_Stringshare* ewk_console_message_source_get(const Ewk_Console_Message *message);
  73
  74 #ifdef __cplusplus
  75 }
  76 #endif
  77
  78 #endif // ewk_console_message_internal_h