Class: Yast::WizardClass

Inherits:
Module
  • Object
show all
Defined in:
library/wizard/src/modules/Wizard.rb

Constant Summary collapse

DEFAULT_ICON_NAME =
"yast".freeze

Instance Method Summary collapse

Instance Method Details

#AbortAcceptButtonBoxObject

Returns a button box with buttons "Abort", "Accept"

Returns:

  • a widget tree


214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'library/wizard/src/modules/Wizard.rb', line 214

def AbortAcceptButtonBox
  HBox(
    HWeight(1, ReplacePoint(Id(:back_rep), Empty())), # Layout trick to make sure the center button is centered
    HStretch(),
    HWeight(
      1,
      ReplacePoint(
        Id(:rep_abort), # Make sure HideAbortButton() works (bnc #444176)
        PushButton(Id(:abort), Opt(:key_F9), Label.AbortButton)
      )
    ),
    HStretch(),
    HWeight(
      1,
      PushButton(Id(:accept), Opt(:key_F10, :default), Label.AcceptButton)
    )
  )
end

#AbortApplyFinishButtonBoxObject

Returns a button box with buttons "Abort", "Apply", "Finish"

Returns:

  • a widget tree


254
255
256
257
258
259
260
261
# File 'library/wizard/src/modules/Wizard.rb', line 254

def AbortApplyFinishButtonBox
  ButtonBox(
    PushButton(Id(:abort, :cancelButton, :key_F9), Label.AbortButton),
    # button text
    PushButton(Id(:apply, :applyButton), _("&Apply")),
    PushButton(Id(:finish, :okButton, :key_F10), Label.FinishButton)
  )
end

#AbortInstallationAcceptButtonBoxObject

Returns a button box with buttons "Abort Installation", "Accept"

Returns:

  • a widget tree


236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'library/wizard/src/modules/Wizard.rb', line 236

def AbortInstallationAcceptButtonBox
  ButtonBox(
    PushButton(
      Id(:abort),
      Opt(:key_F9, :cancelButton),
      Label.AbortInstallationButton
    ),
    PushButton(
      Id(:accept),
      Opt(:key_F10, :okButton, :default),
      Label.AcceptButton
    )
  )
end

#AcceptDialogYast::Term

Note:

This is a stable API function

Returns a standard wizard dialog with buttons "Cancel", "Accept"

Returns:

  • (Yast::Term)

    describing the dialog.


402
403
404
# File 'library/wizard/src/modules/Wizard.rb', line 402

def AcceptDialog
  GenericDialog(CancelAcceptButtonBox())
end

#AddMenu(menu, title, id) ⇒ Array<Hash>

Add Menu

Parameters:

  • Menu (Array<Hash>)

    Menu data

  • title (String)

    Menu Title

  • id (String)

    Menu ID

Returns:

  • (Array<Hash>)

    Updated Menu Data


1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
# File 'library/wizard/src/modules/Wizard.rb', line 1612

def AddMenu(menu, title, id)
  menu = deep_copy(menu)
  if haveFancyUI
    UI.WizardCommand(term(:AddMenu, title, id))
  else
    menu = Builtins.add(
      menu,
      "type" => "Menu", "title" => title, "id" => id
    )
  end
  deep_copy(menu)
end

#AddMenuEntry(menu, parent_id, title, id) ⇒ Array<Hash>

Add Menu Entry

Parameters:

  • Menu (Array<Hash>)

    Menu data

  • parent_id (String)

    Menu Parent

  • title (String)

    Menu Title

  • id (String)

    Menu ID

Returns:

  • (Array<Hash>)

    Updated Menu Data


1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
# File 'library/wizard/src/modules/Wizard.rb', line 1655

def AddMenuEntry(menu, parent_id, title, id)
  menu = deep_copy(menu)
  if haveFancyUI
    UI.WizardCommand(term(:AddMenuEntry, parent_id, title, id))
  else
    menu = Builtins.add(
      menu,
      "type"   => "MenuEntry",
      "parent" => parent_id,
      "title"  => title,
      "id"     => id
    )
  end
  deep_copy(menu)
end

#AddSubMenu(menu, parent_id, title, id) ⇒ Array<Hash>

Add Sub Menu

Parameters:

  • Menu (Array<Hash>)

    Menu data

  • parent_id (String)

    Menu Parent

  • title (String)

    Menu Title

  • id (String)

    Menu ID

Returns:

  • (Array<Hash>)

    Updated Menu Data


1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
# File 'library/wizard/src/modules/Wizard.rb', line 1632

def AddSubMenu(menu, parent_id, title, id)
  menu = deep_copy(menu)
  if haveFancyUI
    UI.WizardCommand(term(:AddSubMenu, parent_id, title, id))
  else
    menu = Builtins.add(
      menu,
      "type"   => "SubMenu",
      "parent" => parent_id,
      "title"  => title,
      "id"     => id
    )
  end
  deep_copy(menu)
end

#AddTreeItem(tree, parent, title, id) ⇒ Array<Hash>

Add Tree Item to tree enabled Wizard

Parameters:

  • Tree (Array<Hash>)

    Tree Data

  • parent (String)

    Parent of this item

  • title (String)

    Item Title

  • id (String)

    Item ID

Returns:

  • (Array<Hash>)

    Updated Tree Data


1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'library/wizard/src/modules/Wizard.rb', line 1483

def AddTreeItem(tree, parent, title, id)
  tree = deep_copy(tree)
  if haveFancyUI
    UI.WizardCommand(term(:AddTreeItem, parent, title, id))
  else
    tree = Builtins.add(
      tree,
      "parent" => parent, "title" => title, "id" => id
    )
  end
  deep_copy(tree)
end

#BackAbortInstallationNextButtonBoxObject

Returns a button box with buttons "Back", "Abort Installation", "Next"

Returns:

  • a widget tree


131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'library/wizard/src/modules/Wizard.rb', line 131

def BackAbortInstallationNextButtonBox
  HBox(
    HWeight(
      1,
      ReplacePoint(
        Id(:rep_help),
        PushButton(Id(:help), Opt(:key_F1, :helpButton), Label.HelpButton)
      )
    ),
    HStretch(),
    HWeight(
      1,
      ReplacePoint(
        Id(:rep_back),
        PushButton(Id(:back), Opt(:key_F8), Label.BackButton)
      )
    ),
    HStretch(),
    ReplacePoint(
      Id(:rep_abort),
      PushButton(Id(:abort), Opt(:key_F9), Label.AbortInstallationButton)
    ),
    HStretch(),
    HWeight(
      1,
      ReplacePoint(
        Id(:rep_next),
        PushButton(Id(:next), Opt(:key_F10, :default), Label.NextButton)
      )
    )
  )
end

#BackAbortNextButtonBoxObject

Returns a button box with buttons "Back", "Abort", "Next"

Returns:

  • a widget tree


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
# File 'library/wizard/src/modules/Wizard.rb', line 95

def BackAbortNextButtonBox
  HBox(
    HWeight(
      1,
      ReplacePoint(
        Id(:rep_help),
        PushButton(Id(:help), Opt(:key_F1, :helpButton), Label.HelpButton)
      )
    ),
    HStretch(),
    HWeight(
      1,
      ReplacePoint(
        Id(:rep_back),
        PushButton(Id(:back), Opt(:key_F8), Label.BackButton)
      )
    ),
    HStretch(),
    ReplacePoint(
      Id(:rep_abort),
      PushButton(Id(:abort), Opt(:key_F9), Label.AbortButton)
    ),
    HStretch(),
    HWeight(
      1,
      ReplacePoint(
        Id(:rep_next),
        PushButton(Id(:next), Opt(:key_F10, :default), Label.NextButton)
      )
    )
  )
