Class: Yast::PopupClass

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

Instance Method Summary collapse

Instance Method Details

#AnyMessage(headline, message) ⇒ Object

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.


979
980
981
982
983
# File 'library/general/src/modules/Popup.rb', line 979

def AnyMessage(headline, message)
  anyMessageInternal(headline, message)

  nil
end

#anyMessageDetailsInternal(headline, message, details) ⇒ Object

Internal function - wrapper for anyMessageDetailsInternalType call


927
928
929
930
931
932
933
934
935
936
937
938
# File 'library/general/src/modules/Popup.rb', line 927

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

  nil
end

#anyMessageDetailsInternalType(headline, message, details, richtext, width, height) ⇒ Object

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


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
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
# File 'library/general/src/modules/Popup.rb', line 808

def anyMessageDetailsInternalType(headline, message, details, 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,
        button_box,
        width,
        height
      )
    else
      popupLayoutInternal(headline, message, button_box)
    end
  )

  UI.SetFocus(Id(:ok_msg))

  loop do
    ret = UI.UserInput
    break if ret != :details

    success2 = UI.OpenDialog(
      Opt(:decorated),
      HBox(
        VSpacing(@default_height),
        VBox(
          HSpacing(@default_width),
          VSpacing(0.5),
          RichText(
            Builtins.mergestring(
              Builtins.splitstring(ERB::Util.html_escape(details), "\n"),
              "<br>"
            )
          ),
          VSpacing(),
          ButtonBox(
            PushButton(
              Id(:ok),
              Opt(:default, :key_F10, :okButton),
              Label.OKButton
            )
          )
        )
      )
    )

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

  nil
end

#anyMessageInternal(headline, message) ⇒ Object

Internal function - wrapper for anyMessageInternal call


913
914
915
916
917
# File 'library/general/src/modules/Popup.rb', line 913

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

  nil
end

#anyMessageInternalRich(headline, message, width, height) ⇒ Object

Internal function - wrapper for anyMessageInternal call


920
921
922
923
924
# File 'library/general/src/modules/Popup.rb', line 920

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

  nil
end

#anyMessageInternalType(headline, message, richtext, width, height) ⇒ Object

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.


879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
# File 'library/general/src/modules/Popup.rb', line 879

def anyMessageInternalType(headline, message, 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,
        button_box,
        width,
        height
      )
    else
      popupLayoutInternal(headline, message, button_box)
    end
  )

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

  nil
end

#AnyQuestion(headline, message, yes_button_message, no_button_message, focus) ⇒ Object

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!

screenshots/AnyQuestion.png

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:


301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'library/general/src/modules/Popup.rb', line 301

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,
      button_box
    )
  )

  ret = nil

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

  ret == :yes
end

#AnyQuestion3(headline, message, yes_button_message, no_button_message, retry_button_message, focus) ⇒ Object

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:


1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
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
# File 'library/general/src/modules/Popup.rb', line 1603

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,
      button_box
    )
  )

  ret = nil

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

  ret
end

#AnyQuestionButtonBox(yes_button_message, no_button_message, focus) ⇒ Yast::Term

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


252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'library/general/src/modules/Popup.rb', line 252

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

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

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?


627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
# File 'library/general/src/modules/Popup.rb', line 627

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

#anyRichMessageInternal(headline, message, width, height) ⇒ Object

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.


947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'library/general/src/modules/Popup.rb', line 947

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

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

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

  nil
end

#AnyTimedMessage(headline, message, timeout) ⇒ void

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


1745
1746
1747
1748
1749
# File 'library/general/src/modules/Popup.rb', line 1745

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

  nil
end

#anyTimedMessageInternal(headline, message, timeout) ⇒ Object

Internal function - wrapper for anyTimedMessageTypeInternal call


208
209
210
211
212
213
214
215
216
217
218
219
# File 'library/general/src/modules/Popup.rb', line 208

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

  nil
end

#anyTimedMessageTypeInternal(headline, message, timeout, richtext, width, height) ⇒ void

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.

  • timeout (Fixnum)

    After timeout seconds dialog will be automatically closed


163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
# File 'library/general/src/modules/Popup.rb', line 163

def anyTimedMessageTypeInternal(headline, message, 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,
      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)

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

  UI.CloseDialog if success == true

  nil
end

