Class: Yast::PopupClass

Inherits:
Module
  • Object
show all
Defined in:
../../library/general/src/modules/Popup.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) AnyMessage(headline, message)

Generic message popup

Show a message with optional headline above and wait until user clicked “OK”.

Parameters:

  • headline (String)

    optional headline or Popup::NoHeadline()

  • message (String)

    the message (maybe multi-line) to display.

  • icon_name

    icon name (with full path) or Popup::NoIcon()



1076
1077
1078
1079
1080
# File '../../library/general/src/modules/Popup.rb', line 1076

def AnyMessage(headline, message)
  anyMessageInternal(headline, message, Icon.IconPath("info"))

  nil
end

- (Object) anyMessageDetailsInternal(headline, message, details, icon_name)

Internal function - wrapper for anyMessageDetailsInternalType call



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
# File '../../library/general/src/modules/Popup.rb', line 1021

def anyMessageDetailsInternal(headline, message, details, icon_name)
  anyMessageDetailsInternalType(
    headline,
    message,
    details,
    icon_name,
    false,
    0,
    0
  )

  nil
end

- (Object) anyMessageDetailsInternalType(headline, message, details, icon_name, richtext, width, height)

Generic message popup with Details button - internal

Show a message with optional headline above and wait until user clicked “OK” or “Details”. On “Details”, show window with detailed information.

Parameters:

  • headline (String)

    optional headline or Popup::NoHeadline()

  • message (String)

    the message (maybe multi-line) to display.

  • details (String)

    the detailed information text



899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
# File '../../library/general/src/modules/Popup.rb', line 899

def anyMessageDetailsInternalType(headline, message, details, icon_name, richtext, width, height)
  button_box = ButtonBox(
    PushButton(Id(:ok_msg), Opt(:default, :okButton), Label.OKButton),
    # FIXME: BNC #422612, Use `opt(`noSanityCheck) later
    # button label
    PushButton(Id(:details), Opt(:cancelButton), _("&Details..."))
  )

  success = UI.OpenDialog(
    Opt(:decorated),
    if richtext
      popupLayoutInternalRich(
        headline,
        message,
        icon_name,
        button_box,
        width,
        height
      )
    else
      popupLayoutInternal(headline, message, icon_name, button_box)
    end
  )

  UI.SetFocus(Id(:ok_msg))

  loop do
    ret = UI.UserInput
    if ret == :details
      success2 = UI.OpenDialog(
        Opt(:decorated),
        HBox(
          VSpacing(@default_height),
          VBox(
            HSpacing(@default_width),
            VSpacing(0.5),
            RichText(
              Builtins.mergestring(
                Builtins.splitstring(String.EscapeTags(details), "\n"),
                "<br>"
              )
            ),
            VSpacing(),
            ButtonBox(
              PushButton(
                Id(:ok),
                Opt(:default, :key_F10, :okButton),
                Label.OKButton
              )
            )
          )
        )
      )
      if success2 == true
        UI.UserInput
        UI.CloseDialog
      end
    else
      break
    end
  end
  UI.CloseDialog if success == true

  nil
end

- (Object) anyMessageInternal(headline, message, icon_name)

Internal function - wrapper for anyMessageInternal call



1007
1008
1009
1010
1011
# File '../../library/general/src/modules/Popup.rb', line 1007

def anyMessageInternal(headline, message, icon_name)
  anyMessageInternalType(headline, message, icon_name, false, 0, 0)

  nil
end

- (Object) anyMessageInternalRich(headline, message, icon_name, width, height)

Internal function - wrapper for anyMessageInternal call



1014
1015
1016
1017
1018
# File '../../library/general/src/modules/Popup.rb', line 1014

def anyMessageInternalRich(headline, message, icon_name, width, height)
  anyMessageInternalType(headline, message, icon_name, true, width, height)

  nil
end

- (Object) anyMessageInternalType(headline, message, icon_name, richtext, width, height)

Generic message popup - internal

Show a message with optional headline above and wait until user clicked “OK”.

Parameters:

  • headline (String)

    optional headline or Popup::NoHeadline()

  • message (String)

    the message (maybe multi-line) to display.



972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
# File '../../library/general/src/modules/Popup.rb', line 972

def anyMessageInternalType(headline, message, icon_name, richtext, width, height)
  button_box = ButtonBox(
    PushButton(
      Id(:ok_msg),
      Opt(:default, :key_F10, :okButton),
      Label.OKButton
    )
  )

  success = UI.OpenDialog(
    Opt(:decorated),
    if richtext
      popupLayoutInternalRich(
        headline,
        message,
        icon_name,
        button_box,
        width,
        height
      )
    else
      popupLayoutInternal(headline, message, icon_name, button_box)
    end
  )

  if success == true
    UI.SetFocus(Id(:ok_msg))
    UI.UserInput
    UI.CloseDialog
  end

  nil
end

- (Object) AnyQuestion(headline, message, yes_button_message, no_button_message, focus)

Generic question popup with two buttons.

Style guide hint: The first button has to have the semantics of “yes”, “OK”, “continue” etc., the second its opposite (“no”, “cancel”, …). NEVER use this generic question popup to simply exchange the order of yes/no, continue/cancel or ok/cancel buttons!

Examples:

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

Parameters:

  • headline (String)

    headline or Popup::NoHeadline()

  • message (String)

    message string

  • yes_button_message (String)

    label on affirmative buttons (on left side)

  • no_button_message (String)

    label on negating button (on right side)

  • focus (Symbol)

    focus_yes (first button) orfocus_no (second button)

Returns:

  • true: first button has been clicked false: second button has been clicked

See Also:



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File '../../library/general/src/modules/Popup.rb', line 343

def AnyQuestion(headline, message, yes_button_message, no_button_message, focus)
  button_box = AnyQuestionButtonBox(
    yes_button_message,
    no_button_message,
    focus
  )
  success = UI.OpenDialog(
    Opt(:decorated),
    popupLayoutInternal(
      headline,
      message,
      Icon.IconPath("question"),
      button_box
    )
  )

  ret = nil

  if success == true
    ret = UI.UserInput
    UI.CloseDialog
  end

  ret == :yes
end

- (Object) AnyQuestion3(headline, message, yes_button_message, no_button_message, retry_button_message, focus)

Generic question popup with three buttons.

Examples:

