178. Popup

Commonly used popup dialogs

178.1. Summary of Module Globals

List of Global Functions

AnyMessage - Generic message popup
AnyQuestion - Generic question popup with two buttons.
AnyQuestion3 - Generic question popup with three buttons.
AnyQuestionRichText - Show a question that might need scrolling.
AnyTimedMessage - Generic message popup
ClearFeedback - Clear feedback message
ConfirmAbort - Confirmation for "Abort" button during installation.
ContinueCancel - Dialog which displays the "message" and has a Continue and a Cancel button.
ContinueCancelHeadline - Dialog which displays the "message" and has a Continue and a Cancel button.
Error - Show an error message and wait until user clicked "OK".
LongError - Show a long error and wait until user clicked "OK".
LongErrorGeometry - Show a long error message and wait until user clicked "OK". Size of the popup window is adjustable.
LongMessage - Show a long message and wait until user clicked "OK".
LongMessageGeometry - Show a long message and wait until user clicked "OK". Size of the popup window is adjustable.
LongNotify - Show a long notify message and wait until user clicked "OK".
LongNotifyGeometry - Show a long notify message and wait until user clicked "OK". Size of the popup window is adjustable.
LongText - Show a long text that might need scrolling.
LongWarning - Show a long warning and wait until user clicked "OK".
LongWarningGeometry - Show a long warning and wait until user clicked "OK". Size of the popup window is adjustable
Message - Show a simple message and wait until user clicked "OK".
ModuleError - Special error popup for YCP modules that don't work.
NoHeadline - Indicator for empty headline for popups that can optionally have one
NoIcon - Indicator for empty icon for popups that can have one - for code readability.
Notify - Show a notification message and wait until user clicked "OK".
ReallyAbort - Confirmation popup when user clicked "Abort".
ShowFeedback - Show popup with a headline and a message for feedback
ShowFile - Show the contents of an entire file in a popup.
ShowText - Show the contents of an entire file in a popup.
ShowTextTimed - Show the contents of an entire file in a popup.
TimedAnyQuestion - Timed question popup with two buttons and time display
TimedError - Show an error message and wait specified amount of time or until user clicked "OK".
TimedLongError - Show a long error message and wait until user clicked "OK" or time is out.
TimedLongErrorGeometry - Show a long error message and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.
TimedLongMessage - Show a long message and wait until user clicked "OK" or time is out.
TimedLongMessageGeometry - Show a long message and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.
TimedLongNotify - Show a long error message and wait until user clicked "OK" or time is out.
TimedLongNotifyGeometry - Show a long notify message and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.
TimedLongWarning - Show a long warning message and wait until user clicked "OK" or time is out.
TimedLongWarningGeometry - Show a long warning and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.
TimedMessage - Show a message and wait until user clicked "OK" or time is out
TimedNotify - Show a long notify message and wait until user clicked "OK" or the time is out.
TimedOKCancel - Display a message with a timeout
TimedWarning - Show a warning message and wait specified amount of time or until user clicked "OK".
Warning - Show a warning message and wait until user clicked "OK".
YesNo - Display a yes/no question and wait for answer.
YesNoHeadline - This dialog displays "message" (a question) and has a Yes and a No button.

List of Global Variables

178.2. Global Functions

178.2.1. AnyMessage

Generic message popup

Function parameters

string headline
string message

Return value

void

178.2.2. AnyQuestion

Generic question popup with two buttons.

Function parameters

string headline
string message
string yes_button_message
string no_button_message
symbol focus

Return value

boolean - true: first button has been clicked false: second button has been clicked