end

#BackNextButtonBoxObject

Returns a button box with buttons "Back", "Next"

Returns:

  • a widget tree


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'library/wizard/src/modules/Wizard.rb', line 167

def BackNextButtonBox
  HBox(
    HWeight(
      1,
      ReplacePoint(
        Id(:rep_back),
        PushButton(Id(:back), Opt(:key_F8), Label.BackButton)
      )
    ),
    HStretch(),
    HWeight(
      1,
      ReplacePoint(
        Id(:rep_next),
        PushButton(Id(:next), Opt(:key_F10, :default), Label.NextButton)
      )
    )
  )
end

#CancelAcceptButtonBoxObject

Returns a button box with buttons "Cancel", "Accept"

Returns:

  • a widget tree


190
191
192
193
194
195
196
197
198
199
# File 'library/wizard/src/modules/Wizard.rb', line 190

def CancelAcceptButtonBox
  ButtonBox(
    PushButton(Id(:cancel), Opt(:key_F9, :cancelButton), Label.CancelButton),
    PushButton(
      Id(:accept),
      Opt(:key_F10, :default, :okButton),
      Label.AcceptButton
    )
  )
end

#CancelOKButtonBoxObject

Returns a button box with buttons "Cancel", "OK"

Returns:

  • a widget tree


204
205
206
207
208
209
# File 'library/wizard/src/modules/Wizard.rb', line 204

def CancelOKButtonBox
  ButtonBox(
    PushButton(Id(:cancel), Opt(:key_F9, :cancelButton), Label.CancelButton),
    PushButton(Id(:ok), Opt(:key_F10, :default, :okButton), Label.OKButton)
  )
end

#ClearContentsObject

Note:

This is a stable API function

Clear the wizard contents.

This may sound silly, but it gives much faster feedback to the user if used properly: Whenever the user clicks "Next" or "Back", call ClearContents() prior to any lengthy operation -> the user notices instant response, even though he may in fact still have to wait.


855
856
857
858
859
# File 'library/wizard/src/modules/Wizard.rb', line 855

def ClearContents
  SetContents("", Empty(), "", false, false)

  nil
end

#ClearTitleIconObject

Note:

Deprecated. Do nothing.

Clear the wizard 'title' icon, i.e. replace it with nothing

See Also:


1100
1101
1102
# File 'library/wizard/src/modules/Wizard.rb', line 1100

def ClearTitleIcon
  nil
end

#CloseDialogObject

Note:

This is a stable API function

Close a wizard dialog.


660
661
662
663
664
665
666
667
668
669
670
# File 'library/wizard/src/modules/Wizard.rb', line 660

def CloseDialog
  if IsWizardDialog()
    UI.CloseDialog
  else
    Builtins.y2error(
      "Wizard::CloseDialog(): Topmost dialog is not a wizard dialog!"
    )
  end

  nil
end

#CreateDialogObject

Create and open a typical installation wizard dialog.

For backwards compatibility only - don't use this any more in new modules.


775
776
777
778
779
780
781
782
783
# File 'library/wizard/src/modules/Wizard.rb', line 775

def CreateDialog
  # Set productname for help text
  @product_name = OSRelease.ReleaseName if @product_name == ""
  UI.SetProductName(@product_name)

  OpenNextBackDialog()

  nil
end

#CreateMenu(menu) ⇒ void

This method returns an undefined value.

Create the menu in the dialog

Parameters:

  • Menu (Array<Hash>)

    Menu data


1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
# File 'library/wizard/src/modules/Wizard.rb', line 1703

def CreateMenu(menu)
  menu = deep_copy(menu)
  if !haveFancyUI
    menu_term = HBox()
    Builtins.foreach(menu) do |m|
      if Ops.get_string(m, "type", "") == "Menu"
        menu_items = CreateMenuInternal(menu, Ops.get_string(m, "id", ""))
        Builtins.y2debug("menu_items: %1", menu_items)
        menu_term = Builtins.add(
          menu_term,
          MenuButton(Ops.get_string(m, "title", ""), menu_items)
        )
      end
    end
    Builtins.y2milestone("menu: %1", menu_term)
    UI.ReplaceWidget(Id(:topmenu), Left(menu_term))
  end
  nil
end

#CreateMenuInternal(menu, parent) ⇒ Array

Create the Menu Items

Parameters:

  • Menu (Array<Hash>)

    Menu data

  • parent (String)

    Menu Parent

Returns:

  • (Array)

    Menu Items


1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
# File 'library/wizard/src/modules/Wizard.rb', line 1676

def CreateMenuInternal(menu, parent)
  menu = deep_copy(menu)
  m = Builtins.filter(menu) do |c|
    Ops.get_string(c, "parent", "") == parent
  end

  mm = Builtins.maplist(m) do |cc|
    if Ops.get_string(cc, "type", "") == "MenuEntry"
      menu_entry = Ops.get_string(cc, "id", "")
      next Item(Id(menu_entry), Ops.get_string(cc, "title", ""))
    elsif Ops.get_string(cc, "type", "") == "SubMenu"
      sub_menu = Ops.get_string(cc, "id", "")
      next term(
        :menu,
        Ops.get_string(cc, "title", ""),
        CreateMenuInternal(menu, sub_menu)
      )
    end
  end
  Builtins.y2debug("items: %1", mm)
  deep_copy(mm)
end

#CreateTree(tree, title) ⇒ Object

Create the tree in the dialog, replaces helpspace with new tree widget

Parameters:

  • Tree (Array<Hash>)

    Tree data

  • title (String)

    Tree title


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
# File 'library/wizard/src/modules/Wizard.rb', line 1543

def CreateTree(tree, title)
  tree = deep_copy(tree)
  if !haveFancyUI
    items = []
    Builtins.foreach(tree) do |i|
      if Ops.get_string(i, "parent", "") == ""
        items = Builtins.add(
          items,
          Item(
            Id(Ops.get_string(i, "id", "")),
            Ops.get_string(i, "title", ""),
            CreateTreeInternal(tree, Ops.get_string(i, "id", ""))
          )
        )
      end
    end
    Builtins.y2debug("tree items: %1", items)

    ReplaceCustomHelp(
      VBox(
        term(:Tree, Id(:wizardTree), Opt(:notify, :vstretch), title, items),
        VSpacing(1)
      )
    )
  end

  nil
end

#CreateTreeDialogObject

Create and open a Tree wizard dialog.

For backwards compatibility only - don't use this any more in new modules.


1471
1472
1473
1474
# File 'library/wizard/src/modules/Wizard.rb', line 1471

def CreateTreeDialog
  OpenTreeNextBackDialog()
  nil
end

#CreateTreeInternal(tree, parent) ⇒ Array

Create the Tree Items

Parameters:

  • Tree (Array<Hash>)

    Tree data

  • parent (String)

    Parent of current Item

Returns:

  • (Array)

    Tree Items


1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'library/wizard/src/modules/Wizard.rb', line 1501