Popup::AnyQuestion3( Label::WarningMsg(), _(“… failed”), _(“Continue”), _(“Cancel”), _(“Retry”), `focus_yes );

Parameters:

  • headline (String)

    headline or Popup::NoHeadline()

  • message (String)

    message string

  • yes_button_message (String)

    label on affirmative button (on left side)

  • no_button_message (String)

    label on negating button (middle)

  • retry_button_message (String)

    label on retry button (on right side)

  • focus (Symbol)

    focus_yes (first button),focus_no (second button) or `focus_retry (third button)

Returns:

    • `yes: first button has been clicked

    • `no: second button has been clicked

    • `retry: third button has been clicked

See Also:



1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
# File '../../library/general/src/modules/Popup.rb', line 1704

def AnyQuestion3(headline, message, yes_button_message, no_button_message, retry_button_message, focus)
  yes_button = Empty()
  no_button = Empty()
  retry_button = Empty()

  if focus == :focus_no
    yes_button = PushButton(
      Id(:yes),
      Opt(:key_F10, :okButton),
      yes_button_message
    )
    no_button = PushButton(
      Id(:no),
      Opt(:default, :key_F9, :cancelButton),
      no_button_message
    )
    retry_button = PushButton(
      Id(:retry),
      Opt(:key_F6, :customButton),
      retry_button_message
    )
  elsif focus == :focus_yes
    yes_button = PushButton(
      Id(:yes),
      Opt(:default, :key_F10, :okButton),
      yes_button_message
    )
    no_button = PushButton(
      Id(:no),
      Opt(:key_F9, :cancelButton),
      no_button_message
    )
    retry_button = PushButton(
      Id(:retry),
      Opt(:key_F6, :customButton),
      retry_button_message
    )
  else
    yes_button = PushButton(
      Id(:yes),
      Opt(:key_F10, :okButton),
      yes_button_message
    )
    no_button = PushButton(
      Id(:no),
      Opt(:key_F9, :cancelButton),
      no_button_message
    )
    retry_button = PushButton(
      Id(:retry),
      Opt(:default, :key_F6, :customButton),
      retry_button_message
    )
  end

  button_box = ButtonBox(yes_button, no_button, retry_button)

  success = UI.OpenDialog(
    Opt(:decorated),
    popupLayoutInternal(
      headline,
      message,
      Icon.IconPath("question"),
      button_box
    )
  )

  ret = nil

  if success == true
    ret = Convert.to_symbol(UI.UserInput)
    UI.CloseDialog
  end

  ret
end

- (Yast::Term) AnyQuestionButtonBox(yes_button_message, no_button_message, focus)

Button box for the AnyQuestion Dialog (internal function).

Parameters:

  • yes_button_message (String)

    label on affirmative buttons (on left side)

  • no_button_message (String)

    label on negating button (on right side)

  • focus (Symbol)

    focus_yes (first button) orfocus_no (second button)

Returns:

  • (Yast::Term)

    button box



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# File '../../library/general/src/modules/Popup.rb', line 294

def AnyQuestionButtonBox(yes_button_message, no_button_message, focus)
  yes_button = Empty()
  no_button = Empty()

  if focus == :focus_no
    yes_button = PushButton(Id(:yes), Opt(:okButton), yes_button_message)
    no_button = PushButton(
      Id(:no_button),
      Opt(:default, :cancelButton),
      no_button_message
    )
  else
    yes_button = PushButton(
      Id(:yes),
      Opt(:default, :okButton),
      yes_button_message
    )
    no_button = PushButton(
      Id(:no_button),
      Opt(:cancelButton),
      no_button_message
    )
  end

  button_box = ButtonBox(yes_button, no_button)
  deep_copy(button_box)
end

- (Object) AnyQuestionRichText(headline, richtext, hdim, vdim, yes_button_message, no_button_message, focus)

Show a question that might need scrolling.

Parameters:

  • headline (String)

    short headline

  • richtext (String)

    text input as a rich text

  • hdim (Fixnum)

    initial horizontal dimension of the popup

  • vdim (Fixnum)

    initial vertical dimension of the popup

  • yes_button_message (String)

    message on the left/true button

  • no_button_message (String)

    message on the right/false button

  • focus (Symbol)

    focus_yes,focus_no, `focus_none

Returns:

  • left button pressed?



714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
# File '../../library/general/src/modules/Popup.rb', line 714

def AnyQuestionRichText(headline, richtext, hdim, vdim, yes_button_message, no_button_message, focus)
  yes_button = PushButton(
    Id(:ok),
    if focus == :focus_yes
      Opt(:default, :key_F10, :okButton)
    else
      Opt(:key_F10, :okButton)
    end,
    yes_button_message
  )

  no_button = PushButton(
    Id(:cancel),
    focus == :focus_no ? Opt(:default, :key_F9) : Opt(:key_F9),
    no_button_message
  )

  d = HBox(
    VSpacing(vdim),
    VBox(
      HSpacing(hdim),
      if Ops.greater_than(Builtins.size(headline), 0)
        Left(Heading(headline))
      else
        Empty()
      end,
      VSpacing(0.2),
      RichText(richtext),
      ButtonBox(yes_button, no_button)
    )
  )

  success = UI.OpenDialog(Opt(:decorated), d)
  ui = nil

  if success == true
    ui = UI.UserInput
    UI.CloseDialog
  end

  ui == :ok
end

- (Object) anyRichMessageInternal(headline, message, icon_name, width, height)

Generic message popup - internal

Show a message with optional headline above and wait until user clicked “OK”.

Parameters:

  • headline (String)

    optional headline or Popup::NoHeadline()

  • message (String)

    the message (maybe multi-line) to display.



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
# File '../../library/general/src/modules/Popup.rb', line 1042

def anyRichMessageInternal(headline, message, icon_name, width, height)
  button_box = ButtonBox(
    PushButton(Id(:ok_msg), Opt(:default, :key_F10), Label.OKButton)
  )

  success = UI.OpenDialog(
    Opt(:decorated),
    popupLayoutInternalRich(
      headline,
      message,
      icon_name,
      button_box,
      width,
      height
    )
  )

  if success == true
    UI.SetFocus(Id(:ok_msg))
    UI.UserInput
    UI.CloseDialog
  end

  nil
end

- (void) AnyTimedMessage(headline, message, timeout)

This method returns an undefined value.

Generic message popup

Show a message with optional headline above and wait until user clicked “OK” or until a timeout runs out.

Parameters:

  • headline (String)

    optional headline or Popup::NoHeadline()

  • message (String)

    the message (maybe multi-line) to display.

  • timeout (Fixnum)

    After timeout seconds dialog will be automatically closed



1847
1848
1849
1850
1851
# File '../../library/general/src/modules/Popup.rb', line 1847

def AnyTimedMessage(headline, message, timeout)
  anyTimedMessageInternal(headline, message, nil, timeout)

  nil
end

- (Object) anyTimedMessageInternal(headline, message, icon_name, timeout)

Internal function - wrapper for anyTimedMessageTypeInternal call



242
243
244
245
246
247
248
249
250
251
252
253
254
# File '../../library/general/src/modules/Popup.rb', line 242

def anyTimedMessageInternal(headline, message, icon_name, timeout)
  anyTimedMessageTypeInternal(
    headline,
    message,
    icon_name,
    timeout,
    false,
    0,
    0
  )

  nil
end

- (void) anyTimedMessageTypeInternal(headline, message, icon_name, timeout, richtext, width, height)

This method returns an undefined value.

Internal version of AnyTimedMessage

Show a message with optional headline above and wait until user clicked “OK” or until a timeout runs out.

Parameters:

  • headline (String)

    optional headline or Popup::NoHeadline()

  • message (String)

    the message (maybe multi-line) to display.

  • icon_name (String)

    icon name (with full path) or Popup::NoIcon()

  • timeout (Fixnum)

    After timeout seconds dialog will be automatically closed



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# File '../../library/general/src/modules/Popup.rb', line 194

def anyTimedMessageTypeInternal(headline, message, icon_name, timeout, richtext, width, height)
  button_box = ButtonBox(
    # FIXME: BNC #422612, Use `opt(`noSanityCheck) later
    PushButton(Id(:stop), Opt(:cancelButton), Label.StopButton),
    PushButton(Id(:ok_msg), Opt(:default, :okButton), Label.OKButton)
  )

  success = UI.OpenDialog(
    Opt(:decorated),
    popupLayoutInternalTypeWithLabel(
      headline,
      message,
      icon_name,
      button_box,
      Builtins.sformat("%1", timeout),
      richtext,
      width,
      height
    )
  )

  UI.SetFocus(Id(:ok_msg)) if success == true

  button = nil

  while Ops.greater_than(timeout, 0) && button != :ok_msg
    button = Convert.to_symbol(UI.TimeoutUserInput(1000))

    if button == :stop
      while UI.UserInput != :ok_msg

      end
      break
    end

    timeout = Ops.subtract(timeout, 1)

    if success == true
      UI.ChangeWidget(Id(:label), :Value, Builtins.sformat("%1", timeout))
    end
  end

  UI.CloseDialog if success == true

  nil
end

- (Object) AnyTimedRichMessage(headline, message, timeout)



1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File '../../library/general/src/modules/Popup.rb', line 1853

def AnyTimedRichMessage(headline, message, timeout)
  anyTimedRichMessageInternal(
    headline,
    message,
    nil,
    timeout,
    @default_width,
    @default_height
  )

  nil
end

- (Object) anyTimedRichMessageInternal(headline, message, icon_name, timeout, width, height)

Internal function - wrapper for anyTimedMessageTypeInternal call



257
258
259
260
261
262
263
264
265
266
267
268
269
# File '../../library/general/src/modules/Popup.rb', line 257

def anyTimedRichMessageInternal(headline, message, icon_name, timeout, width, height)
  anyTimedMessageTypeInternal(
    headline,
    message,
    icon_name,
    timeout,
    true,
    width,
    height
  )

  nil
end

- (void) ClearFeedback

This method returns an undefined value.

Clear feedback message



1084
1085
1086
1087
1088
1089
# File '../../library/general/src/modules/Popup.rb', line 1084

def ClearFeedback
  UI.CloseDialog if @feedback_open
  @feedback_open = false

  nil
end

- (Boolean) ConfirmAbort(severity)

Confirmation for “Abort” button during installation.

According to the “severity” parameter an appropriate text will be displayed indicating what the user has to expect when he really aborts now.

Examples:

Popup::ConfirmAbort ( `painless );

Parameters:

  • severity (Symbol)

    painless,incomplete, `unusable

Returns:

  • (Boolean)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
# File '../../library/general/src/modules/Popup.rb', line 769

def ConfirmAbort(severity)
  what_will_happen = ""

  # Confirm user request to abort installation
  abort_label = _("Really abort the installation?")
  # Button that will really abort the installation
  abort_button = _("&Abort Installation")
  # Button that will continue with the installation
  continue_button = _("&Continue Installation")
  # Dialog icon
  icon_name = "warning"

  if severity == :painless
    if Mode.repair
      # Confirm user request to abort System Repair
      abort_label = _("Really abort YaST System Repair?")
      # Button that will really abort the repair
      abort_button = _("Abort System Repair")
      # Button that will continue with the repair
      continue_button = _("&Continue System Repair")
    else
      # Warning text for aborting an installation before anything is installed
      what_will_happen = _(
        "If you abort the installation now,\n" \
          "Linux will not be installed.\n" \
          "Your hard disk will remain untouched."
      )
    end
    # icon_name = "info";
  elsif severity == :incomplete
    # Warning text for aborting an installation during the install process
    # - After some installation steps have been performed - e.g.
    # disks formatted / some packages already installed
    what_will_happen = _(
      "If you abort the installation now, you will\n" \
        "have an incomplete Linux system\n" \
        "that might or might not be usable.\n" \
        "You might need to reinstall.\n"
    )
  elsif severity == :unusable
    # Warning text for aborting an installation during the install process
    # right in the middle of some critical process (e.g. formatting)
    what_will_happen = _(
      "If you abort the installation now,\n" \
        "Linux will be unusable.\n" \
        "You will need to reinstall."
    )
  else
    Builtins.y2error("Unknown symbol for ConfirmAbort")
  end

  message = Ops.add(Ops.add(abort_label, "\n\n"), what_will_happen)

  button_box = AnyQuestionButtonBox(
    abort_button,
    continue_button,
    :focus_no
  )
  success = UI.OpenDialog(
    Opt(:decorated),
    popupLayoutInternal(
      NoHeadline(),
      message,
      Icon.IconPath(icon_name),
      button_box
    )
  )

  user_ret = nil
  if success == true
    user_ret = UI.UserInput
    UI.CloseDialog
  end

  ret = user_ret == :yes

  Builtins.y2debug("ConfirmAbort returned: %1", ret)

  ret
end

- (Boolean) ContinueCancel(message)

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

This popup should be used to confirm possibly dangerous actions. The default button is Continue. Returns true if Continue is clicked.

Examples:

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

Parameters:

  • message (String)

    message string

Returns:

  • (Boolean)

See Also:



592
593
594
595
596
597
# File '../../library/general/src/modules/Popup.rb', line 592

def ContinueCancel(message)
  ret = ContinueCancelHeadline(NoHeadline(), message)
  Builtins.y2debug("ContinueCancel returned: %1", ret)

  ret
end

- (Boolean) ContinueCancelHeadline(headline, message)

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

This popup should be used to confirm possibly dangerous actions and if it's useful to display a short headline (without headline Popup::ContinueCancel() can be used). The default button is Continue.

Returns true if Continue is clicked.

Examples:

Popup::ContinueCancelHeadline ( “Short Header”, “Going on with action.…?” );

Parameters:

  • headline (String)

    short headline or Popup::NoHeadline()

  • message (String)

    message string

Returns:

  • (Boolean)

See Also:



563
564
565
566
567
568
569
570
571
572
573
574
575
# File '../../library/general/src/modules/Popup.rb', line 563

def ContinueCancelHeadline(headline, message)
  ret = AnyQuestion(
    headline,
    message,
    Label.ContinueButton,
    Label.CancelButton,
    :focus_yes
  )

  Builtins.y2debug("ContinueCancelHeadline returned: %1", ret)

  ret
end

- (Object) Error(message)

Show an error message and wait until user clicked “OK”.

Examples:

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

Parameters:

  • message (String)

    error message string

See Also:



1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
# File '../../library/general/src/modules/Popup.rb', line 1383

def Error(message)
  lines = Builtins.splitstring(message, "\n")
  if @switch_to_richtext &&
      Ops.greater_than(Builtins.size(lines), @too_many_lines)
    anyMessageInternalRich(
      Label.ErrorMsg,
      message,
      Icon.IconPath("error"),
      @default_width,
      @default_height
    )
  else
    anyMessageInternal(Label.ErrorMsg, message, Icon.IconPath("error"))
  end

  nil
end

- (Object) ErrorAnyQuestion(headline, message, yes_button_message, no_button_message, focus)

Generic error question popup with two buttons.

Style guide hint: The first button has to have the semantics of “yes”, “OK”, “continue” etc., the second its opposite (“no”, “cancel”, …). NEVER use this generic question popup to simply exchange the order of yes/no, continue/cancel or ok/cancel buttons!

Examples:

Popup::ErrorAnyQuestion( Label::WarningMsg(), “Do really want to …?”, “Install”, “Don't do it”, `focus_no );

Parameters:

  • headline (String)

    headline or Popup::NoHeadline()

  • message (String)

    message string

  • yes_button_message (String)

    label on affirmative buttons (on left side)

  • no_button_message (String)

    label on negating button (on right side)

  • focus (Symbol)

    focus_yes (first button) orfocus_no (second button)

Returns:

  • true: first button has been clicked false: second button has been clicked

See Also:



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
# File '../../library/general/src/modules/Popup.rb', line 390

def ErrorAnyQuestion(headline, message, yes_button_message, no_button_message, focus)
  button_box = AnyQuestionButtonBox(
    yes_button_message,
    no_button_message,
    focus
  )
  success = UI.OpenDialog(
    Opt(:decorated),
    popupLayoutInternal(
      headline,
      message,
      Icon.IconPath("error"),
      button_box
    )
  )

  ret = nil

  if success == true
    ret = UI.UserInput
    UI.CloseDialog
  end

  ret == :yes
end

- (Object) ErrorDetails(message, details)

Show an error message with Details button and wait until user clicked “OK”.

Examples:

Popup::ErrorDetails(“The configuration was not succesful.”, “Service failed to start”);

Parameters:

  • message (String)

    error message string

  • details (String)

    detailed information string

See Also:



1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
# File '../../library/general/src/modules/Popup.rb', line 1497

def ErrorDetails(message, details)
  anyMessageDetailsInternal(
    Label.ErrorMsg,
    message,
    details,
    Icon.IconPath("error")
  )

  nil
end

- (Object) Feedback(headline, message, &block)

Run the block with a feeback popup The popup is automatically closed at the end (even when an exception is raised)

Parameters:

  • headline (String)

    popup headline (displayed in bold)

  • message (String)

    message with details, displayed below the headline

  • block

    block to execute

See Also:

  • and {ClearFeedback} for details


1121
1122
1123
1124
1125
1126
# File '../../library/general/src/modules/Popup.rb', line 1121

def Feedback(headline, message, &block)
  ShowFeedback(headline, message)
  block.call
ensure
  ClearFeedback()
end

- (Object) LongError(message)

Show a long error and wait until user clicked “OK”.

Parameters:

  • message (String)

    message string (may contain rich text tags)



1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
# File '../../library/general/src/modules/Popup.rb', line 1404

def LongError(message)
  anyMessageInternalRich(
    Label.ErrorMsg,
    message,
    Icon.IconPath("error"),
    @default_width,
    @default_height
  )

  nil
end

- (Object) LongErrorGeometry(message, width, height)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • width (Fixnum)

    width of the popup window

  • height (Fixnum)

    height of the popup window



1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
# File '../../library/general/src/modules/Popup.rb', line 1421

def LongErrorGeometry(message, width, height)
  anyMessageInternalRich(
    Label.ErrorMsg,
    message,
    Icon.IconPath("error"),
    width,
    height
  )

  nil
end

- (Object) LongMessage(message)

Show a long message and wait until user clicked “OK”.

Parameters:

  • message (String)

    message string (may contain rich text tags)



1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
# File '../../library/general/src/modules/Popup.rb', line 1149

def LongMessage(message)
  anyMessageInternalRich(
    NoHeadline(),
    message,
    Icon.IconPath("info"),
    @default_width,
    @default_height
  )

  nil
end

- (Object) LongMessageGeometry(message, width, height)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • width (Fixnum)

    width of the popup window

  • height (Fixnum)

    height of the popup window



1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
# File '../../library/general/src/modules/Popup.rb', line 1166

def LongMessageGeometry(message, width, height)
  anyMessageInternalRich(
    NoHeadline(),
    message,
    Icon.IconPath("info"),
    width,
    height
  )

  nil
end

- (Object) LongNotify(message)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)



1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
# File '../../library/general/src/modules/Popup.rb', line 1527

def LongNotify(message)
  anyMessageInternalRich(
    NoHeadline(),
    message,
    Icon.IconPath("info"),
    @default_width,
    @default_height
  )

  nil
end

- (Object) LongNotifyGeometry(message, width, height)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • width (Fixnum)

    width of the popup window

  • height (Fixnum)

    height of the popup window



1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
# File '../../library/general/src/modules/Popup.rb', line 1544

def LongNotifyGeometry(message, width, height)
  anyMessageInternalRich(
    NoHeadline(),
    message,
    Icon.IconPath("info"),
    width,
    height
  )

  nil
end

- (Object) LongText(headline, richtext, hdim, vdim)

Show a long text that might need scrolling.

Pass a RichText widget with the parameters appropriate for your text - i.e. without special parameters for HTML-like text or with opt(plainText) for plain ASCII text without HTML tags.

Examples:

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

Parameters:

  • headline (String)

    short headline

  • richtext (Yast::Term)

    text input is `Richtext()

  • hdim (Fixnum)

    initial horizontal dimension of the popup

  • vdim (Fixnum)

    initial vertical dimension of the popup



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
# File '../../library/general/src/modules/Popup.rb', line 673

def LongText(headline, richtext, hdim, vdim)
  richtext = deep_copy(richtext)
  success = UI.OpenDialog(
    Opt(:decorated),
    HBox(
      VSpacing(vdim),
      VBox(
        HSpacing(hdim),
        Left(Heading(headline)),
        VSpacing(0.2),
        richtext, # scrolled text
        ButtonBox(
          PushButton(
            Id(:ok),
            Opt(:default, :key_F10, :okButton),
            Label.OKButton
          )
        )
      )
    )
  )

  if success == true
    UI.SetFocus(Id(:ok))
    UI.UserInput
    UI.CloseDialog
  end

  nil
end

- (Object) LongWarning(message)

Show a long warning and wait until user clicked “OK”.

Parameters:

  • message (String)

    message string (may contain rich text tags)



1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
# File '../../library/general/src/modules/Popup.rb', line 1268

def LongWarning(message)
  anyMessageInternalRich(
    Label.WarningMsg,
    message,
    Icon.IconPath("warning"),
    @default_width,
    @default_height
  )

  nil
end

- (Object) LongWarningGeometry(message, width, height)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • width (Fixnum)

    width of the popup window

  • height (Fixnum)

    height of the popup window



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
# File '../../library/general/src/modules/Popup.rb', line 1285

def LongWarningGeometry(message, width, height)
  anyMessageInternalRich(
    Label.WarningMsg,
    message,
    Icon.IconPath("warning"),
    width,
    height
  )

  nil
end

- (Object) main



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File '../../library/general/src/modules/Popup.rb', line 42

def main
  Yast.import "UI"

  textdomain "base"

  Yast.import "Label"
  Yast.import "Mode"
  Yast.import "Directory"
  Yast.import "String"
  Yast.import "Icon"

  @feedback_open = false

  # default size of the richtext widget in richtext popups
  @default_width = 60
  @default_height = 10

  # if error message is too long, show LongError instead of Error Popup
  @switch_to_richtext = true

  # lines of message text which force usage of RichText
  @too_many_lines = 20
end

- (Object) Message(message)

Show a simple message and wait until user clicked “OK”.

Examples:

Popup::Message(“This is an information about … .” );

Parameters:

  • message (String)

    message string

See Also:



1140
1141
1142
1143
1144
# File '../../library/general/src/modules/Popup.rb', line 1140

def Message(message)
  anyMessageInternal(NoHeadline(), message, Icon.IconPath("info"))

  nil
end

- (Object) MessageDetails(message, details)

Show a message with Details button and wait until user clicked “OK”.

Examples:

Popup::MessageDetails(“This is an information about … .”, “This service is intended to…”);

Parameters:

  • message (String)

    message string

  • details (String)

    detailed information string

See Also:



1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File '../../library/general/src/modules/Popup.rb', line 1236

def MessageDetails(message, details)
  anyMessageDetailsInternal(
    NoHeadline(),
    message,
    details,
    Icon.IconPath("info")
  )

  nil
end

- (Symbol) ModuleError(text)

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

The user can choose one of: - “back” - go back to the previous module - “next” - skip this faulty module and directly go to the next one - “again” - try it again (after fixing something in the code, of course) - “cancel” - exit program

Examples:

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

Parameters:

  • text (String)

    string

Returns:

  • (Symbol)

    back,again, cancel,next



1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
# File '../../library/general/src/modules/Popup.rb', line 1795

def ModuleError(text)
  success = UI.OpenDialog(
    Opt(:decorated, :warncolor),
    HBox(
      HSpacing(1),
      VBox(
        VSpacing(0.2),
        Heading(text),
        ButtonBox(
          PushButton(
            Id(:back),
            Opt(:key_F8, :customButton),
            Label.BackButton
          ),
          PushButton(
            Id(:again),
            Opt(:key_F6, :customButton),
            Label.RetryButton
          ),
          PushButton(
            Id(:cancel),
            Opt(:key_F9, :cancelButton),
            Label.QuitButton
          ),
          PushButton(Id(:next), Opt(:key_F10, :okButton), Label.NextButton)
        ),
        VSpacing(0.2)
      ),
      HSpacing(1)
    )
  )
  ret = nil

  if success == true
    ret = Convert.to_symbol(UI.UserInput)
    UI.CloseDialog
  end

  ret
end

- (Object) NoHeadline

Indicator for empty headline for popups that can optionally have one

This is really just an alias for the empty string “”, but it is slightly better readable.

Returns:

  • empty string (“”)



277
278
279
# File '../../library/general/src/modules/Popup.rb', line 277

def NoHeadline
  ""
end

- (Object) NoIcon

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



283
284
285
# File '../../library/general/src/modules/Popup.rb', line 283

def NoIcon
  ""
end

- (Object) Notify(message)

Show a notification message and wait until user clicked “OK”.

Examples:

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

Parameters:

  • message (String)

    notify message string

See Also:



1518
1519
1520
1521
1522
# File '../../library/general/src/modules/Popup.rb', line 1518

def Notify(message)
  anyMessageInternal("", message, Icon.IconPath("info"))

  nil
end

- (Object) NotifyDetails(message, details)

Show a notify message with Details button and wait until user clicked “OK”.

Parameters:

  • message (String)

    error message string

  • details (String)

    detailed information string

See Also:



1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
# File '../../library/general/src/modules/Popup.rb', line 1613

def NotifyDetails(message, details)
  anyMessageDetailsInternal(
    NoHeadline(),
    message,
    details,
    Icon.IconPath("info")
  )

  nil
end

- (Object) popupLayoutInternal(headline, message, icon_name, button_box)

Internal function - wrapper for popupLayoutInternalTypeWithLabel call



153
154
155
156
157
158
159
160
161
162
163
164
165
# File '../../library/general/src/modules/Popup.rb', line 153

def popupLayoutInternal(headline, message, icon_name, button_box)
  button_box = deep_copy(button_box)
  popupLayoutInternalTypeWithLabel(
    headline,
    message,
    icon_name,
    button_box,
    nil,
    false,
    0,
    0
  )
end

- (Object) popupLayoutInternalRich(headline, message, icon_name, button_box, width, height)

Internal function - wrapper for popupLayoutInternalTypeWithLabel call



168
169
170
171
172
173
174
175
176
177
178
179
180
# File '../../library/general/src/modules/Popup.rb', line 168

def popupLayoutInternalRich(headline, message, icon_name, button_box, width, height)
  button_box = deep_copy(button_box)
  popupLayoutInternalTypeWithLabel(
    headline,
    message,
    icon_name,
    button_box,
    nil,
    true,
    width,
    height
  )
end

- (Yast::Term) popupLayoutInternalTypeWithLabel(headline, message, icon_name, button_box, label, richtext, width, height)

Internal function that returns a popup dialog with an additional label.

Parameters:

  • headline (String)

    headline to show or Popup::NoHeadline()

  • message (String)

    message text to show

  • icon_name (String)

    icon name (with full path) or Popup::NoIcon()

  • button_box (Yast::Term)

    term with one or more buttons

  • label (String)

    second label with id `label which can be used e.g. for time out value displaying

Returns:

  • (Yast::Term)

    the layout contents as a term



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File '../../library/general/src/modules/Popup.rb', line 75

def popupLayoutInternalTypeWithLabel(headline, message, icon_name, button_box, label, richtext, width, height)
  button_box = deep_copy(button_box)
  content = Empty()
  icon = Empty()

  if Ops.greater_than(Builtins.size(icon_name), 0)
    ui_capabilities = UI.GetDisplayInfo

    if Ops.get_boolean(ui_capabilities, "HasImageSupport", false)
      icon = Image(icon_name, "")
    end
  end

  rt = VWeight(
    1,
    VBox(
      HSpacing(width),
      HBox(
        VSpacing(height),
        # display the message in the widget "as is":
        # escape all tags, replace new lines by <br> tag
        RichText(
          Builtins.mergestring(
            Builtins.splitstring(String.EscapeTags(message), "\n"),
            "<br>"
          )
        )
      )
    )
  )

  if Ops.greater_than(Builtins.size(headline), 0)
    content = VBox(
      VSpacing(0.4),
      HBox(
        Top(icon),
        HSpacing(1),
        VBox(
          Left(Heading(headline)),
          VSpacing(0.2),
          richtext ? rt : Left(Label(message)),
          VSpacing(0.2),
          !label.nil? && label != "" ? Label(Id(:label), label) : Empty()
        )
      )
    ) # no headline
  else
    content = VBox(
      VSpacing(0.4),
      HBox(
        Top(icon),
        HSpacing(1),
        VBox(
          richtext ? rt : VCenter(Label(message)),
          VSpacing(0.2),
          !label.nil? && label != "" ? Label(Id(:label), label) : Empty()
        )
      )
    )
  end

  dialog = HBox(
    HSpacing(1),
    VBox(
      VSpacing(0.2),
      content,
      richtext ? Empty() : VStretch(),
      button_box,
      richtext ? Empty() : VStretch(),
      VSpacing(0.2)
    ),
    HSpacing(1)
  )

  deep_copy(dialog)
end

- (Object) ReallyAbort(have_changes)

Confirmation popup when user clicked “Abort”.

Set “have changes” to “true” when there are changes that will be lost. Note: If there are none, it is good policy to ask for confirmation anyway, but of course with “have_changes” set to “false” so the user isn't warned about changes that might be lost.

Parameters:

  • have_changes (Boolean)

    true: There are changes that will be lost false: No changes

Returns:

  • true: “abort” confirmed; false: don't abort



862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
# File '../../library/general/src/modules/Popup.rb', line 862

def ReallyAbort(have_changes)
  focus = :focus_yes

  # Confirm aborting the program
  message = _("Really abort?")

  if have_changes
    focus = :focus_no

    # Additional hint when trying to abort program in spite of changes
    message = Ops.add(
      Ops.add(message, "\n"),
      _("All changes will be lost!")
    )
  end

  ret = AnyQuestion(
    NoHeadline(),
    message,
    Label.YesButton,
    Label.NoButton,
    focus
  )

  Builtins.y2debug("ReallyAbort returned: %1", ret)

  ret
end

- (void) ShowFeedback(headline, message)

This method returns an undefined value.

Show popup with a headline and a message for feedback

Parameters:

  • headline (String)

    headline of Feedback popup

  • message (String)

    the feedback message



1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
# File '../../library/general/src/modules/Popup.rb', line 1095

def ShowFeedback(headline, message)
  UI.CloseDialog if @feedback_open
  button_box = Empty()
  UI.BusyCursor
  UI.OpenDialog(
    Opt(:decorated),
    popupLayoutInternal(
      headline,
      message,
      Icon.IconPath("warning"),
      button_box
    )
  )

  @feedback_open = true

  nil
end

- (Object) ShowFile(headline, filename)

Show the contents of an entire file in a popup.

Notice: This is a WFM function, NOT an UI function!

Examples:

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

Parameters:

  • headline (String)

    headline text

  • filename (String)

    filename with path of the file to show



1977
1978
1979
1980
1981
1982
1983
# File '../../library/general/src/modules/Popup.rb', line 1977

def ShowFile(headline, filename)
  text = Convert.to_string(SCR.Read(path(".target.string"), filename))

  ShowText(headline, text)

  nil
end

- (Object) ShowText(headline, text)

Show the contents of an entire file in a popup.

Examples:

Popup::ShowText (“Boot Messages”, “kernel panic”);

Parameters:

  • headline (String)

    headline text

  • text (String)

    text to show



1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
# File '../../library/general/src/modules/Popup.rb', line 1930

def ShowText(headline, text)
  heading = Empty()

  if Builtins.size(headline) == 0
    heading = VSpacing(0.2)
  else
    heading = Heading(headline)
  end

  success = UI.OpenDialog(
    Opt(:decorated),
    VBox(
      HSpacing(70), # force width
      heading,
      VWeight(
        1,
        HBox(
          VSpacing(18), # force height
          HSpacing(0.7),
          RichText(Id(:text), Opt(:plainText), text),
          HSpacing(0.7)
        )
      ),
      VSpacing(0.3),
      ButtonBox(
        PushButton(Opt(:default, :key_F10, :okButton), Label.OKButton)
      ),
      VSpacing(0.3)
    )
  )

  if success == true
    UI.UserInput
    UI.CloseDialog
  end

  nil
end

- (Object) ShowTextTimed(headline, text, timeout)

Show the contents of an entire file in a popup.

Examples:

Popup::ShowText (“Boot Messages”, “kernel panic”, 10);

Parameters:

  • headline (String)

    headline text

  • text (String)

    text to show

  • timeout (Fixnum)

    text to show



1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
# File '../../library/general/src/modules/Popup.rb', line 1875

def ShowTextTimed(headline, text, timeout)
  if Builtins.size(headline) == 0
    heading = VSpacing(0.2)
  else
    heading = Heading(headline)
  end

  success = UI.OpenDialog(
    Opt(:decorated),
    VBox(
      HSpacing(70), # force width
      heading,
      VWeight(
        1,
        HBox(
          VSpacing(18), # force height
          HSpacing(0.7),
          RichText(Id(:text), Opt(:plainText), text),
          HSpacing(0.7)
        )
      ),
      VSpacing(0.3),
      Label(Id(:label), Builtins.sformat("%1", timeout)),
      VSpacing(0.2),
      ButtonBox(
        PushButton(
          Id(:ok_msg),
          Opt(:default, :key_F10, :okButton),
          Label.OKButton
        )
      ),
      VSpacing(0.3)
    )
  )

  button = nil

  while Ops.greater_than(timeout, 0) && button != :ok_msg
    button = Convert.to_symbol(UI.TimeoutUserInput(1000))
    timeout = Ops.subtract(timeout, 1)

    UI.ChangeWidget(Id(:label), :Value, Builtins.sformat("%1", timeout))
  end

  UI.CloseDialog if success == true

  nil
end

- (Boolean) TimedAnyQuestion(headline, message, yes_button_message, no_button_message, focus, timeout_seconds)

Timed question popup with two buttons and time display

Parameters:

  • headline (String)

    headline or Popup::NoHeadline()

  • message (String)

    message string

  • yes_button_message (String)

    label on affirmative buttons (on left side)

  • no_button_message (String)

    label on negating button (on right side)

  • focus (Symbol)

    focus_yes (first button) orfocus_no (second button)

  • timeout_seconds (Fixnum)

    timeout, if 0, normal behaviour

Returns:

  • (Boolean)

    True if Yes, False if no

See Also:



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
# File '../../library/general/src/modules/Popup.rb', line 426

def TimedAnyQuestion(headline, message, yes_button_message, no_button_message, focus, timeout_seconds)
  button_box = AnyQuestionButtonBox(
    yes_button_message,
    no_button_message,
    focus
  )
  timed = ReplacePoint(
    Id(:replace_buttons),
    VBox(
      HCenter(Label(Id(:remaining_time), Ops.add("", timeout_seconds))),
      ButtonBox(
        # FIXME: BNC #422612, Use `opt(`noSanityCheck) later
        PushButton(Id(:timed_stop), Opt(:cancelButton), Label.StopButton),
        PushButton(
          Id(:timed_ok),
          Opt(:default, :key_F10, :okButton),
          Label.OKButton
        )
      ),
      VSpacing(0.2)
    )
  )

  success = UI.OpenDialog(
    Opt(:decorated),
    popupLayoutInternal(headline, message, Icon.IconPath("question"), timed)
  )

  while Ops.greater_than(timeout_seconds, 0)
    which_input = UI.TimeoutUserInput(1000)

    break if which_input == :timed_ok
    if which_input == :timed_stop
      UI.ReplaceWidget(Id(:replace_buttons), button_box)
      which_input = UI.UserInput while which_input == :timed_stop
      break
    end
    timeout_seconds = Ops.subtract(timeout_seconds, 1)

    next unless success

    UI.ChangeWidget(
      Id(:remaining_time),
      :Value,
      Ops.add("", timeout_seconds)
    )
  end

  UI.CloseDialog if success == true

  which_input == :yes
end

- (void) TimedError(message, timeout_seconds)

This method returns an undefined value.

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

Parameters:

  • message (String)

    error message string

  • timeout_seconds (Fixnum)

    time out in seconds

See Also:



1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
# File '../../library/general/src/modules/Popup.rb', line 1443

def TimedError(message, timeout_seconds)
  anyTimedMessageInternal(
    Label.ErrorMsg,
    message,
    Icon.IconPath("error"),
    timeout_seconds
  )

  nil
end

- (Boolean) TimedErrorAnyQuestion(headline, message, yes_button_message, no_button_message, focus, timeout_seconds)

Timed error question popup with two buttons and time display

Parameters:

  • headline (String)

    headline or Popup::NoHeadline()

  • message (String)

    message string

  • yes_button_message (String)

    label on affirmative buttons (on left side)

  • no_button_message (String)

    label on negating button (on right side)

  • focus (Symbol)

    focus_yes (first button) orfocus_no (second button)

  • timeout_seconds (Fixnum)

    timeout, if 0, normal behaviour

Returns:

  • (Boolean)

    True if Yes, False if no

See Also:



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
# File '../../library/general/src/modules/Popup.rb', line 489

def TimedErrorAnyQuestion(headline, message, yes_button_message, no_button_message, focus, timeout_seconds)
  button_box = AnyQuestionButtonBox(
    yes_button_message,
    no_button_message,
    focus
  )
  timed = ReplacePoint(
    Id(:replace_buttons),
    VBox(
      HCenter(Label(Id(:remaining_time), Ops.add("", timeout_seconds))),
      ButtonBox(
        # FIXME: BNC #422612, Use `opt(`noSanityCheck) later
        PushButton(Id(:timed_stop), Opt(:cancelButton), Label.StopButton),
        PushButton(
          Id(:timed_ok),
          Opt(:default, :key_F10, :okButton),
          Label.OKButton
        )
      ),
      VSpacing(0.2)
    )
  )

  success = UI.OpenDialog(
    Opt(:decorated),
    popupLayoutInternal(headline, message, Icon.IconPath("error"), timed)
  )

  while Ops.greater_than(timeout_seconds, 0)
    which_input = UI.TimeoutUserInput(1000)

    break if which_input == :timed_ok
    if which_input == :timed_stop
      UI.ReplaceWidget(Id(:replace_buttons), button_box)
      which_input = UI.UserInput while which_input == :timed_stop
      break
    end
    timeout_seconds = Ops.subtract(timeout_seconds, 1)

    next unless success

    UI.ChangeWidget(
      Id(:remaining_time),
      :Value,
      Ops.add("", timeout_seconds)
    )
  end

  UI.CloseDialog if success == true

  which_input == :yes
end

- (Object) TimedLongError(message, timeout_seconds)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • timeout_seconds (Fixnum)

    time out in seconds



1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
# File '../../library/general/src/modules/Popup.rb', line 1458

def TimedLongError(message, timeout_seconds)
  anyTimedRichMessageInternal(
    Label.ErrorMsg,
    message,
    Icon.IconPath("error"),
    timeout_seconds,
    @default_width,
    @default_height
  )

  nil
end

- (Object) TimedLongErrorGeometry(message, timeout_seconds, width, height)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • timeout_seconds (Fixnum)

    time out in seconds

  • width (Fixnum)

    width of the popup window

  • height (Fixnum)

    height of the popup window



1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
# File '../../library/general/src/modules/Popup.rb', line 1477

def TimedLongErrorGeometry(message, timeout_seconds, width, height)
  anyTimedRichMessageInternal(
    Label.ErrorMsg,
    message,
    Icon.IconPath("error"),
    timeout_seconds,
    width,
    height
  )

  nil
end

- (Object) TimedLongMessage(message, timeout_seconds)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • timeout_seconds (Fixnum)

    time out in seconds



1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
# File '../../library/general/src/modules/Popup.rb', line 1197

def TimedLongMessage(message, timeout_seconds)
  anyTimedRichMessageInternal(
    NoHeadline(),
    message,
    Icon.IconPath("info"),
    timeout_seconds,
    @default_width,
    @default_height
  )

  nil
end

- (Object) TimedLongMessageGeometry(message, timeout_seconds, width, height)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • timeout_seconds (Fixnum)

    time out in seconds

  • width (Fixnum)

    width of the popup window

  • height (Fixnum)

    height of the popup window



1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
# File '../../library/general/src/modules/Popup.rb', line 1216

def TimedLongMessageGeometry(message, timeout_seconds, width, height)
  anyTimedRichMessageInternal(
    NoHeadline(),
    message,
    Icon.IconPath("info"),
    timeout_seconds,
    width,
    height
  )

  nil
end

- (Object) TimedLongNotify(message, timeout_seconds)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • timeout_seconds (Fixnum)

    time out in seconds



1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
# File '../../library/general/src/modules/Popup.rb', line 1575

def TimedLongNotify(message, timeout_seconds)
  anyTimedRichMessageInternal(
    NoHeadline(),
    message,
    Icon.IconPath("info"),
    timeout_seconds,
    @default_width,
    @default_height
  )

  nil
end

- (Object) TimedLongNotifyGeometry(message, timeout_seconds, width, height)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • timeout_seconds (Fixnum)

    time out in seconds

  • width (Fixnum)

    width of the popup window

  • height (Fixnum)

    height of the popup window



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
# File '../../library/general/src/modules/Popup.rb', line 1594

def TimedLongNotifyGeometry(message, timeout_seconds, width, height)
  anyTimedRichMessageInternal(
    NoHeadline(),
    message,
    Icon.IconPath("info"),
    timeout_seconds,
    width,
    height
  )

  nil
end

- (Object) TimedLongWarning(message, timeout_seconds)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • timeout_seconds (Fixnum)

    time out in seconds



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
# File '../../library/general/src/modules/Popup.rb', line 1322

def TimedLongWarning(message, timeout_seconds)
  anyTimedRichMessageInternal(
    Label.WarningMsg,
    message,
    Icon.IconPath("warning"),
    timeout_seconds,
    @default_width,
    @default_height
  )

  nil
end

- (Object) TimedLongWarningGeometry(message, timeout_seconds, width, height)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • timeout_seconds (Fixnum)

    time out in seconds

  • width (Fixnum)

    width of the popup window

  • height (Fixnum)

    height of the popup window



1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
# File '../../library/general/src/modules/Popup.rb', line 1341

def TimedLongWarningGeometry(message, timeout_seconds, width, height)
  anyTimedRichMessageInternal(
    Label.WarningMsg,
    message,
    Icon.IconPath("warning"),
    timeout_seconds,
    width,
    height
  )

  nil
end

- (Object) TimedMessage(message, timeout_seconds)

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

Parameters:

  • message (String)

    message string

  • timeout_seconds (Fixnum)

    time out in seconds



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
# File '../../library/general/src/modules/Popup.rb', line 1182

def TimedMessage(message, timeout_seconds)
  anyTimedMessageInternal(
    NoHeadline(),
    message,
    Icon.IconPath("info"),
    timeout_seconds
  )

  nil
end

- (Object) TimedNotify(message, timeout_seconds)

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

Parameters:

  • message (String)

    message string (may contain rich text tags)

  • timeout_seconds (Fixnum)

    time out in seconds



1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
# File '../../library/general/src/modules/Popup.rb', line 1560

def TimedNotify(message, timeout_seconds)
  anyTimedMessageInternal(
    NoHeadline(),
    message,
    Icon.IconPath("info"),
    timeout_seconds
  )

  nil
end

- (Object) TimedOKCancel(message, timeout_seconds)

Display a message with a timeout

Display a message with a timeout and return when the user clicks “OK”, “Cancel” or when the timeout expires (“OK” is assumed then).

There is also a “stop” button that will stop the countdown. If the user clicks that, the popup will wait forever (or until “OK” or “Cancel” is clicked, of course).

Examples:

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

Parameters:

  • message (String)

    message to display

  • timeout_seconds (Fixnum)

    the timeout in seconds

Returns:

  • true –> “OK” or timer expired
    false –> “Cancel”



1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
# File '../../library/general/src/modules/Popup.rb', line 1640

def TimedOKCancel(message, timeout_seconds)
  success = UI.OpenDialog(
    Opt(:decorated),
    HBox(
      HSpacing(1),
      VBox(
        VSpacing(0.2),
        Label(message),
        HCenter(Label(Id(:remaining_time), Ops.add("", timeout_seconds))),
        ButtonBox(
          PushButton(Id(:timed_stop), Opt(:customButton), Label.StopButton),
          PushButton(
            Id(:timed_ok),
            Opt(:default, :key_F10, :okButton),
            Label.OKButton
          ),
          PushButton(
            Id(:timed_cancel),
            Opt(:key_F9, :cancelButton),
            Label.CancelButton
          )
        ),
        VSpacing(0.2)
      )
    )
  )

  while Ops.greater_than(timeout_seconds, 0)
    which_input = UI.TimeoutUserInput(1000)
    break if which_input == :timed_ok
    break if which_input == :timed_cancel
    if which_input == :timed_stop
      which_input = UI.UserInput while which_input == :timed_stop
      break
    end
    timeout_seconds = Ops.subtract(timeout_seconds, 1)
    UI.ChangeWidget(
      Id(:remaining_time),
      :Value,
      Ops.add("", timeout_seconds)
    )
  end
  UI.CloseDialog if success == true

  which_input != :timed_cancel
end

- (void) TimedWarning(message, timeout_seconds)

This method returns an undefined value.

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

Parameters:

  • message (String)

    warning message string

  • timeout_seconds (Fixnum)

    time out in seconds

See Also:



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
# File '../../library/general/src/modules/Popup.rb', line 1307

def TimedWarning(message, timeout_seconds)
  anyTimedMessageInternal(
    Label.WarningMsg,
    message,
    Icon.IconPath("warning"),
    timeout_seconds
  )

  nil
end

- (Object) Warning(message)

Show a warning message and wait until user clicked “OK”.

Examples:

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

Parameters:

  • message (String)

    warning message string

See Also:



1259
1260
1261
1262
1263
# File '../../library/general/src/modules/Popup.rb', line 1259

def Warning(message)
  anyMessageInternal(Label.WarningMsg, message, Icon.IconPath("warning"))

  nil
end

- (Object) WarningDetails(message, details)

Show a warning with Details button and wait until user clicked “OK”.

Examples:

Popup::WarningDetails(“Something is wrong. Please check your configuration.”, “possible problem is in…” );

Parameters:

  • message (String)

    warning message string

  • details (String)

    detailed information string

See Also:



1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
# File '../../library/general/src/modules/Popup.rb', line 1361

def WarningDetails(message, details)
  anyMessageDetailsInternal(
    Label.WarningMsg,
    message,
    details,
    Icon.IconPath("warning")
  )

  nil
end

- (Boolean) YesNo(message)

Display a yes/no question and wait for answer.

Should be used for decisions about two about equivalent paths, not for simple confirmation - use “Popup::ContinueCancel()” for those. The default button is Yes. Returns true if Yes is clicked.

Examples:

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

Parameters:

  • message (String)

    message string

Returns:

  • (Boolean)

    true if [Yes] has been pressed

See Also:



651
652
653
654
655
656
657
# File '../../library/general/src/modules/Popup.rb', line 651

def YesNo(message)
  ret = YesNoHeadline(NoHeadline(), message)

  Builtins.y2debug("YesNo returned: %1", ret)

  ret
end

- (Boolean) YesNoHeadline(headline, message)

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

It should be used for decisions about two about equivalent paths, not for simple confirmation - use “Popup::ContinueCancel()” for those. A short headline can be displayed (without headline you can use Popup::YesNo()).

The default button is Yes.

Returns true if Yes is clicked.

Examples:

Popup::YesNoHeadline ( “Resize Windows Partition?”, “… explanation of dangers …” );

Parameters:

  • headline (String)

    short headline or Popup::NoHeadline()

  • message (String)

    message string

Returns:

  • (Boolean)

    true if [Yes] has been pressed

See Also:



620
621
622
623
624
625
626
627
628
629
630
631
632
# File '../../library/general/src/modules/Popup.rb', line 620

def YesNoHeadline(headline, message)
  ret = AnyQuestion(
    headline,
    message,
    Label.YesButton,
    Label.NoButton,
    :focus_yes
  )

  Builtins.y2debug("YesNoHeadline returned: %1", ret)

  ret
end