226. Report

Messages handling

226.1. Summary of Module Globals

List of Global Functions

  • AnyQuestion - Question with headline and Yes/No Buttons

  • ClearAll - Clear all stored messages (errors, messages and warnings)

  • ClearErrors - Clear stored errors

  • ClearMessages - Clear stored messages

  • ClearWarnings - Clear stored warnings

  • ClearYesNoMessages - Clear stored yes/no messages

  • DisplayErrors - Error popup dialog can displayed immediately when new error is stored.

  • DisplayMessages - Message popup dialog can be displayed immediately when a new message is stored.

  • DisplayWarnings - Warning popup dialog can displayed immediately when new warningr is stored.

  • DisplayYesNoMessages - Yes/No Message popup dialog can be displayed immediately when a new message is stored.

  • Error - Store new error text

  • Export - Dump the Report settings to a map, for autoinstallation use.

  • GetMessages - Create rich text string from stored warning, message or error messages.

  • GetModified - Functions which returns if the settings were modified

  • Import - Get all the Report configuration from a map.

  • LogErrors - Set warnings logging to .y2log file

  • LogMessages - Set messages logging to .y2log file

  • LogWarnings - Set warnings logging to .y2log file

  • LogYesNoMessages - Set yes/no messages logging to .y2log file

  • LongError - Store new error text, the text is displayed in a richtext widget - long lines are automatically wrapped

  • LongMessage - Store new message text, the text is displayed in a richtext widget - long lines are automatically wrapped

  • LongWarning - Store new warning text, the text is displayed in a richtext widget - long lines are automatically wrapped

  • Message - Store new message text

  • NumErrors - Return number of stored errors

  • NumMessages - Return number of stored messages

  • NumWarnings - Return number of stored warnings

  • NumYesNoMessages - Return number of stored yes/no messages

  • SetModified - Function sets internal variable, which indicates, that any settings were modified, to "true"

  • ShowText - Store new message text

  • Summary - Summary of current settings

  • Warning - Store new warning text

List of Global Variables

    226.2. Global Functions

    226.2.1. AnyQuestion

    Question with headline and Yes/No Buttons

    Function parameters

    • string headline

    • string message

    • string yes_button_message

    • string no_button_message

    • symbol focus

    Return value

    • boolean - True if Yes is pressed, otherwise false

    226.2.2. ClearAll

    Clear all stored messages (errors, messages and warnings)

    Return value

    • void

    226.2.3. ClearErrors

    Clear stored errors

    Return value

    • void

    226.2.4. ClearMessages

    Clear stored messages

    Return value

    • void

    226.2.5. ClearWarnings

    Clear stored warnings

    Return value

    • void

    226.2.6. ClearYesNoMessages

    Clear stored yes/no messages

    Return value

    • void

    226.2.7. DisplayErrors

    Error popup dialog can displayed immediately when new error is stored.

    Function parameters

    • boolean display

    • integer timeout

    Return value

    • void

    226.2.8. DisplayMessages

    Message popup dialog can be displayed immediately when a new message is stored.

    Function parameters

    • boolean display

    • integer timeout

    Return value

    • void

    226.2.9. DisplayWarnings

    Warning popup dialog can displayed immediately when new warningr is stored.

    Function parameters

    • boolean display

    • integer timeout

    Return value

    • void

    226.2.10. DisplayYesNoMessages

    Yes/No Message popup dialog can be displayed immediately when a new message is stored.

    Function parameters

    • boolean display

    • integer timeout

    Return value

    • void

    226.2.11. Error

    Store new error text

    Function parameters

    • string error_string

    Return value

    • void

    226.2.12. Export

    Dump the Report settings to a map, for autoinstallation use.

    Return value

    • map - Map with settings

    226.2.13. GetMessages

    Create rich text string from stored warning, message or error messages.

    Function parameters

    • boolean w

    • boolean e

    • boolean m

    • boolean ynm

    Return value

    • string - rich text string

    226.2.14. GetModified

    Functions which returns if the settings were modified

    Return value

    • boolean - settings were modified

    226.2.15. Import

    Get all the Report configuration from a map.

    Function parameters

    • map settings

    Return value

    • boolean - success

    226.2.16. LogErrors

    Set warnings logging to .y2log file

    Function parameters

    • boolean log

    Return value

    • void

    226.2.17. LogMessages

    Set messages logging to .y2log file

    Function parameters

    • boolean log

    Return value

    • void

    226.2.18. LogWarnings

    Set warnings logging to .y2log file

    Function parameters

    • boolean log

    Return value

    • void

    226.2.19. LogYesNoMessages

    Set yes/no messages logging to .y2log file

    Function parameters

    • boolean log

    Return value

    • void

    226.2.20. LongError

    Store new error text, the text is displayed in a richtext widget - long lines are automatically wrapped

    Function parameters

    • string error_string

    Return value

    • void

    226.2.21. LongMessage

    Store new message text, the text is displayed in a richtext widget - long lines are automatically wrapped

    Function parameters

    • string message_string

    Return value

    • void

    226.2.22. LongWarning

    Store new warning text, the text is displayed in a richtext widget - long lines are automatically wrapped

    Function parameters

    • string warning_string

    Return value

    • void

    226.2.23. Message

    Store new message text

    Function parameters

    • string message_string

    Return value

    • void

    226.2.24. NumErrors

    Return number of stored errors

    Return value

    • integer - number of errors

    226.2.25. NumMessages

    Return number of stored messages

    Return value

    • integer - number of messages

    226.2.26. NumWarnings

    Return number of stored warnings

    Return value

    • integer - number of warnings

    226.2.27. NumYesNoMessages

    Return number of stored yes/no messages

    Return value

    • integer - number of messages

    226.2.28. SetModified

    Function sets internal variable, which indicates, that any settings were modified, to "true"

    Return value

    • void

    226.2.29. ShowText

    Store new message text

    Function parameters

    • string headline_string

    • string message_string

    Return value

    • void

    226.2.30. Summary

    Summary of current settings

    Return value

    • string - Html formatted configuration summary

    226.2.31. Warning

    Store new warning text

    Function parameters

    • string warning_string

    Return value

    • void

    226.3. Global Variables

    226.4. Module Requirements

    226.4.1. Module Imports

    • Popup
    • Summary

    226.4.2. Module Includes