#AnyTimedRichMessage(headline, message, timeout) ⇒ Object


1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
# File 'library/general/src/modules/Popup.rb', line 1751

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

  nil
end

#anyTimedRichMessageInternal(headline, message, timeout, width, height) ⇒ Object

Internal function - wrapper for anyTimedMessageTypeInternal call


222
223
224
225
226
227
228
229
230
231
232
233
# File 'library/general/src/modules/Popup.rb', line 222

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

  nil
end

#ClearFeedbackvoid

This method returns an undefined value.

Clear feedback message


987
988
989
990
991
992
# File 'library/general/src/modules/Popup.rb', line 987

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

  nil
end

#ConfirmAbort(severity) ⇒ Boolean

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.

screenshots/ConfirmAbort.png

Examples:

Popup::ConfirmAbort ( `painless );

Parameters:

  • severity (Symbol)

    painless,incomplete, `unusable

Returns:

  • (Boolean)

682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
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
756
757
# File 'library/general/src/modules/Popup.rb', line 682

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")

  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
  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,
      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

#ContinueCancel(message) ⇒ Boolean

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.

screenshots/ContinueCancel.png

Examples:

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

Parameters:

  • message (String)

    message string

Returns:

  • (Boolean)

See Also:


505
506
507
508
509
510
# File 'library/general/src/modules/Popup.rb', line 505

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

  ret
end

#ContinueCancelHeadline(headline, message) ⇒ Boolean

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.

screenshot/ContinueCancelHeadline.png

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:


476
477
478
479
480
481
482
483
484
485
486
487
488
# File 'library/general/src/modules/Popup.rb', line 476

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

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

  ret
end

#Error(message) ⇒ Object

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

screenshots/Error.png

Examples:

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

Parameters:

  • message (String)

    error message string

See Also:


1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
# File 'library/general/src/modules/Popup.rb', line 1294

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

  nil
end

#ErrorAnyQuestion(headline, message, yes_button_message, no_button_message, focus) ⇒ Object

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!

screenshots/AnyQuestion.png

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:


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

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,
      button_box
    )
  )

  ret = nil

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

  ret == :yes
end

#ErrorDetails(message, details) ⇒ Object

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:


1402
1403
1404
1405
1406
1407
1408
1409
1410
# File 'library/general/src/modules/Popup.rb', line 1402

def ErrorDetails(message, details)
  anyMessageDetailsInternal(
    Label.ErrorMsg,
    message,
    details
  )

  nil
end

#Feedback(headline, message, &block) ⇒ Object

Run the block with a feeback popup The popup is automatically closed at the end (even when an exception is raised) To suppress temporary feedback see #SuppressFeedback

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

1027
1028
1029
1030
1031
1032
1033
1034
# File 'library/general/src/modules/Popup.rb', line 1027

def Feedback(headline, message, &block)
  raise ArgumentError, "block must be supplied" unless block

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

#LongError(message) ⇒ Object

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

Parameters:

  • message (String)

    message string (may contain rich text tags)


1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
# File 'library/general/src/modules/Popup.rb', line 1314

def LongError(message)
  anyMessageInternalRich(
    Label.ErrorMsg,
    message,
    @default_width,
    @default_height
  )

  nil
end

#LongErrorGeometry(message, width, height) ⇒ Object

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


1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
# File 'library/general/src/modules/Popup.rb', line 1330

def LongErrorGeometry(message, width, height)
  anyMessageInternalRich(
    Label.ErrorMsg,
    message,
    width,
    height
  )

  nil
end

#LongMessage(message) ⇒ Object

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

Parameters:

  • message (String)

    message string (may contain rich text tags)


1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
# File 'library/general/src/modules/Popup.rb', line 1072

def LongMessage(message)
  anyMessageInternalRich(
    NoHeadline(),
    message,
    @default_width,
    @default_height
  )

  nil
end

#LongMessageGeometry(message, width, height) ⇒ Object

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


1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
# File 'library/general/src/modules/Popup.rb', line 1088

def LongMessageGeometry(message, width, height)
  anyMessageInternalRich(
    NoHeadline(),
    message,
    width,
    height
  )

  nil
end

#LongNotify(message) ⇒ Object

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

Parameters:

  • message (String)

    message string (may contain rich text tags)


1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
# File 'library/general/src/modules/Popup.rb', line 1431