Example 38.

 Popup::AnyQuestion( Label::WarningMsg(), "Do really want to ...?", "Install", "Don't do it", `focus_no );

178.2.3. AnyQuestion3

Generic question popup with three buttons.

Function parameters

string headline
string message
string yes_button_message
string no_button_message
string retry_button_message
symbol focus

Return value

symbol - - `yes: first button has been clicked - `no: second button has been clicked - `retry: third button has been clicked

Example 39.

 Popup::AnyQuestion3( Label::WarningMsg(), _("... failed"), _("Continue"), _("Cancel"), _("Retry"), `focus_yes );

178.2.4. AnyQuestionRichText

Show a question that might need scrolling.

Function parameters

string headline
string richtext
integer hdim
integer vdim
string yes_button_message
string no_button_message
symbol focus

Return value

boolean - left button pressed?

178.2.5. AnyTimedMessage

Generic message popup

Function parameters

string headline
string message
integer timeout

Return value

void -

178.2.6. ClearFeedback

Clear feedback message

Return value

void

178.2.7. ConfirmAbort

Confirmation for "Abort" button during installation.

Function parameters

symbol severity

Return value

boolean -

Example 40.

 Popup::ConfirmAbort ( `painless );

178.2.8. ContinueCancel

Dialog which displays the "message" and has a Continue and a Cancel button.

Function parameters

string message

Return value

boolean -

Example 41.

 Popup::ContinueCancel ( "Please insert required CD-ROM." );

178.2.9. ContinueCancelHeadline

Dialog which displays the "message" and has a Continue and a Cancel button.

Function parameters

string headline
string message

Return value

boolean -

Example 42.

 Popup::ContinueCancelHeadline ( "Short Header", "Going on with action....?" );

178.2.10. Error

Show an error message and wait until user clicked "OK".

Function parameters

string message

Return value

void

Example 43.

  Popup::Error("The configuration was not succesful." );

178.2.11. LongError

Show a long error and wait until user clicked "OK".

Function parameters

string message

Return value

void

178.2.12. LongErrorGeometry

Show a long error message and wait until user clicked "OK". Size of the popup window is adjustable.

Function parameters

string message
integer width
integer height

Return value

void

178.2.13. LongMessage

Show a long message and wait until user clicked "OK".

Function parameters

string message

Return value

void

178.2.14. LongMessageGeometry

Show a long message and wait until user clicked "OK". Size of the popup window is adjustable.

Function parameters

string message
integer width
integer height

Return value

void

178.2.15. LongNotify

Show a long notify message and wait until user clicked "OK".

Function parameters

string message

Return value

void

178.2.16. LongNotifyGeometry

Show a long notify message and wait until user clicked "OK". Size of the popup window is adjustable.

Function parameters

string message
integer width
integer height

Return value

void

178.2.17. LongText

Show a long text that might need scrolling.

Function parameters

string headline
term richtext
integer hdim
integer vdim

Return value

void

Example 44.

 Popup::LongText ( "Package description", `Richtext("<p>Hello, this is a long description .....</p>"), 50, 20 );

178.2.18. LongWarning

Show a long warning and wait until user clicked "OK".

Function parameters

string message

Return value

void

178.2.19. LongWarningGeometry

Show a long warning and wait until user clicked "OK". Size of the popup window is adjustable

Function parameters

string message
integer width
integer height

Return value

void

178.2.20. Message

Show a simple message and wait until user clicked "OK".

Function parameters

string message

Return value

void

Example 45.

  Popup::Message("This is an information about ... ." );

178.2.21. ModuleError

Special error popup for YCP modules that don't work.

Function parameters

string text

Return value

symbol - `back, `again, `cancel, `next

Example 46.

 Popup::ModuleError( "The module " + symbolof(argterm) + " does not work." );

178.2.22. NoHeadline

Indicator for empty headline for popups that can optionally have one

Return value

string - empty string ("")

178.2.23. NoIcon

Indicator for empty icon for popups that can have one - for code readability.

Return value

string

178.2.24. Notify

Show a notification message and wait until user clicked "OK".

Function parameters

string message

Return value

void

Example 47.

  Popup::Notify("Your printer is ready for use." );

178.2.25. ReallyAbort

Confirmation popup when user clicked "Abort".

Function parameters

boolean have_changes

Return value

boolean - true: "abort" confirmed; false: don't abort

178.2.26. ShowFeedback

Show popup with a headline and a message for feedback

Function parameters

string headline
string message

Return value

void

178.2.27. ShowFile

Show the contents of an entire file in a popup.

Function parameters

string headline
string filename

Return value

void

Example 48.

 Popup::ShowFile ("Boot Messages", "/var/log/boot.msg");

178.2.28. ShowText

Show the contents of an entire file in a popup.

Function parameters

string headline
string text

Return value

void

Example 49.

 Popup::ShowText ("Boot Messages", "kernel panic");

178.2.29. ShowTextTimed

Show the contents of an entire file in a popup.

Function parameters

string headline
string text
integer timeout

Return value

void

Example 50.

 Popup::ShowText ("Boot Messages", "kernel panic");

178.2.30. TimedAnyQuestion

Timed question popup with two buttons and time display

Function parameters

string headline
string message
string yes_button_message
string no_button_message
symbol focus
integer timeout_seconds

Return value

boolean - True if Yes, False if no

178.2.31. TimedError

Show an error message and wait specified amount of time or until user clicked "OK".

Function parameters

string message
integer timeout_seconds

Return value

void -

178.2.32. TimedLongError

Show a long error message and wait until user clicked "OK" or time is out.

Function parameters

string message
integer timeout_seconds

Return value

void

178.2.33. TimedLongErrorGeometry

Show a long error message and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.

Function parameters

string message
integer timeout_seconds
integer width
integer height

Return value

void

178.2.34. TimedLongMessage

Show a long message and wait until user clicked "OK" or time is out.

Function parameters

string message
integer timeout_seconds

Return value

void

178.2.35. TimedLongMessageGeometry

Show a long message and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.

Function parameters

string message
integer timeout_seconds
integer width
integer height

Return value

void

178.2.36. TimedLongNotify

Show a long error message and wait until user clicked "OK" or time is out.

Function parameters

string message
integer timeout_seconds

Return value

void

178.2.37. TimedLongNotifyGeometry

Show a long notify message and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.

Function parameters

string message
integer timeout_seconds
integer width
integer height

Return value

void

178.2.38. TimedLongWarning

Show a long warning message and wait until user clicked "OK" or time is out.

Function parameters

string message
integer timeout_seconds

Return value

void

178.2.39. TimedLongWarningGeometry

Show a long warning and wait until user clicked "OK" or time is out. Size of the popup window is adjustable.

Function parameters

string message
integer timeout_seconds
integer width
integer height

Return value

void

178.2.40. TimedMessage

Show a message and wait until user clicked "OK" or time is out

Function parameters

string message
integer timeout_seconds

Return value

void

178.2.41. TimedNotify

Show a long notify message and wait until user clicked "OK" or the time is out.

Function parameters

string message
integer timeout_seconds

Return value

void

178.2.42. TimedOKCancel

Display a message with a timeout

Function parameters

string message
integer timeout_seconds

Return value

boolean - true --> "OK" or timer expired false --> "Cancel"

Example 51.

 boolean ret = Popup::TimedOKCancel("This is a timed message", 2 );

178.2.43. TimedWarning

Show a warning message and wait specified amount of time or until user clicked "OK".

Function parameters

string message
integer timeout_seconds

Return value

void -

178.2.44. Warning

Show a warning message and wait until user clicked "OK".

Function parameters

string message

Return value

void

Example 52.

 Popup::Warning("Something is wrong. Please check your configuration." );

178.2.45. YesNo

Display a yes/no question and wait for answer.

Function parameters

string message

Return value

boolean - true if [Yes] has been pressed

Example 53.

  Popup::YesNo ( "Create a backup of the config files?" );

178.2.46. YesNoHeadline

This dialog displays "message" (a question) and has a Yes and a No button.

Function parameters

string headline
string message

Return value

boolean - true if [Yes] has been pressed

Example 54.

  Popup::YesNoHeadline ( "Resize Windows Partition?", "... explanation of dangers ..." );


177. Partitions		179. PortAliases

178. Popup

178.1. Summary of Module Globals

178.2. Global Functions

178.2.1. AnyMessage

178.2.2. AnyQuestion

178.2.3. AnyQuestion3

178.2.4. AnyQuestionRichText

178.2.5. AnyTimedMessage

178.2.6. ClearFeedback

178.2.7. ConfirmAbort

178.2.8. ContinueCancel

178.2.9. ContinueCancelHeadline

178.2.10. Error

178.2.11. LongError

178.2.12. LongErrorGeometry

178.2.13. LongMessage

178.2.14. LongMessageGeometry

178.2.15. LongNotify

178.2.16. LongNotifyGeometry

178.2.17. LongText

178.2.18. LongWarning

178.2.19. LongWarningGeometry

178.2.20. Message

178.2.21. ModuleError

178.2.22. NoHeadline

178.2.23. NoIcon

178.2.24. Notify

178.2.25. ReallyAbort

178.2.26. ShowFeedback

178.2.27. ShowFile

178.2.28. ShowText

178.2.29. ShowTextTimed

178.2.30. TimedAnyQuestion

178.2.31. TimedError

178.2.32. TimedLongError

178.2.33. TimedLongErrorGeometry

178.2.34. TimedLongMessage

178.2.35. TimedLongMessageGeometry

178.2.36. TimedLongNotify

178.2.37. TimedLongNotifyGeometry

178.2.38. TimedLongWarning

178.2.39. TimedLongWarningGeometry

178.2.40. TimedMessage

178.2.41. TimedNotify

178.2.42. TimedOKCancel

178.2.43. TimedWarning

178.2.44. Warning

178.2.45. YesNo

178.2.46. YesNoHeadline

178.3. Global Variables

178.4. Module Requirements

178.4.1. Module Imports

178.4.2. Module Includes