def CreateTreeInternal(tree, parent)
  tree = deep_copy(tree)
  m = Builtins.filter(tree) do |c|
    Ops.get_string(c, "parent", "") == parent
  end
  ccbak = nil # #38596, broken recursion for iterators
  mm = Builtins.maplist(m) do |cc|
    tree_entry = Ops.get_string(cc, "id", "")
    ccbak = deep_copy(cc)
    items = CreateTreeInternal(tree, tree_entry)
    cc = deep_copy(ccbak)
    if Ops.greater_than(Builtins.size(items), 0)
      next Item(
        Id(Ops.get_string(cc, "id", "")),
        Ops.get_string(cc, "title", ""),
        items
      )
    else
      next Item(
        Id(Ops.get_string(cc, "id", "")),
        Ops.get_string(cc, "title", "")
      )
    end
  end
  Builtins.y2debug("items: %1", mm)
  deep_copy(mm)
end

#DeleteMenusObject

Delete Menu items


1596
1597
1598
1599
1600
1601
1602
1603
1604
# File 'library/wizard/src/modules/Wizard.rb', line 1596

def DeleteMenus
  if haveFancyUI
    UI.WizardCommand(term(:DeleteMenus))
  else
    UI.ReplaceWidget(Id(:topmenu), Empty())
  end

  nil
end

#DeleteTreeItemsObject

Delete Tree items


1585
1586
1587
1588
1589
1590
1591
1592
1593
# File 'library/wizard/src/modules/Wizard.rb', line 1585

def DeleteTreeItems
  if haveFancyUI
    UI.WizardCommand(term(:DeleteTreeItems))
  else
    ReplaceCustomHelp(Empty())
  end

  nil
end

#DisableAbortButtonObject

Note:

This is a stable API function

Disable the wizard's "Abort" button.

See Also:


1206
1207
1208
1209
1210
# File 'library/wizard/src/modules/Wizard.rb', line 1206

def DisableAbortButton
  UI.ChangeWidget(Id(:abort), :Enabled, false) if UI.WizardCommand(term(:EnableAbortButton, false)) == false

  nil
end

#DisableBackButtonObject

Note:

This is a stable API function

Disable the wizard's "Back" button.

See Also:


1253
1254
1255
1256
1257
# File 'library/wizard/src/modules/Wizard.rb', line 1253

def DisableBackButton
  UI.ChangeWidget(Id(:back), :Enabled, false) if UI.WizardCommand(term(:EnableBackButton, false)) == false

  nil
end

#DisableCancelButtonObject

Note:

This is a stable API function

Disable the wizard's "Cancel" button.


1275
1276
1277
1278
1279
# File 'library/wizard/src/modules/Wizard.rb', line 1275

def DisableCancelButton
  UI.ChangeWidget(Id(:cancel), :Enabled, false) if UI.WizardCommand(term(:EnableCancelButton, false)) == false

  nil
end

#DisableNextButtonObject

Note:

This is a stable API function

Disable the wizard's "Next" (or "Accept") button.

See Also:


1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
# File 'library/wizard/src/modules/Wizard.rb', line 1217

def DisableNextButton
  if UI.WizardCommand(term(:EnableNextButton, false)) == false
    if UI.WidgetExists(Id(:next))
      UI.ChangeWidget(Id(:next), :Enabled, false)
    elsif UI.WidgetExists(Id(:accept))
      UI.ChangeWidget(Id(:accept), :Enabled, false)
    else
      Builtins.y2error(-1, "Neither `next nor `accept widgets exist")
    end
  end

  nil
end

#EnableAbortButtonObject

Note:

This is a stable API function

Enable the wizard's "Abort" button.


1195
1196
1197
1198
1199
# File 'library/wizard/src/modules/Wizard.rb', line 1195

def EnableAbortButton
  UI.ChangeWidget(Id(:abort), :Enabled, true) if UI.WizardCommand(term(:EnableAbortButton, true)) == false

  nil
end

#EnableBackButtonObject

Note:

This is a stable API function

Enable the wizard's "Back" button.

See Also:


1264
1265
1266
1267
1268
# File 'library/wizard/src/modules/Wizard.rb', line 1264

def EnableBackButton
  UI.ChangeWidget(Id(:back), :Enabled, true) if UI.WizardCommand(term(:EnableBackButton, true)) == false

  nil
end

#EnableCancelButtonObject

Note:

This is a stable API function

Enable the wizard's "Cancel" button.


1286
1287
1288
1289
1290
# File 'library/wizard/src/modules/Wizard.rb', line 1286

def EnableCancelButton
  UI.ChangeWidget(Id(:cancel), :Enabled, true) if UI.WizardCommand(term(:EnableCancelButton, true)) == false

  nil
end

#EnableNextButtonObject

Note:

This is a stable API function

Enable the wizard's "Next" (or "Accept") button.

See Also:


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

def EnableNextButton
  if UI.WizardCommand(term(:EnableNextButton, true)) == false
    if UI.WidgetExists(Id(:next))
      UI.ChangeWidget(Id(:next), :Enabled, true)
    else
      UI.ChangeWidget(Id(:accept), :Enabled, true)
    end
  end

  nil
end

#GenericDialog(button_box) ⇒ Yast::Term

Note:

This is a stable API function

Create a Generic Dialog

Returns a term describing a generic wizard dialog with a configurable button box.

Parameters:

  • button_box (Yast::Term)

    term that contains a `HBox() with buttons in it

Returns:

  • (Yast::Term)

    term describing the dialog.


274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'library/wizard/src/modules/Wizard.rb', line 274

def GenericDialog(button_box)
  button_box = deep_copy(button_box)
  VBox(
    Id(:WizardDialog),
    ReplacePoint(Id(:topmenu), Empty()),
    VWeight(
      1, # Layout trick: Lower layout priority with weight
      HBox(
        HSpacing(1),
        VBox(
          VSpacing(0.2),
          HBox(
            # translators: dialog title to appear before any content is initialized
            Heading(Id(:title), Opt(:hstretch), _("Initializing ...")),
            HStretch(),
            ReplacePoint(Id(:relnotes_rp), Empty())
          ),
          VWeight(
            1, # Layout trick: Lower layout priority with weight
            HVCenter(Opt(:hvstretch), ReplacePoint(Id(:contents), Empty()))
          )
        ),
        HSpacing(1)
      )
    ),
    ReplacePoint(Id(:rep_button_box), button_box),
    VSpacing(0.2)
  )
end

#GenericTreeDialog(button_box) ⇒ Yast::Term

Note:

This is a stable API function

Create a Generic Tree Dialog

Returns a term describing a wizard dialog with left menu tree, right contents and a configurable button box.

Parameters:

  • button_box (Yast::Term)

    term that contains a `HBox() with buttons in it

Returns:

  • (Yast::Term)

    term describing the dialog.


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
# File 'library/wizard/src/modules/Wizard.rb', line 317

def GenericTreeDialog(button_box)
  button_box = deep_copy(button_box)
  VBox(
    Id(:WizardDialog),
    ReplacePoint(Id(:topmenu), Empty()),
    HBox(
      HSpacing(1),
      HWeight(
        30,
        ReplacePoint(
          Id(:helpSpace), # `RichText(`id(`HelpText), "")
          Empty()
        )
      ),
      HSpacing(1),
      HWeight(
        70,
        VBox(
          VSpacing(0.2),
          HBox(
            # translators: dialog title to appear before any content is initialized
            Heading(
              Id(:title),
              Opt(:hstretch),
              _("YaST\nInitializing ...\n")
            ),
            HStretch()
          ),
          VWeight(
            1, # Layout trick: Lower layout priority with weight
            HVCenter(Opt(:hvstretch), ReplacePoint(Id(:contents), Empty()))
          )
        )
      ),
      HSpacing(1)
    ),
    ReplacePoint(Id(:rep_button_box), button_box),
    VSpacing(0.2)
  )
