Class: Yast::CWMTabClass

Inherits:
Module
  • Object
show all
Defined in:
library/cwm/src/modules/CWMTab.rb

Instance Method Summary collapse

Instance Method Details

#CleanUp(_key) ⇒ Object

Clean up function of the widget

Parameters:

  • key (String)

    the widget key (ignored)


232
233
234
235
236
237
238
# File 'library/cwm/src/modules/CWMTab.rb', line 232

def CleanUp(_key)
  TabCleanup(@current_tab_map)
  @last_tab_id = @current_tab_id
  Pop()

  nil
end

#CreateWidget(settings) ⇒ Hash

Get the widget description map

Parameters:

  • tab_order

    a list of the IDs of the tabs

  • tabs

    a map of all tabs (key is tab ID, value is a map describing the tab

  • initial_tab

    string the tab tha will be displayed as the first

  • widget_descr

    description map of all widgets that are present in any of the tabs

  • tab_help

    strign general help to the tab widget

Returns:

  • (Hash)

    the widget description map


335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
# File 'library/cwm/src/modules/CWMTab.rb', line 335

def CreateWidget(settings)
  settings = deep_copy(settings)
  tab_order = Ops.get_list(settings, "tab_order", [])
  tabs = Ops.get_map(settings, "tabs", {})
  initial_tab = Ops.get_string(settings, "initial_tab", "")
  widget_descr = Ops.get_map(settings, "widget_descr", {})
  tab_help = Ops.get_string(settings, "tab_help", "")

  widget = nil
  rp = ReplacePoint(Id(:_cwm_tab_contents_rp), @empty_tab)

  # widget
  if UI.HasSpecialWidget(:DumbTab)
    panes = Builtins.maplist(tab_order) do |t|
      label = Ops.get_string(tabs, [t, "header"], @default_tab_header)
      Item(Id(t), label, t == initial_tab)
    end
    widget = DumbTab(Id(:_cwm_tab), panes, rp)
  else
    tabbar = HBox()
    Builtins.foreach(tab_order) do |t|
      label = Ops.get_string(tabs, [t, "header"], @default_tab_header)
      tabbar = Builtins.add(tabbar, PushButton(Id(t), label))
    end
    widget = VBox(Left(tabbar), Frame("", rp))
  end

  tabs = Builtins.mapmap(tabs) do |k, v|
    contents = Ops.get_term(v, "contents", VBox())
    widget_names = Convert.convert(
      Ops.get(v, "widget_names") { CWM.StringsOfTerm(contents) },
      from: "any",
      to:   "list <string>"
    )
    # second arg wins
    fallback = Builtins.union(
      Ops.get_map(settings, "fallback_functions", {}),
      Ops.get_map(v, "fallback_functions", {})
    )
    w = CWM.CreateWidgets(widget_names, widget_descr)
    w = CWM.mergeFunctions(w, fallback)
    help = CWM.MergeHelps(w)
    contents = CWM.PrepareDialog(contents, w)
    Ops.set(v, "widgets", w)
    Ops.set(v, "help", help)
    Ops.set(v, "contents", contents)
    { k => v }
  end

  {
    "widget"            => :custom,
    "custom_widget"     => widget,
    "init"              => fun_ref(method(:InitWrapper), "void (string)"),
    "store"             => fun_ref(method(:Store), "void (string, map)"),
    "cleanup"           => fun_ref(method(:CleanUp), "void (string)"),
    "handle"            => fun_ref(
      method(:HandleWrapper),
      "symbol (string, map)"
    ),
    "validate_type"     => :function,
    "validate_function" => fun_ref(
      method(:Validate),
      "boolean (string, map)"
    ),
    "initial_tab"       => initial_tab,
    "tabs"              => tabs,
    "tabs_list"         => tab_order,
    "tab_help"          => tab_help,
    "no_help"           => true
  }
end

#CurrentTabString

Get the ID of the currently displayed tab

Returns:

  • (String)

    the ID of the currently displayed tab


289
290
291
# File 'library/cwm/src/modules/CWMTab.rb', line 289

def CurrentTab
  @current_tab_id
end

#Handle(widget, _key, event) ⇒ Symbol

Handle function of the widget

Parameters:

  • widget (Hash{String => Object})

    a widget description map

  • key (String)

    strnig the widget key

  • event (Hash)

    map event to be handled

Returns:

  • (Symbol)

    for wizard sequencer or nil


245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'library/cwm/src/modules/CWMTab.rb', line 245

def Handle(widget, _key, event)
  widget = deep_copy(widget)
  event = deep_copy(event)
  all_tabs = Ops.get_list(widget, "tabs_list", [])
  h_ret = TabHandle(@current_tab_map, event)
  return h_ret if !h_ret.nil?

  ret = Ops.get(event, "ID")
  if Ops.is_string?(ret) &&
      Builtins.contains(all_tabs, Convert.to_string(ret)) &&
      # At initialization, qt thinks it has switched to the same tab
      # So prevent unnecessary double initialization
      ret != @current_tab_id
    if !TabValidate(@current_tab_map, event)
      MarkCurrentTab()
      return nil
    end
    TabStore(@current_tab_map, event)

    InitNewTab(Convert.to_string(ret), widget)
  end
  nil
end

#handleDebugObject

A hook to handle Alt-Ctrl-Shift-D


301
302
303
304
305
# File 'library/cwm/src/modules/CWMTab.rb', line 301

def handleDebug
  Builtins.y2debug("Handling a debugging event")

  nil
end

#HandleWrapper(key, event) ⇒ Symbol

Handle function of the widget

Parameters:

  • map

    widget a widget description map

  • key (String)

    strnig the widget key

  • event (Hash)

    map event to be handled

Returns:

  • (Symbol)

    for wizard sequencer or nil


312
313
314
315
316
# File 'library/cwm/src/modules/CWMTab.rb', line 312

def HandleWrapper(key, event)
  event = deep_copy(event)
  handleDebug if Ops.get_string(event, "EventType", "") == "DebugEvent"
  Handle(CWM.GetProcessedWidget, key, event)
end

#Init(widget, _key) ⇒ Object

Init function of the widget

Parameters:

  • widget (Hash{String => Object})

    a widget description map

  • key (String)

    strnig the widget key


222
223
224
225
226
227
228
# File 'library/cwm/src/modules/CWMTab.rb', line 222

def Init(widget, _key)
  widget = deep_copy(widget)
  Push()
  InitNewTab(Ops.get_string(widget, "initial_tab", ""), widget)

  nil
end

#InitNewTab(new_tab_id, widget) ⇒ Object

Switch to a new tab

Parameters:

  • new_tab_it

    id of the new tab

  • widget (Hash{String => Object})

    tab set description


200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'library/cwm/src/modules/CWMTab.rb', line 200

def InitNewTab(new_tab_id, widget)
  widget = deep_copy(widget)
  @previous_tab_id = @current_tab_id
  @previous_tab_map = deep_copy(@current_tab_map)
  @current_tab_id = new_tab_id
  @current_tab_map = Ops.get_map(widget, ["tabs", @current_tab_id], {})
  MarkCurrentTab()
  RedrawTab(@current_tab_map)
  RedrawHelp(widget, @current_tab_map)
  TabInit(@current_tab_map)
  # allow a handler to enabled/disable widgets before the first real
  # UserInput takes place
  UI.FakeUserInput("ID" => "_cwm_tab_wakeup")

  nil
end

#InitWrapper(key) ⇒ Object

Init function of the widget

Parameters:

  • key (String)

    strnig the widget key


281
282
283
284
285
# File 'library/cwm/src/modules/CWMTab.rb', line 281

def InitWrapper(key)
  Init(CWM.GetProcessedWidget, key)

  nil
end

#LastTabString

Get the ID of the last displayed tab (after CWM::Run is done). It is needed because of bnc#134386.

Returns:

  • (String)

    the ID of the last displayed tab


296
297
298
# File 'library/cwm/src/modules/CWMTab.rb', line 296

def LastTab
  @last_tab_id
end

#mainObject


33
34
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
# File 'library/cwm/src/modules/CWMTab.rb', line 33

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

  Yast.import "CWM"
  Yast.import "Wizard"

  # local constants

  # Empty tab (just to be used as fallback constant)
  @empty_tab = VBox(VStretch(), HStretch())

  # Fallback label for a tab if no is defined
  @default_tab_header = _("Tab")

  # local variables - remember to add them to Push+Pop

  # ID of the currently displayed tab
  @current_tab_id = nil

  # ID of previously selected tab
  @previous_tab_id = nil

  # description map of the currently selected tab
  @current_tab_map = {}

  # description map of the currently selected tab
  @previous_tab_map = {}

  # this one is expressly excluded from Push+Pop
  @last_tab_id = nil

  # nesting stack, needed because of bnc#406138
  @stack = []
end

#MarkCurrentTabObject

Make the currently selected tab be displayed a separate way


173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
# File 'library/cwm/src/modules/CWMTab.rb', line 173

def MarkCurrentTab
  if UI.HasSpecialWidget(:DumbTab)
    UI.ChangeWidget(Id(:_cwm_tab), :CurrentItem, @current_tab_id)
  else
    if !@previous_tab_id.nil?
      UI.ChangeWidget(
        Id(@previous_tab_id),
        :Label,
        Ops.get_string(@previous_tab_map, "header", @default_tab_header)
      )
    end
    UI.ChangeWidget(
      Id(@current_tab_id),
      :Label,
      Ops.add(
        Ops.add(UI.Glyph(:BulletArrowRight), "  "),
        Ops.get_string(@current_tab_map, "header", @default_tab_header)
      )
    )
  end

  nil
end

#PopObject


81
82
83
84
85
86
87
88
89
90
91
# File 'library/cwm/src/modules/CWMTab.rb', line 81

def Pop
  tos = Ops.get(@stack, 0, {})
  @current_tab_id = Ops.get_string(tos, "cti", "")
  @previous_tab_id = Ops.get_string(tos, "pti", "")
  @current_tab_map = Ops.get_map(tos, "ctm", {})
  @previous_tab_map = Ops.get_map(tos, "ptm", {})
  Ops.set(@stack, 0, nil)
  @stack = Builtins.filter(@stack) { |m| !m.nil? }

  nil
end

#PushObject


69
70
71
72
73
74
75
76
77
78
79
# File 'library/cwm/src/modules/CWMTab.rb', line 69

def Push
  tos = {
    "cti" => @current_tab_id,
    "pti" => @previous_tab_id,
    "ctm" => @current_tab_map,
    "ptm" => @previous_tab_map
  }
  @stack = Builtins.prepend(@stack, tos)

  nil
end

#RedrawHelp(widget, tab) ⇒ Object

Redraw the part of the help related to the tab widget

Parameters:

  • widget (Hash{String => Object})

    a map of the tab widget

  • tab (Hash{String => Object})

    a map describing the tab


160
161
162
163
164
165
166
167
168
169
170
# File 'library/cwm/src/modules/CWMTab.rb', line 160

def RedrawHelp(widget, tab)
  widget = deep_copy(widget)
  tab = deep_copy(tab)
  help = Ops.add(
    Ops.get_string(widget, "tab_help", ""),
    Ops.get_string(tab, "help", "")
  )
  CWM.ReplaceWidgetHelp(Ops.get_string(widget, "_cwm_key", ""), help)

  nil
end

#RedrawTab(tab) ⇒ Object

Redraw the whole tab

Parameters:

  • tab (Hash{String => Object})

    a map describing the tab


149
150
151
152
153
154
155
# File 'library/cwm/src/modules/CWMTab.rb', line 149

def RedrawTab(tab)
  tab = deep_copy(tab)
  contents = Ops.get_term(tab, "contents", @empty_tab)
  UI.ReplaceWidget(:_cwm_tab_contents_rp, contents)

  nil
end

#Store(_key, event) ⇒ Object

Store function of the widget

Parameters:

  • key (String)

    strnig the widget key

  • event (Hash)

    map that caused widget data storing


272
273
274
275
276
277
# File 'library/cwm/src/modules/CWMTab.rb', line 272

def Store(_key, event)
  event = deep_copy(event)
  TabStore(@current_tab_map, event)

  nil
end

#TabCleanup(tab) ⇒ Object

Clean up the widgets in the tab

Parameters:

  • tab (Hash{String => Object})

    a map describing the tab


107
108
109
110
111
112
113
# File 'library/cwm/src/modules/CWMTab.rb', line 107

def TabCleanup(tab)
  tab = deep_copy(tab)
  widgets = Ops.get_list(tab, "widgets", [])
  CWM.cleanupWidgets(widgets)

  nil
end

#TabHandle(tab, event) ⇒ Symbol

Handle events on the widgets inside the tab

Parameters:

  • tab (Hash{String => Object})

    a map describing the tab

  • event (Hash)

    map event that caused the event handling

Returns:

  • (Symbol)

    for wizard sequencer or nil


119
120
121
122
123
124
# File 'library/cwm/src/modules/CWMTab.rb', line 119

def TabHandle(tab, event)
  tab = deep_copy(tab)
  event = deep_copy(event)
  widgets = Ops.get_list(tab, "widgets", [])
  CWM.handleWidgets(widgets, event)
end

#TabInit(tab) ⇒ Object

Initialize the widgets in the tab

Parameters:

  • tab (Hash{String => Object})

    a map describing the tab


97
98
99
100
101
102
103
# File 'library/cwm/src/modules/CWMTab.rb', line 97

def TabInit(tab)
  tab = deep_copy(tab)
  widgets = Ops.get_list(tab, "widgets", [])
  CWM.initWidgets(widgets)

  nil
end

#TabStore(tab, event) ⇒ Object

Store settings of all widgets inside the tab

Parameters:

  • tab (Hash{String => Object})

    a map describing the tab

  • event (Hash)

    map event that caused the saving process


129
130
131
132
133
134
# File 'library/cwm/src/modules/CWMTab.rb', line 129

def TabStore(tab, event)
  tab = deep_copy(tab)
  event = deep_copy(event)
  widgets = Ops.get_list(tab, "widgets", [])
  CWM.saveWidgets(widgets, event)
end

#TabValidate(tab, event) ⇒ Boolean

Validate settings of all widgets inside the tab

Parameters:

  • tab (Hash{String => Object})

    a map describing the tab

  • event (Hash)

    map event that caused the validation process

Returns:

  • (Boolean)

    true if validation succeeded


140
141
142
143
144
145
# File 'library/cwm/src/modules/CWMTab.rb', line 140

def TabValidate(tab, event)
  tab = deep_copy(tab)
  event = deep_copy(event)
  widgets = Ops.get_list(tab, "widgets", [])
  CWM.validateWidgets(widgets, event)
end

#Validate(_key, event) ⇒ Object

Validate function of the widget

Parameters:

  • key (String)

    strnig the widget key

  • event (Hash)

    map that caused widget data storing


321
322
323
324
# File 'library/cwm/src/modules/CWMTab.rb', line 321

def Validate(_key, event)
  event = deep_copy(event)
  TabValidate(@current_tab_map, event)
end