def LongNotify(message)
  anyMessageInternalRich(
    NoHeadline(),
    message,
    @default_width,
    @default_height
  )

  nil
end

#LongNotifyGeometry(message, width, height) ⇒ Object

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


1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
# File 'library/general/src/modules/Popup.rb', line 1447

def LongNotifyGeometry(message, width, height)
  anyMessageInternalRich(
    NoHeadline(),
    message,
    width,
    height
  )

  nil
end

#LongText(headline, richtext, hdim, vdim) ⇒ Object

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.

screenshots/LongText.png

Examples:

Popup::LongText ( "Package description", `Richtext("

Hello, this is a long description .....

"), 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


586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
# File 'library/general/src/modules/Popup.rb', line 586

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

#LongWarning(message) ⇒ Object

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

Parameters:

  • message (String)

    message string (may contain rich text tags)


1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
# File 'library/general/src/modules/Popup.rb', line 1185

def LongWarning(message)
  anyMessageInternalRich(
    Label.WarningMsg,
    message,
    @default_width,
    @default_height
  )

  nil
end

#LongWarningGeometry(message, width, height) ⇒ Object

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


1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
# File 'library/general/src/modules/Popup.rb', line 1201

def LongWarningGeometry(message, width, height)
  anyMessageInternalRich(
    Label.WarningMsg,
    message,
    width,
    height
  )

  nil
end

#mainObject


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

def main
  Yast.import "UI"

  textdomain "base"

  Yast.import "Label"
  Yast.import "Mode"
  Yast.import "Directory"

  @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

#Message(message) ⇒ Object

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

screenshots/Message.png

Examples:

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

Parameters:

  • message (String)

    message string

See Also:


1063
1064
1065
1066
1067
# File 'library/general/src/modules/Popup.rb', line 1063

def Message(message)
  anyMessageInternal(NoHeadline(), message)

  nil
end

#MessageDetails(message, details) ⇒ Object

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:


1154
1155
1156
1157
1158
1159
1160
1161
1162
# File 'library/general/src/modules/Popup.rb', line 1154

def MessageDetails(message, details)
  anyMessageDetailsInternal(
    NoHeadline(),
    message,
    details
  )

  nil
end

#ModuleError(text) ⇒ Symbol

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

screenshots/ModuleError.png

Examples:

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

Parameters:

Returns:

  • (Symbol)

    back,again, cancel,next


1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
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
# File 'library/general/src/modules/Popup.rb', line 1693

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

#NoHeadlineObject

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 ("")


241
242
243
# File 'library/general/src/modules/Popup.rb', line 241

def NoHeadline
  ""
end

#Notify(message) ⇒ Object

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

screenshots/Notify.png

Examples:

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

Parameters:

  • message (String)

    notify message string

See Also:


1422
1423
1424
1425
1426
# File 'library/general/src/modules/Popup.rb', line 1422

def Notify(message)
  anyMessageInternal("", message)

  nil
end

#NotifyDetails(message, details) ⇒ Object

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:


1512
1513
1514
1515
1516
1517
1518
1519
1520
# File 'library/general/src/modules/Popup.rb', line 1512

def NotifyDetails(message, details)
  anyMessageDetailsInternal(
    NoHeadline(),
    message,
    details
  )

  nil
end

#popupLayoutInternal(headline, message, button_box) ⇒ Object

Internal function - wrapper for popupLayoutInternalTypeWithLabel call


125
126
127
128
129
130
131
132
133
134
135
136
# File 'library/general/src/modules/Popup.rb', line 125

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

#popupLayoutInternalRich(headline, message, button_box, width, height) ⇒ Object

Internal function - wrapper for popupLayoutInternalTypeWithLabel call


139
140
141
142
143
144
145
146
147
148
149
150
# File 'library/general/src/modules/Popup.rb', line 139

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

#popupLayoutInternalTypeWithLabel(headline, message, button_box, label, richtext, width, height) ⇒ Yast::Term

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

  • 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


73
74
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
# File 'library/general/src/modules/Popup.rb', line 73

def popupLayoutInternalTypeWithLabel(headline, message, button_box, label, richtext, width, height)
  button_box = deep_copy(button_box)
  rt = VWeight(
    1,
    VBox(
      HSpacing(width),
      HBox(
        VSpacing(height),
        RichText(message)
      )
    )
  )

  content = if Ops.greater_than(Builtins.size(headline), 0)
    VBox(
      VSpacing(0.4),
      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
    VBox(
      VSpacing(0.4),
      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

#ReallyAbort(have_changes) ⇒ Object

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


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
# File 'library/general/src/modules/Popup.rb', line 771

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

#ShowFeedback(headline, message) ⇒ void

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


998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
# File 'library/general/src/modules/Popup.rb', line 998

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

  @feedback_open = true
  @feedback_headline = headline
  @feedback_message = message

  nil
end

#ShowFile(headline, filename) ⇒ Object

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


1872
1873
1874
1875
1876
1877
1878
# File 'library/general/src/modules/Popup.rb', line 1872

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

  ShowText(headline, text)

  nil
end

#ShowText(headline, text) ⇒ Object

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


1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
# File 'library/general/src/modules/Popup.rb', line 1827

def ShowText(headline, text)
  heading = if Builtins.size(headline) == 0
    VSpacing(0.2)
  else
    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

#ShowTextTimed(headline, text, timeout) ⇒ Object

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


1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
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
# File 'library/general/src/modules/Popup.rb', line 1772

def ShowTextTimed(headline, text, timeout)
  heading = if Builtins.size(headline) == 0
    VSpacing(0.2)
  else
    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

#SuppressFeedback(&block) ⇒ Object

Hides feedback during block execution. After block it is shown again. When exception is raised, then it is NOT shown again.

Parameters:

  • block

    block to execute

Raises:

  • (ArgumentError)

See Also:

  • {ShowFeedback} and {ClearFeedback} for details

1041
1042
1043
1044
1045
1046
1047
1048
1049
# File 'library/general/src/modules/Popup.rb', line 1041

def SuppressFeedback(&block)
  raise ArgumentError, "block must be supplied" unless block

  return block.call unless @feedback_open # just call block if feedback is not open

  ClearFeedback()
  block.call
  ShowFeedback(@feedback_headline, @feedback_message)
end

#TimedAnyQuestion(headline, message, yes_button_message, no_button_message, focus, timeout_seconds) ⇒ Boolean

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:


382
383
384
385
386
387
388
389
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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
# File 'library/general/src/modules/Popup.rb', line 382

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, 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

#TimedError(message, timeout_seconds) ⇒ void

This method returns an undefined value.

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

screenshots/TimedErrorPopup.png

Parameters:

  • message (String)

    error message string

  • timeout_seconds (Fixnum)

    time out in seconds

See Also:


1351
1352
1353
1354
1355
1356
1357
1358
1359
# File 'library/general/src/modules/Popup.rb', line 1351

def TimedError(message, timeout_seconds)
  anyTimedMessageInternal(
    Label.ErrorMsg,
    message,
    timeout_seconds
  )

  nil
end

#TimedErrorAnyQuestion(headline, message, yes_button_message, no_button_message, focus, timeout_seconds) ⇒ Boolean

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:


446
447
448
449
450
451
452
453
# File 'library/general/src/modules/Popup.rb', line 446

def TimedErrorAnyQuestion(headline, message, yes_button_message, no_button_message, focus, timeout_seconds)
  buttons = { yes: yes_button_message, no: no_button_message }
  focus_symbol = (focus == :focus_no) ? :no : :yes
  ret = Yast2::Popup.show(message, headline: headline, buttons: buttons,
    focus: focus_symbol, timeout: timeout_seconds)

  ret == :yes
end

#TimedLongError(message, timeout_seconds) ⇒ Object

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


1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
# File 'library/general/src/modules/Popup.rb', line 1365

def TimedLongError(message, timeout_seconds)
  anyTimedRichMessageInternal(
    Label.ErrorMsg,
    message,
    timeout_seconds,
    @default_width,
    @default_height
  )

  nil
end

#TimedLongErrorGeometry(message, timeout_seconds, width, height) ⇒ Object

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


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

def TimedLongErrorGeometry(message, timeout_seconds, width, height)
  anyTimedRichMessageInternal(
    Label.ErrorMsg,
    message,
    timeout_seconds,
    width,
    height
  )

  nil
end

#TimedLongMessage(message, timeout_seconds) ⇒ Object

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


1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
# File 'library/general/src/modules/Popup.rb', line 1117

def TimedLongMessage(message, timeout_seconds)
  anyTimedRichMessageInternal(
    NoHeadline(),
    message,
    timeout_seconds,
    @default_width,
    @default_height
  )

  nil
end

#TimedLongMessageGeometry(message, timeout_seconds, width, height) ⇒ Object

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


1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
# File 'library/general/src/modules/Popup.rb', line 1135

def TimedLongMessageGeometry(message, timeout_seconds, width, height)
  anyTimedRichMessageInternal(
    NoHeadline(),
    message,
    timeout_seconds,
    width,
    height
  )

  nil
end

#TimedLongNotify(message, timeout_seconds) ⇒ Object

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


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

def TimedLongNotify(message, timeout_seconds)
  anyTimedRichMessageInternal(
    NoHeadline(),
    message,
    timeout_seconds,
    @default_width,
    @default_height
  )

  nil
end

#TimedLongNotifyGeometry(message, timeout_seconds, width, height) ⇒ Object

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


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

def TimedLongNotifyGeometry(message, timeout_seconds, width, height)
  anyTimedRichMessageInternal(
    NoHeadline(),
    message,
    timeout_seconds,
    width,
    height
  )

  nil
end

#TimedLongWarning(message, timeout_seconds) ⇒ Object

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


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

def TimedLongWarning(message, timeout_seconds)
  anyTimedRichMessageInternal(
    Label.WarningMsg,
    message,
    timeout_seconds,
    @default_width,
    @default_height
  )

  nil
end

#TimedLongWarningGeometry(message, timeout_seconds, width, height) ⇒ Object

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


1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
# File 'library/general/src/modules/Popup.rb', line 1254

def TimedLongWarningGeometry(message, timeout_seconds, width, height)
  anyTimedRichMessageInternal(
    Label.WarningMsg,
    message,
    timeout_seconds,
    width,
    height
  )

  nil
end

#TimedMessage(message, timeout_seconds) ⇒ Object

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


1103
1104
1105
1106
1107
1108
1109
1110
1111
# File 'library/general/src/modules/Popup.rb', line 1103

def TimedMessage(message, timeout_seconds)
  anyTimedMessageInternal(
    NoHeadline(),
    message,
    timeout_seconds
  )

  nil
end

#TimedNotify(message, timeout_seconds) ⇒ Object

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


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

def TimedNotify(message, timeout_seconds)
  anyTimedMessageInternal(
    NoHeadline(),
    message,
    timeout_seconds
  )

  nil
end

#TimedOKCancel(message, timeout_seconds) ⇒ Object

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"


1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
# File 'library/general/src/modules/Popup.rb', line 1538

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

#TimedWarning(message, timeout_seconds) ⇒ void

This method returns an undefined value.

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

screenshots/TimedWarningPopup.png

Parameters:

  • message (String)

    warning message string

  • timeout_seconds (Fixnum)

    time out in seconds

See Also:


1222
1223
1224
1225
1226
1227
1228
1229
1230
# File 'library/general/src/modules/Popup.rb', line 1222

def TimedWarning(message, timeout_seconds)
  anyTimedMessageInternal(
    Label.WarningMsg,
    message,
    timeout_seconds
  )

  nil
end

#Warning(message) ⇒ Object

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

screenshots/Warning.png

Examples:

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

Parameters:

  • message (String)

    warning message string

See Also:


1176
1177
1178
1179
1180
# File 'library/general/src/modules/Popup.rb', line 1176

def Warning(message)
  anyMessageInternal(Label.WarningMsg, message)

  nil
end

#WarningDetails(message, details) ⇒ Object

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:


1273
1274
1275
1276
1277
1278
1279
1280
1281
# File 'library/general/src/modules/Popup.rb', line 1273

def WarningDetails(message, details)
  anyMessageDetailsInternal(
    Label.WarningMsg,
    message,
    details
  )

  nil
end

#YesNo(message) ⇒ Boolean

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.

screenshots/YesNo.png

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:


564
565
566
567
568
569
570
# File 'library/general/src/modules/Popup.rb', line 564

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

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

  ret
end

#YesNoHeadline(headline, message) ⇒ Boolean

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.

screenshots/YesNoHeadline.png

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:


533
534
535
536
537
538
539
540
541
542
543
544
545
# File 'library/general/src/modules/Popup.rb', line 533

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

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

  ret
end