end

#HasWidgetWizardBoolean

Returns whether the `Wizard widget is available.

Returns:

  • (Boolean)

    available

See Also:

  • #367213.

1296
1297
1298
1299
1300
1301
1302
1303
# File 'library/wizard/src/modules/Wizard.rb', line 1296

def HasWidgetWizard
  if !UI.HasSpecialWidget(:Wizard)
    Builtins.y2milestone("no Wizard available")
    return false
  end

  true
end

#haveFancyUIObject


71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'library/wizard/src/modules/Wizard.rb', line 71

def haveFancyUI
  if @have_fancy_ui_cache.nil?
    ui_info = UI.GetDisplayInfo

    @have_fancy_ui_cache = UI.HasSpecialWidget(:Wizard) == true &&
      Ops.greater_or_equal(Ops.get_integer(ui_info, "Depth", 0), 15) &&
      Ops.greater_or_equal(Ops.get_integer(ui_info, "DefaultWidth", 0), 800) &&
      # some netbooks use such a strange resolution (fate#306298)
      Ops.greater_or_equal(
        Ops.get_integer(ui_info, "DefaultHeight", 0),
        576
      )

    # have_fancy_ui_cache = false;

    UI.SetFunctionKeys(Label.DefaultFunctionKeyMap)
  end

  @have_fancy_ui_cache
end

#HideAbortButtonObject

Note:

This is a stable API function

Hide the Wizard's "Abort" button. Restore it later with RestoreAbortButton():


982
983
984
985
986
987
988
989
990
991
992
# File 'library/wizard/src/modules/Wizard.rb', line 982

def HideAbortButton
  if UI.WizardCommand(term(:SetAbortButtonLabel, "")) == false
    if UI.WidgetExists(Id(:rep_abort))
      UI.ReplaceWidget(Id(:rep_abort), Empty())
    elsif UI.WidgetExists(Id(:cancel))
      UI.ReplaceWidget(Id(:cancel), Empty())
    end
  end

  nil
end

#HideBackButtonObject

Note:

This is a stable API function

Hide the Wizard's "Back" button. Restore it later with RestoreBackButton():

See Also:


945
946
947
948
949
950
951
# File 'library/wizard/src/modules/Wizard.rb', line 945

def HideBackButton
  if UI.WizardCommand(term(:SetBackButtonLabel, "")) == false
    UI.ReplaceWidget(Id(:rep_back), Empty()) if UI.WidgetExists(Id(:rep_back))
  end

  nil
end

#HideNextButtonObject

Note:

This is a stable API function

Hide the Wizard's "Next" button. Restore it later with RestoreNextButton():

See Also:


931
932
933
934
935
936
937
# File 'library/wizard/src/modules/Wizard.rb', line 931

def HideNextButton
  if UI.WizardCommand(term(:SetNextButtonLabel, "")) == false
    UI.ReplaceWidget(Id(:rep_next), Empty()) if UI.WidgetExists(Id(:rep_next))
  end

  nil
end

#HideReleaseNotesButtonObject

Hide the "Release Notes" button, if there is any


1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
# File 'library/wizard/src/modules/Wizard.rb', line 1332

def HideReleaseNotesButton
  # has wizard? continue
  #    otherwise use dedicated ReplacePoint or reuse the back button
  # hide-releasenotes-button failed? continue
  #   reuse use dedicated ReplacePoint or the back button
  if HasWidgetWizard() == false ||
      UI.WizardCommand(term(:HideReleaseNotesButton)) == false
    @relnotes_button_label = ""
    @relnotes_button_id = ""
    if UI.WidgetExists(Id(:relnotes_rp))
      UI.ReplaceWidget(Id(:relnotes_rp), Empty())
    elsif UI.WidgetExists(Id(:back_rep))
      UI.ReplaceWidget(Id(:back_rep), Empty())
    end
  end

  nil
end

#IsWizardDialogBoolean

Check if the topmost dialog is a wizard dialog (i.e. has a widget with id(WizardDialog) )

Returns:

  • (Boolean)

    True if topmost dialog is a wizard dialog, false otherwise


363
364
365
366
# File 'library/wizard/src/modules/Wizard.rb', line 363

def IsWizardDialog
  UI.WidgetExists(Id(:WizardDialog)) == true ||
    UI.WidgetExists(:wizard) == true
end

#mainObject


35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'library/wizard/src/modules/Wizard.rb', line 35

def main
  Yast.import "UI"
  textdomain "base"

  Yast.import "Desktop"
  Yast.import "Label"
  Yast.import "Popup"
  Yast.import "Directory"
  Yast.import "OSRelease"

  @have_fancy_ui_cache = nil

  # this variable is set from Product:: constructor
  # to setup correct &product; macro in UI
  @product_name = ""

  #
  # Screenshot Functions
  #

  # Currently used screenshot name.
  # Initially, it must match the UI default, "yast2"
  @screenshot_name = "yast2"

  # Screenshot names overriden by nested SetScreenShotName calls
  @screenshot_name_stack = []

  # Handling of relnotes button when creating a wizard over existing one
  # Cannot be handled by libyui for NCurses
  @relnotes_button_label = ""
  @relnotes_button_id = ""

  # Current icon name to set.
  @icon_name = DEFAULT_ICON_NAME
end

#NextBackDialogYast::Term

Note:

This is a stable API function

Returns a standard wizard dialog with buttons "Next", "Back", "Abort".

Returns:

  • (Yast::Term)

    describing the dialog.


392
393
394
# File 'library/wizard/src/modules/Wizard.rb', line 392

def NextBackDialog
  GenericDialog(BackAbortNextButtonBox())
end

#OKDialogYast::Term

Note:

This is a stable API function

Returns a standard wizard dialog with buttons "Cancel", "OK"

Returns:

  • (Yast::Term)

    describing the dialog.


412
413
414
# File 'library/wizard/src/modules/Wizard.rb', line 412

def OKDialog
  GenericDialog(CancelOKButtonBox())
end

#open_wizard_dialog(*args) ⇒ Object (protected)

Sets the icon and opens a wizard dialog with the content specified as arguments


1823
1824
1825
1826
1827
1828
1829
# File 'library/wizard/src/modules/Wizard.rb', line 1823

def open_wizard_dialog(*args)
  set_icon
  UI.OpenDialog(
    Opt(:wizardDialog),
    Wizard(*args)
  )
end

#OpenAbortApplyFinishDialogObject

Open a dialog with "Accept", "Cancel" and set the keyboard focus to "Accept".


504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
# File 'library/wizard/src/modules/Wizard.rb', line 504

def OpenAbortApplyFinishDialog
  if haveFancyUI
    open_wizard_dialog(
      :apply,
      _("&Apply"),
      :abort,
      Label.AbortButton,
      :finish,
      Label.FinishButton
    )
  else
    OpenDialog(GenericDialog(AbortApplyFinishButtonBox()))
    UI.SetFocus(Id(:finish))
  end

  nil
end

#OpenAcceptAbortStepsDialogObject

Open a dialog with "Accept", "Cancel" that will also accept workflow steps.


547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
# File 'library/wizard/src/modules/Wizard.rb', line 547

def OpenAcceptAbortStepsDialog
  if haveFancyUI
    open_wizard_dialog(
      Opt(:stepsEnabled),
      :no_back_button,
      "",
      :abort,
      Label.AbortButton,
      :accept,
      Label.AcceptButton
    )

    # Don't let sloppy calls to Wizard::SetContents() disable this button by accident
    UI.WizardCommand(term(:ProtectNextButton, true))
  else
    OpenDialog(GenericDialog(AbortAcceptButtonBox()))
  end

  nil
end

#OpenAcceptDialogObject

Open a dialog with "Accept", "Cancel" and set the keyboard focus to "Accept".


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
# File 'library/wizard/src/modules/Wizard.rb', line 456

def OpenAcceptDialog
  if haveFancyUI
    open_wizard_dialog(
      :no_back_button,
      "",
      :cancel,
      Label.CancelButton,
      :accept,
      Label.AcceptButton
    )

    # Don't let sloppy calls to Wizard::SetContents() disable this button by accident
    UI.WizardCommand(term(:ProtectNextButton, true))
  else
    OpenDialog(AcceptDialog())
    UI.SetFocus(Id(:accept))
  end

  nil
end

#OpenAcceptStepsDialogObject

Open a dialog with "Accept", "Cancel" that will also accept workflow steps.


524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
# File 'library/wizard/src/modules/Wizard.rb', line 524

def OpenAcceptStepsDialog
  if haveFancyUI
    open_wizard_dialog(
      Opt(:stepsEnabled),
      :no_back_button,
      "",
      :cancel,
      Label.CancelButton,
      :accept,
      Label.AcceptButton
    )

    # Don't let sloppy calls to Wizard::SetContents() disable this button by accident
    UI.WizardCommand(term(:ProtectNextButton, true))
  else
    OpenAcceptDialog()
  end

  nil
end

#OpenCancelOKDialogObject

Overview Dialog http://en.opensuse.org/YaST/Style_Guide#Single_Configuration.2FOverview.2FEdit_Dialog dialog with Cancel and OK buttons (cancel has function as abort)


957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
# File 'library/wizard/src/modules/Wizard.rb', line 957

def OpenCancelOKDialog
  if haveFancyUI
    open_wizard_dialog(
      :back,
      Label.BackButton,
      :abort,
      Label.CancelButton,
      :next,
      Label.OKButton
    )
    HideBackButton()
  else
    OpenDialog(NextBackDialog())
    UI.SetFocus(Id(:next))
  end

  nil
end

#OpenCustomDialog(help_space_contents, button_box) ⇒ void

This method returns an undefined value.

Open a wizard dialog with simple layout

no graphics, no steps, only a help widget buttons (by default "Back", "Abort", "Next").

This is the only type of wizard dialog which still allows replacing the help space - either already upon opening it or later with Wizard::ReplaceCustomHelp().

If help_space_contents is 'nil', the normal help widget will remain. If button_box is 'nil', Wizard::BackAbortNextButtonBox() is used.

Parameters:

  • help_space_contents (Yast::Term)

    Help space contents

  • button_box (Yast::Term)

    Buttom Box

See Also:


627
628
629
630
631
632
633
634
635
636
637
638
# File 'library/wizard/src/modules/Wizard.rb', line 627

def OpenCustomDialog(help_space_contents, button_box)
  help_space_contents = deep_copy(help_space_contents)
  button_box = deep_copy(button_box)
  button_box = BackAbortNextButtonBox() if button_box.nil?

  set_icon
  UI.OpenDialog(Opt(:wizardDialog), GenericDialog(button_box))

  UI.ReplaceWidget(Id(:helpSpace), help_space_contents) if !help_space_contents.nil?

  nil
end

#OpenDialog(dialog) ⇒ Object

Note:

This is a stable API function

Open any wizard dialog.

Parameters:

  • dialog (Yast::Term)

    a wizard dialog, e.g. Wizard::GenericDialog()


422
423
424
425
426
427
428
429
430
# File 'library/wizard/src/modules/Wizard.rb', line 422

def OpenDialog(dialog)
  dialog = deep_copy(dialog)

  set_icon
  UI.OpenDialog(Opt(:wizardDialog), dialog)
  ShowReleaseNotesButton(@relnotes_button_label, @relnotes_button_id) if !@relnotes_button_id.empty?

  nil
end

#OpenLeftTitleNextBackDialogObject

Open a dialog with "Back", "Next", "Abort" that has the title on the left, as wanted by the installation visual design


591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
# File 'library/wizard/src/modules/Wizard.rb', line 591

def OpenLeftTitleNextBackDialog
  if haveFancyUI
    open_wizard_dialog(
      Opt(:titleOnLeft),
      :back,
      Label.BackButton,
      :abort,
      Label.AbortButton,
      :next,
      Label.NextButton
    )
  else
    OpenNextBackDialog()
  end

  nil
end

#OpenNextBackDialogObject

Open a dialog with buttons "Next", "Back", "Abort" and set the keyboard focus to "Next".


435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
# File 'library/wizard/src/modules/Wizard.rb', line 435

def OpenNextBackDialog
  if haveFancyUI
    open_wizard_dialog(
      :back,
      Label.BackButton,
      :abort,
      Label.AbortButton,
      :next,
      Label.NextButton
    )
  else
    OpenDialog(NextBackDialog())
    UI.SetFocus(Id(:next))
  end

  nil
end

#OpenNextBackStepsDialogObject

Open a dialog with "Back", "Next", "Abort" that will also accept workflow steps.


570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'library/wizard/src/modules/Wizard.rb', line 570

def OpenNextBackStepsDialog
  if haveFancyUI
    open_wizard_dialog(
      Opt(:stepsEnabled),
      :back,
      Label.BackButton,
      :abort,
      Label.AbortButton,
      :next,
      Label.NextButton
    )
  else
    OpenNextBackDialog()
  end

  nil
end

#OpenOKDialogObject

Open a dialog with "OK", "Cancel" and set the keyboard focus to "OK".


480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
# File 'library/wizard/src/modules/Wizard.rb', line 480

def OpenOKDialog
  if haveFancyUI
    open_wizard_dialog(
      :no_back_button,
      "",
      :cancel,
      Label.CancelButton,
      :ok,
      Label.OKButton
    )

    # Don't let sloppy calls to Wizard::SetContents() disable this button by accident
    UI.WizardCommand(term(:ProtectNextButton, true))
  else
    OpenDialog(OKDialog())
    UI.SetFocus(Id(:ok))
  end

  nil
end

#OpenTreeNextBackDialogObject

Open a Tree dialog with buttons "Next", "Back", "Abort" and set the keyboard focus to "Next".


1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
# File 'library/wizard/src/modules/Wizard.rb', line 1448

def OpenTreeNextBackDialog
  if haveFancyUI
    open_wizard_dialog(
      Opt(:treeEnabled),
      :back,
      Label.BackButton,
      :abort,
      Label.AbortButton,
      :next,
      Label.NextButton
    )
  else
    OpenDialog(GenericTreeDialog(BackAbortNextButtonBox()))
    UI.SetFocus(Id(:next))
  end

  nil
end

#QueryTreeItemObject

Query Tree Item

Returns:

  • Tree Item


1531
1532
1533
1534
1535
1536
1537
# File 'library/wizard/src/modules/Wizard.rb', line 1531

def QueryTreeItem
  if haveFancyUI
    Convert.to_string(UI.QueryWidget(Id(:wizard), :CurrentItem))
  else
    Convert.to_string(UI.QueryWidget(Id(:wizardTree), :CurrentItem))
  end
end

#ReplaceButtonBox(button_box) ⇒ void

This method returns an undefined value.

PRIVATE - Replace the entire Wizard button box with a new one.

Parameters:

  • button_box (Yast::Term)

    Button Box term


1183
1184
1185
1186
1187
1188
# File 'library/wizard/src/modules/Wizard.rb', line 1183

def ReplaceButtonBox(button_box)
  button_box = deep_copy(button_box)
  UI.ReplaceWidget(Id(:rep_button_box), button_box)

  nil
end

#ReplaceCustomHelp(contents) ⇒ Object

Replace the help widget for dialogs opened with Wizard::OpenCustomDialog().

Parameters:

  • contents (Yast::Term)

    Replace custom help with supplied contents


643
644
645
646
647
648
649
650
651
652
653
654
# File 'library/wizard/src/modules/Wizard.rb', line 643

def ReplaceCustomHelp(contents)
  contents = deep_copy(contents)
  if UI.WidgetExists(Id(:helpSpace))
    UI.ReplaceWidget(Id(:helpSpace), contents)
  else
    Builtins.y2error(
      "Wizard::ReplaceHelpSpace() works only for dialogs opened with Wizard::OpenSimpleDialog() !"
    )
  end

  nil
end

#ReplaceHelp(contents) ⇒ Object

Deprecated.

Replace the wizard help subwindow with a custom widget.

Parameters:

  • contents (Yast::Term)

    Replace Help with contents


748
749
750
751
752
753
754
755
756
757
758
759
760
# File 'library/wizard/src/modules/Wizard.rb', line 748

def ReplaceHelp(contents)
  contents = deep_copy(contents)
  if UI.WidgetExists(Id(:helpSpace))
    Builtins.y2warning("Wizard::ReplaceHelp() is deprecated!")
    UI.ReplaceWidget(Id(:helpSpace), contents)
  else
    Builtins.y2error(
      "Wizard::ReplaceHelp() is not supported by the new Qt wizard!"
    )
  end

  nil
end

#RestoreAbortButtonObject

Note:

This is a stable API function

Restore the wizard 'abort' button.

See Also:


1021
1022
1023
1024
1025
# File 'library/wizard/src/modules/Wizard.rb', line 1021

def RestoreAbortButton
  SetAbortButton(:abort, Label.AbortButton)

  nil
end

#RestoreBackButtonObject

Note:

This is a stable API function

Restore the wizard 'back' button.

See Also:


999
1000
1001
1002
1003
# File 'library/wizard/src/modules/Wizard.rb', line 999

def RestoreBackButton
  SetBackButton(:back, Label.BackButton)

  nil
end

#RestoreHelp(help_text) ⇒ Object

Restore the wizard help subwindow.

Parameters:

  • help_text (String)

    Help text


765
766
767
768
769
# File 'library/wizard/src/modules/Wizard.rb', line 765

def RestoreHelp(help_text)
  SetHelpText(help_text)

  nil
end

#RestoreNextButtonObject

Note:

This is a stable API function

Restore the wizard 'next' button.

See Also:


1010
1011
1012
1013
1014
# File 'library/wizard/src/modules/Wizard.rb', line 1010

def RestoreNextButton
  SetNextButton(:next, Label.NextButton)

  nil
end

#RestoreScreenShotNameObject

Restore the screenshot name.

If it does not match a SetScreenShotName, "yast2" is used and a y2error logged.


1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
# File 'library/wizard/src/modules/Wizard.rb', line 1429

def RestoreScreenShotName
  @screenshot_name = Ops.get(@screenshot_name_stack, 0)
  if @screenshot_name.nil?
    @screenshot_name = "yast2"
    Builtins.y2error(1, "No screenshot name to restore!")
  else
    @screenshot_name_stack = Builtins.remove(@screenshot_name_stack, 0)
  end

  nil
end

#RetranslateButtonsObject

Retranslate the wizard buttons.

This will revert button labels and IDs to the default that were used upon Wizard::CreateDialog(), Wizard::OpenNextBackDialog(), or Wizard::OpenAcceptDialog().


1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
# File 'library/wizard/src/modules/Wizard.rb', line 1357

def RetranslateButtons
  if UI.WidgetExists(Id(:WizardDialog)) == true
    ReplaceButtonBox(
      if UI.WidgetExists(Id(:accept))
        AbortAcceptButtonBox()
      else
        BackAbortNextButtonBox()
      end
    ) # Qt wizard
  else
    UI.WizardCommand(term(:RetranslateInternalButtons))

    if UI.WidgetExists(:accept)
      UI.WizardCommand(term(:SetBackButtonLabel, ""))
      UI.WizardCommand(term(:SetAbortButtonLabel, Label.AbortButton))
      UI.WizardCommand(term(:SetNextButtonLabel, Label.AcceptButton))
    else
      UI.WizardCommand(term(:SetBackButtonLabel, Label.BackButton))
      UI.WizardCommand(term(:SetAbortButtonLabel, Label.AbortButton))
      UI.WizardCommand(term(:SetNextButtonLabel, Label.NextButton))
    end
  end

  nil
end

#SelectTreeItem(tree_item) ⇒ Object

Select Tree item

Parameters:

  • tree_item (String)

    tree item


1574
1575
1576
1577
1578
1579
1580
1581
1582
# File 'library/wizard/src/modules/Wizard.rb', line 1574

def SelectTreeItem(tree_item)
  if haveFancyUI
    UI.WizardCommand(term(:SelectTreeItem, tree_item))
  else
    UI.ChangeWidget(Id(:wizardTree), :CurrentItem, tree_item)
  end

  nil
end

#set_iconBoolean (protected)

Sets the application icon according to the value of @icon_name

This should be called only immediately before opening a dialog; premature UI calls can interfere with the CommandLine mode.

Returns:

  • (Boolean)

    true if the application icon was set; false otherwise


1837
1838
1839
1840
# File 'library/wizard/src/modules/Wizard.rb', line 1837

def set_icon
  UI.SetApplicationIcon(@icon_name)
  true
end

#SetAbortButton(id, label) ⇒ Object

Note:

This is a stable API function

Set the dialog's "Abort" button with a new label and a new ID

Parameters:

  • id (Object)

    Button ID

  • label (String)

    Button Label


910
911
912
913
914
915
916
917
918
919
920
921
922
923
# File 'library/wizard/src/modules/Wizard.rb', line 910

def SetAbortButton(id, label)
  id = deep_copy(id)

  if UI.WizardCommand(term(:SetAbortButtonLabel, label)) == true
    UI.WizardCommand(term(:SetAbortButtonID, id))
  elsif UI.WidgetExists(Id(:rep_abort))
    UI.ReplaceWidget(
      Id(:rep_abort),
      PushButton(Id(id), Opt(:key_F9), label)
    )
  end

  nil
end

#SetBackButton(id, label) ⇒ Object

Note:

This is a stable API function

Set the dialog's "Back" button with a new label and a new ID

Parameters:

  • id (Object)

    Button ID

  • label (String)

    Button Label


889
890
891
892
893
894
895
896
897
898
899
900
901
# File 'library/wizard/src/modules/Wizard.rb', line 889

def SetBackButton(id, label)
  id = deep_copy(id)
  if UI.WizardCommand(term(:SetBackButtonLabel, label)) == true
    UI.WizardCommand(term(:SetBackButtonID, id))
  elsif UI.WidgetExists(Id(:rep_back))
    UI.ReplaceWidget(
      Id(:rep_back),
      PushButton(Id(id), Opt(:key_F8), label)
    )
  end

  nil
end

#SetContents(title, contents, help_text, has_back, has_next) ⇒ Object

Note:

This is a stable API function

Set the contents of a wizard dialog

How the general framework for the installation wizard should look like. This function creates and shows a dialog.

screenshots/wizard1.png

Parameters:

  • title (String)

    Dialog Title

  • contents (Yast::Term)

    The Dialog contents

  • help_text (String)

    Help text

  • has_back (Boolean)

    Is the Back button enabled?

  • has_next (Boolean)

    Is the Next button enabled?

See Also:

  • file doc/examples/wizard1.rb

838
839
840
841
842
843
# File 'library/wizard/src/modules/Wizard.rb', line 838

def SetContents(title, contents, help_text, has_back, has_next)
  contents = deep_copy(contents)
  SetContentsFocus(title, contents, help_text, has_back, has_next, true)

  nil
end

#SetContentsButtons(title, contents, help_text, back_label, next_label) ⇒ Object

Set contents and Buttons of wizard dialog

Additionally set its title, help_text and buttons labels. Enables both back and next button.

Parameters:

  • title (String)

    title of window

  • contents (Yast::Term)

    contents of dialog

  • help_text (String)

    help text

  • back_label (String)

    label of back button

  • next_label (String)

    label of next button


1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
# File 'library/wizard/src/modules/Wizard.rb', line 1039

def SetContentsButtons(title, contents, help_text, back_label, next_label)
  contents = deep_copy(contents)
  UI.PostponeShortcutCheck

  RestoreBackButton()
  RestoreNextButton()

  if UI.WizardCommand(term(:SetBackButtonLabel, back_label)) == true
    UI.WizardCommand(term(:SetNextButtonLabel, next_label))
  else
    # Set button labels first to avoid geometry problems: SetContents()
    # calls ReplaceWidget() wich triggers a re-layout.

    UI.ChangeWidget(Id(:back), :Label, back_label) if UI.WidgetExists(Id(:back))
    UI.ChangeWidget(Id(:next), :Label, next_label) if UI.WidgetExists(Id(:next))
  end

  SetContents(title, contents, help_text, true, true)
  SetHelpText(help_text)
  UI.CheckShortcuts

  nil
end

#SetContentsFocus(title, contents, help_text, has_back, has_next, set_focus) ⇒ Object

Set the contents of a wizard dialog and define if to move focus to next button

How the general framework for the installation wizard should look like. This function creates and shows a dialog.

Parameters:

  • title (String)

    Dialog Title

  • contents (Yast::Term)

    The Dialog contents

  • help_text (String)

    Help text

  • has_back (Boolean)

    Is the Back button enabled?

  • has_next (Boolean)

    Is the Next button enabled?

  • set_focus (Boolean)

    Should the focus be set to Next button?


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
# File 'library/wizard/src/modules/Wizard.rb', line 797

def SetContentsFocus(title, contents, help_text, has_back, has_next, set_focus)
  contents = deep_copy(contents)
  if UI.WizardCommand(term(:SetDialogHeading, title)) == true
    UI.WizardCommand(term(:SetHelpText, help_text))
    UI.WizardCommand(term(:EnableNextButton, has_next))
    UI.WizardCommand(term(:EnableBackButton, has_back))
    UI.WizardCommand(term(:SetFocusToNextButton)) if set_focus
  else
    if UI.WidgetExists(Id(:next))
      UI.ChangeWidget(Id(:next), :Enabled, has_next)
      UI.SetFocus(Id(:next))
    end

    UI.ChangeWidget(Id(:back), :Enabled, has_back) if UI.WidgetExists(Id(:back))
    UI.ChangeWidget(Id(:abort), :Enabled, true) if UI.WidgetExists(Id(:abort))
    UI.ChangeWidget(Id(:title), :Value, title) if UI.WidgetExists(Id(:title))

    UI.SetFocus(Id(:accept)) if set_focus && UI.WidgetExists(Id(:accept))
  end

  SetHelpText(help_text)
  UI.ReplaceWidget(Id(:contents), contents)

  nil
end

#SetDesktopIcon(file) ⇒ Boolean

Sets the icon specified in a .desktop file got as parameter. Desktop file is placed in a special directory (/usr/share/applications/YaST2). Parameter file is realative to that directory without ".desktop" suffix. Warning: There are no desktop files in inst-sys. Use "SetTitleIcon" instead.

Examples:

// Opens /usr/share/applications/YaST2/lan.desktop
// Reads "Icon" entry from there
// Sets the icon.
SetDesktopIcon ("lan")

Parameters:

Returns:

  • (Boolean)

    true on success


1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
# File 'library/wizard/src/modules/Wizard.rb', line 1141

def SetDesktopIcon(file)
  description = Desktop.ParseSingleDesktopFile(file)
  return false unless description

  icon = description["Icon"].to_s
  return false if icon.empty?

  @icon_name = icon
  set_icon
end

#SetDesktopTitle(file) ⇒ Boolean

Sets the window title according to the name specified in a .desktop file got as parameter. Desktop file is placed in a special directory (/usr/share/applications/YaST2). Parameter file is realative to that directory without ".desktop" suffix.

Examples:

// Opens /usr/share/applications/YaST2/lan.desktop
// Reads (localized) "name" entry from there
// Sets the window title.
SetDesktopTitle ("lan")

Parameters:

  • file (String)

    desktop file

Returns:

  • (Boolean)

    true on success


1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
# File 'library/wizard/src/modules/Wizard.rb', line 1116

def SetDesktopTitle(file)
  description = Desktop.ParseSingleDesktopFile(file)

  # fallback name for the dialog title
  name = Ops.get(description, "Name", _("Module"))

  Builtins.y2debug("Set dialog title: %1", name)
  SetDialogTitle(name)

  Builtins.haskey(description, "Name")
end

#SetDesktopTitleAndIcon(file) ⇒ Boolean

Convenience function to avoid 2 calls if application needs to set both dialog title and icon from desktop file specified as parameter. Desktop file is placed in a special directory (/usr/share/applications/YaST2). Parameter file is realative to that directory without ".desktop" suffix. Warning: There are no desktop files in inst-sys.

Examples:

// Opens /usr/share/applications/YaST2/lan.desktop
// Reads "Icon" and "Name" entries from there
// Sets the icon, sets the dialog title
SetDialogTitleAndIcon ("lan")

Parameters:

  • file (String)

    desktop file name

Returns:

  • (Boolean)

    true on success


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

def SetDesktopTitleAndIcon(file)
  description = Desktop.ParseSingleDesktopFile(file)

  # fallback name for the dialog title
  name = Ops.get(description, "Name", _("Module"))

  Builtins.y2debug("Set dialog title: %1", name)
  SetDialogTitle(name)
  SetDesktopIcon(file)

  Builtins.haskey(description, "Name")
end

#SetDialogTitle(title_text) ⇒ Object

Sets the dialog title shown in the window manager's title bar.

Examples:

SetDialogTitle ("DNS Server Configuration");

Parameters:

  • title_text (String)

    title of the dialog


1070
1071
1072
1073
1074
1075
1076
1077
1078
# File 'library/wizard/src/modules/Wizard.rb', line 1070

def SetDialogTitle(title_text)
  # backward compatibility with showing just YaST2 in qt
  # see bsc#1033161 comment#4
  UI.SetApplicationTitle("YaST2") if haveFancyUI

  UI.WizardCommand(term(:SetDialogTitle, title_text))

  nil
end

#SetFocusToBackButtonObject

Note:

This is a stable API function

Set the keyboard focus to the wizard's "Back" (or "Cancel") button.


1399
1400
1401
1402
1403
1404
1405
# File 'library/wizard/src/modules/Wizard.rb', line 1399

def SetFocusToBackButton
  if UI.WizardCommand(term(:SetFocusToBackButton)) == false
    UI.SetFocus(UI.WidgetExists(Id(:back)) ? Id(:back) : Id(:cancel))
  end

  nil
end

#SetFocusToNextButtonObject

Note:

This is a stable API function

Set the keyboard focus to the wizard's "Next" (or "Accept") button.


1387
1388
1389
1390
1391
1392
1393
# File 'library/wizard/src/modules/Wizard.rb', line 1387

def SetFocusToNextButton
  if UI.WizardCommand(term(:SetFocusToNextButton)) == false
    UI.SetFocus(UI.WidgetExists(Id(:next)) ? Id(:next) : Id(:accept))
  end

  nil
end

#SetHelpText(help_text) ⇒ Object

Set a new help text.

Examples:

Wizard::SetHelpText("This is a help Text");

Parameters:

  • help_text (String)

    Help text


737
738
739
740
741
# File 'library/wizard/src/modules/Wizard.rb', line 737

def SetHelpText(help_text)
  UI.ChangeWidget(Id(:WizardDialog), :HelpText, help_text) if UI.WizardCommand(term(:SetHelpText, help_text)) == false

  nil
end

#SetNextButton(id, label) ⇒ Object

Note:

This is a stable API function

Set the dialog's "Next" button with a new label and a new ID

Parameters:

  • id (Object)

    Button ID

  • label (String)

    Button Label


868
869
870
871
872
873
874
875
876
877
878
879
880
# File 'library/wizard/src/modules/Wizard.rb', line 868

def SetNextButton(id, label)
  id = deep_copy(id)
  if UI.WizardCommand(term(:SetNextButtonLabel, label)) == true
    UI.WizardCommand(term(:SetNextButtonID, id))
  elsif UI.WidgetExists(Id(:rep_next))
    UI.ReplaceWidget(
      Id(:rep_next),
      PushButton(Id(id), Opt(:key_F10, :default), label)
    )
  end

  nil
end

#SetProductName(name) ⇒ void

This method returns an undefined value.

Set the product name for UI

Parameters:

  • name (String)

    the product name


1727
1728
1729
1730
1731
1732
1733
# File 'library/wizard/src/modules/Wizard.rb', line 1727

def SetProductName(name)
  Builtins.y2milestone("Setting product name to '%1'", name)
  @product_name = name
  UI.SetProductName(@product_name)

  nil
end

#SetScreenShotName(name) ⇒ Object

Set a name for the current dialog:

Declare a name for the current dialog to ease making screenshots. By convention, the name is {rpm-name-without-yast2}-{sorting-prefix}-{description} The calls may be nested.

Parameters:

  • s

    eg. "mail-1-conntype"

See Also:


1415
1416
1417
1418
1419
1420
1421
1422
1423
# File 'library/wizard/src/modules/Wizard.rb', line 1415

def SetScreenShotName(name)
  @screenshot_name_stack = Builtins.prepend(
    @screenshot_name_stack,
    @screenshot_name
  )
  @screenshot_name = name

  nil
end

#SetTitleIcon(_icon_name) ⇒ Object

Note:

Deprecated. Do nothing.

Sets the wizard 'title' icon to the specified icon from the standard icon directory.

Examples:

SetTitleIcon ("yast-dns-server");

Parameters:

  • icon_name (String)

    name (without path) of the new icon

See Also:


1091
1092
1093
# File 'library/wizard/src/modules/Wizard.rb', line 1091

def SetTitleIcon(_icon_name)
  nil
end

#ShowHelp(help_text) ⇒ Object

Note:

This is a stable API function

Open a popup dialog that displays a help text (rich text format).

Parameters:

  • help_text (String)

    the text to display


374
375
376
377
378
379
380
381
382
383
384
# File 'library/wizard/src/modules/Wizard.rb', line 374

def ShowHelp(help_text)
  Popup.LongText(
    # Heading for help popup window
    _("Help"),
    RichText(help_text),
    50,
    20
  )

  nil
end

#ShowReleaseNotesButton(label, id) ⇒ Object

Show a "Release Notes" button with the specified label and ID if there is a "steps" panel


1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
# File 'library/wizard/src/modules/Wizard.rb', line 1307

def ShowReleaseNotesButton(label, id)
  # has wizard? continue
  #   otherwise use dedicated ReplacePoint or reuse the back button
  # show-releasenotes-button failed? continue
  #   use dedicated ReplacePoint or reuse the back button
  if HasWidgetWizard() == false ||
      UI.WizardCommand(term(:ShowReleaseNotesButton, label, id)) == false
    @relnotes_button_label = label
    @relnotes_button_id = id
    if UI.WidgetExists(Id(:relnotes_rp))
      UI.ReplaceWidget(Id(:relnotes_rp), PushButton(Id(id), Opt(:relNotesButton), label))
    # Reuse Back button
    # TODO: can this situation happen
    elsif UI.WidgetExists(Id(:back_rep))
      UI.ReplaceWidget(Id(:back_rep), PushButton(Id(id), label))
    else
      Builtins.y2warning("Widget `back_rep does not exist")
    end
  end

  nil
end

#TimeoutUserInput(timeout_millisec) ⇒ Object

Substitute for UI::TimeoutUserInput

Analogical to Wizard::UserInput.

Parameters:

  • timeout_millisec (Fixnum)

698
699
700
701
702
703
704
705
# File 'library/wizard/src/modules/Wizard.rb', line 698

def TimeoutUserInput(timeout_millisec)
  input = UI.TimeoutUserInput(timeout_millisec)

  return :next if input == :accept
  return :back if input == :cancel

  deep_copy(input)
end

#TimeoutWaitForEvent(timeout_millisec) ⇒ Object

Substitute for UI::WaitForEvent with timeout

Analog to Wizard::UserInput.


724
725
726
727
728
729
730
731
# File 'library/wizard/src/modules/Wizard.rb', line 724

def TimeoutWaitForEvent(timeout_millisec)
  input = UI.WaitForEvent(timeout_millisec)

  Ops.set(input, "ID", :next) if Ops.get(input, "ID") == :accept
  Ops.set(input, "ID", :back) if Ops.get(input, "ID") == :cancel

  deep_copy(input)
end

#UserInputmaybe normalized

Substitute for UI::UserInput

This function transparently handles different variations of the wizard layout. Returns next ifnext or accept were clicked,back if back orcancel were clicked. Simply replace ret = UI::UserInput() with ret = Wizard::UserInput()

Returns:

  • (maybe normalized)

    widget ID


683
684
685
686
687
688
689
690
# File 'library/wizard/src/modules/Wizard.rb', line 683

def UserInput
  input = UI.UserInput

  return :next if input == :accept
  return :back if input == :cancel

  deep_copy(input)
end

#WaitForEventObject

Substitute for UI::WaitForEvent

Analog to Wizard::UserInput.


711
712
713
714
715
716
717
718
# File 'library/wizard/src/modules/Wizard.rb', line 711

def WaitForEvent
  input = UI.WaitForEvent

  Ops.set(input, "ID", :next) if Ops.get(input, "ID") == :accept
  Ops.set(input, "ID", :back) if Ops.get(input, "ID") == :cancel

  deep_copy(input)
end