Class: Yast::ProgressClass

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

Instance Method Summary collapse

Instance Method Details

#CloseSuperior ⇒ Object

Replaces stages of superior progress by an empty help text.



856
857
858
859
860
861
862
863
864
865
866
 
# File 'library/wizard/src/modules/Progress.rb', line 856

def CloseSuperior
  if UI.HasSpecialWidget(:Wizard)
    UI.CloseDialog
  else
    Wizard.RestoreHelp("")
  end
  @super_steps = 0
  @super_step = 0

  nil
end

#CurrentSubprogressType ⇒ Symbol

Get current subprogress type

Returns:

  • (Symbol) —

    Current type of the subprogress widget - can be progress,tick or `none



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'library/wizard/src/modules/Progress.rb', line 467

def CurrentSubprogressType
  ret = :none

  return ret if !@visible || Mode.commandline

  # is there the subprogress progress widget?
  if UI.WidgetExists(:subprogress_progress) == true
    ret = :progress
  # or is there the tick subprogress widget?
  elsif UI.WidgetExists(:subprogress_tick) == true
    ret = :tick
  end

  ret
end

#Finish ⇒ Object

Moves progress bar to the end and marks all stages as completed.



784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'library/wizard/src/modules/Progress.rb', line 784

def Finish
  return if !@visible || Mode.commandline

  # decrease the reference counter
  @progress_running -= 1

  # set the previous state
  if Ops.greater_than(StackSize(), 0)
    PopState()
    return
  end

  if 0 != @stages
    # unwind remaining stages
    NextStage() while Ops.less_than(@current_stage, @stages)
  end
  if 0 != @steps
    @current_step = @steps
    UpdateProgressBar()
  end

  SetProgressBarTitle(" ")

  nil
end

#IsRunning ⇒ Object 



139
140
141
142
143
144
 
# File 'library/wizard/src/modules/Progress.rb', line 139

def IsRunning
  # Check if any progress bar exists. If it does not, we're not running
  # (querying progress counter is not enough, a module ran previously
  # might have failed to reset the counter properly)
  @progress_running > 0 && UI.WidgetExists(:progress_replace_point)
end

#main ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'library/wizard/src/modules/Progress.rb', line 88

def main
  Yast.import "UI"

  textdomain "base"

  Yast.import "CommandLine"
  Yast.import "Wizard"
  Yast.import "Mode"
  Yast.import "Directory"
  Yast.import "FileUtils"

  # *******************************************************************
  # // !!! IMPORTANT !!!
  # // If you add here a new variable which is valid only for the current
  # // progress do not forget to add it to PushState() and PopState()
  # // functions which are are used for nested progresses!
  # *******************************************************************

  # Number of stages.
  @stages = 0
  # Number of steps
  @steps = 0
  # Current stage
  @current_stage = 0
  # Current step
  @current_step = 0
  # list of stage-titles
  @titles = []

  # is progress bar used?
  @visible = true

  # superior progress (stages) bar
  @super_steps = 0
  @super_step = 0
  @super_stages = []

  # remember the last max. value of the subprogress bar
  @last_subprogress_max = 0

  @progress_running = 0

  # remember cumulated number of steps for nested progresses
  @progress_max = 0
  @progress_val = 0

  # stack with the running progresses
  # the top of the stack is the end of the list
  @progress_stack = []
end

#Mark(kind) ⇒ Object

Returns UI mark for stages.

Parameters:

  • kind (Symbol) —

    todo,current or `done

Returns:

  • UI mark for stages



303
304
305
306
307
308
309
 
# File 'library/wizard/src/modules/Progress.rb', line 303

def Mark(kind)
  return "-" if kind == :todo
  return UI.Glyph(:BulletArrowRight) if kind == :current
  return UI.Glyph(:CheckMark) if kind == :done

  "?@%!"
end

#MarkId(stage) ⇒ Object

Returns widget `id(...) for the marker.

Parameters:

  • stage (Fixnum) —

    stage number

Returns:

  • widget `id(...) for the marker



313
314
315
 
# File 'library/wizard/src/modules/Progress.rb', line 313

def MarkId(stage)
  Id(Builtins.sformat("mark_stage_%1", stage))
end

#New(window_title, progress_title, length, stg, tits, help_text) ⇒ Object

New complex progress bar with stages.

Parameters:

  • window_title (String) —

    title of the window

  • progress_title (String) —

    title of the progress bar. Pass at least " " (one space) if you want some progress bar title.

  • length (Fixnum) —

    number of steps. If 0, no progress bar is created, there are only stages and bottom title. THIS IS NOT NUMBER OF STAGES!

  • stg (Array<String>) —

    list of strings - stage names. If it is nil, then there are no stages.

  • tits (Array) —

    Titles corresponding to stages. When stage changes, progress bar title changes to one of these titles. May be nil/empty.

  • help_text (String) —

    help text



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
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
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'library/wizard/src/modules/Progress.rb', line 330

def New(window_title, progress_title, length, stg, tits, help_text)
  stg = deep_copy(stg)
  tits = deep_copy(tits)
  return if !@visible

  return if Mode.commandline

  # a progress is already running, remember the current status
  PushState() if IsRunning()

  Builtins.y2milestone(
    "Progress::New(%1, %2, %3)",
    window_title,
    length,
    stg
  )

  orig_current_step = @current_step

  @steps = length
  @stages = Builtins.size(stg)
  @titles = deep_copy(tits)
  @current_step = -1
  @current_stage = -1

  if Ops.less_than(length, Builtins.size(stg))
    Builtins.y2warning(
      "Number of stages (%1) is greater than number of steps (%2)",
      Builtins.size(stg),
      length
    )
  end

  if progress_title == ""
    # Reserve space for future progress bar labels. The ProgressBar
    # widget will suppress the label above the progress bar if the
    # initial label string is empty.
    progress_title = " "
  end

  # do not replace the UI, there is a progress already running
  if IsRunning()
    @progress_max = Ops.multiply(@progress_max, @steps)

    if StackSize() == 1
      @progress_val = Ops.multiply(orig_current_step, @steps)
    else
      prev_state = TopState()
      prev_progress_val = Ops.get_integer(prev_state, "progress_val", 0)

      @progress_val = Ops.multiply(prev_progress_val, @steps)
    end

    # set the maximum value of the progress bar
    try_replace_widget(
      Id(:progress_replace_point),
      ProgressBar(Id(:pb), progress_title, @progress_max, @progress_val)
    )
    Builtins.y2debug("New progress: %1/%2", @progress_val, @progress_max)

    @progress_running += 1
    return
  else
    @progress_max = @steps
  end

  bar = VBox(ProgressBar(Id(:pb), progress_title, length, 0)) # progressbar only
  if 0 != @stages
    bar = VBox(VSpacing(1))
    i = 0
    label_heading = Mark(:todo)

    items = VBox()
    Builtins.foreach(stg) do |item|
      items = Builtins.add(
        items,
        HBox(
          HSpacing(1),
          # check_ycp wants this text to be translatable. I do not know why.
          # HSquash + MinWidth(4) reserves a defined space for 'mark' plus 'emtpy space'
          # see bnc #395752
          HSquash(MinWidth(4, Heading(MarkId(i), label_heading))),
          Label(item),
          HStretch()
        )
      )
      i = Ops.add(i, 1)
    end
    bar = Builtins.add(bar, Left(HBox(HSquash(items))))

    bar = if 0 == @steps
      Builtins.add(
        bar,
        VBox(
          VStretch(),
          ReplacePoint(Id(:subprogress_replace_point), Empty()),
          ReplacePoint(
            Id(:progress_replace_point),
            Label(Id(:pb), Opt(:hstretch), progress_title)
          ),
          VSpacing(2)
        )
      )
    else
      Builtins.add(
        bar,
        VBox(
          VStretch(),
          ReplacePoint(Id(:subprogress_replace_point), Empty()),
          ReplacePoint(
            Id(:progress_replace_point),
            ProgressBar(Id(:pb), progress_title, length, 0)
          ),
          VSpacing(2)
        )
      )
    end
  end

  # patch from Michal Srb https://bugzilla.novell.com/show_bug.cgi?id=406890#c7
  try_replace_widget(Id(:contents), bar) unless Mode.test

  if !UI.WizardCommand(term(:SetDialogHeading, window_title))
    UI.ChangeWidget(Id(:title), :Value, window_title)
    UI.RecalcLayout
  end
  Wizard.SetHelpText(help_text) if "" != help_text && nil != help_text
  Wizard.DisableBackButton
  Wizard.DisableNextButton

  @progress_running += 1

  nil
end

#NewProgressIcons(window_title, progress_title, length, stg, tits, help_textmap, _icons_definition) ⇒ Object

Deprecated.

Use #New instead.

Obsolete function adding icon-support to progress dialog. We don't use icons in popups any more.

Parameters:

  • window_title (String)
  • progress_title (String)
  • length (Fixnum)
  • stg (Array<String>)
  • tits (Array)
  • help_textmap (String)
  • icons_definition (Array<Array<String>>)

See Also:

  • Progress::New()


587
588
589
590
 
# File 'library/wizard/src/modules/Progress.rb', line 587

def NewProgressIcons(window_title, progress_title, length, stg, tits, help_textmap, _icons_definition)
  Builtins.y2warning(-1, "#{__method__} is deprecated. Use Progress::New instead!")
  New(window_title, progress_title, length, stg, tits, help_textmap)
end

#NextStage ⇒ Object

Advance stage, advance step by 1 and set progress bar caption to that defined in New.



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'library/wizard/src/modules/Progress.rb', line 668

def NextStage
  return if !@visible

  NextStep()

  if 0 == @stages || Ops.greater_than(@current_stage, @stages)
    Builtins.y2error("Non-existing stage requested.")
    return
  end

  @current_stage = Ops.add(@current_stage, 1)

  # do not update the UI in a nested progress
  return if Ops.greater_than(StackSize(), 0)

  if Mode.commandline
    if Ops.less_than(@current_stage, @stages) &&
        Ops.less_than(@current_stage, Builtins.size(@titles))
      CommandLine.PrintVerbose(Ops.get_string(@titles, @current_stage, ""))
    end
    return
  end

  if Ops.greater_than(@current_stage, 0)
    UI.ChangeWidget(
      MarkId(Ops.subtract(@current_stage, 1)),
      :Value,
      Mark(:done)
    )
  end
  # we may be past the last stage
  if Ops.less_than(@current_stage, @stages)
    SetProgressBarTitle(Ops.get_string(@titles, @current_stage, "")) if Ops.less_than(@current_stage, Builtins.size(@titles))
    UI.ChangeWidget(MarkId(@current_stage), :Value, Mark(:current))
  end

  nil
end

#NextStageStep(step) ⇒ Object

Jumps to the next stage and sets step to st.

Parameters:

  • step (Fixnum) —

    new progress bar value



766
767
768
769
770
771
772
773
 
# File 'library/wizard/src/modules/Progress.rb', line 766

def NextStageStep(step)
  return if !@visible || Mode.commandline

  NextStage()
  Step(step)

  nil
end

#NextStep ⇒ Object

Some people say it is the best operating system ever. But now to the function. Advances progress bar value by 1.



657
658
659
660
661
662
663
664
 
# File 'library/wizard/src/modules/Progress.rb', line 657

def NextStep
  return if !@visible || Mode.commandline || 0 == @steps

  @current_step = Ops.add(@current_step, 1)
  UpdateProgressBar()

  nil
end

#off ⇒ Object

Deprecated.

set

Turns progress bar off. All Progress:: calls return immediatelly.



284
285
286
287
288
289
290
 
# File 'library/wizard/src/modules/Progress.rb', line 284

def off
  # no "deprecated" warning
  # because it is ok to use this function in testsuites
  @visible = false

  nil
end

#on ⇒ Object

Deprecated.

set

Turns progress bar on after calling Progress::off.



294
295
296
297
298
299
 
# File 'library/wizard/src/modules/Progress.rb', line 294

def on
  Builtins.y2warning(-1, "Deprecated function. Use Progress::set instead")
  @visible = true

  nil
end

#OpenSuperior(title, stages) ⇒ Object

Creates a higher-level progress bar made of stages. Currently it is placed instead of help text.

Parameters:

  • title (String) —

    title of the progress...

  • stages (Array<String>) —

    list of stage descriptions



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

def OpenSuperior(title, stages)
  stages = deep_copy(stages)
  if UI.HasSpecialWidget(:Wizard)
    Wizard.OpenAcceptAbortStepsDialog
    UI.WizardCommand(term(:AddStepHeading, title))

    idx = 0
    @super_steps = Builtins.size(stages)
    @super_step = -1
    Builtins.foreach(stages) do |s|
      id = Builtins.sformat("super_progress_%1", idx)
      UI.WizardCommand(term(:AddStep, s, id))
    end
    UI.WizardCommand(term(:UpdateSteps)) # old behaviour
  else
    left = VBox(VStretch())
    right = VBox(VStretch())
    idx = 0
    @super_steps = Builtins.size(stages)
    @super_step = -1
    Builtins.foreach(stages) do |i|
      id = Builtins.sformat("super_progress_%1", idx)
      left = Builtins.add(left, Heading(Id(id), "-  "))
      right = Builtins.add(right, Label(Opt(:hstretch), i))
      left = Builtins.add(left, VStretch())
      right = Builtins.add(right, VStretch())
      idx = Ops.add(idx, 1)
    end
    left = Builtins.add(left, HSpacing(4))
    right = Builtins.add(right, HStretch())
    Wizard.ReplaceHelp(
      VBox(
        HBox(HSpacing(1), Frame(title, HBox(HSpacing(1), left, right))),
        VSpacing(0.5)
      )
    )
  end

  nil
end

#PopState ⇒ Object

pop the progress state from the stack and set it



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'library/wizard/src/modules/Progress.rb', line 198

def PopState
  # pop the config
  state = Ops.get(
    @progress_stack,
    Ops.subtract(Builtins.size(@progress_stack), 1),
    {}
  )
  @progress_stack = Builtins.remove(
    @progress_stack,
    Ops.subtract(Builtins.size(@progress_stack), 1)
  )

  Builtins.y2milestone("setting up the previous state: %1", state)

  # refresh the variables
  @stages = Ops.get_integer(state, "stages", 0)
  @steps = Ops.get_integer(state, "steps", 0)
  @current_step = Ops.get_integer(state, "current_step", 0)
  @current_stage = Ops.get_integer(state, "current_stage", 0)
  @titles = Ops.get_list(state, "titles", [])
  @last_subprogress_max = Ops.get_integer(state, "last_subprogress_max", 0)
  @progress_max = Ops.get_integer(state, "progress_max", 0)
  @progress_val = Ops.get_integer(state, "progress_val", 0)

  pb_value = Ops.get_integer(state, "progress_value", 0)
  pb_value = Ops.add(pb_value.nil? ? 0 : pb_value, 1)

  # refresh the progress widget, add one step for the embedded progress
  try_replace_widget(
    Id(:progress_replace_point),
    ProgressBar(
      Id(:pb),
      Ops.get_string(state, "progress_label", ""),
      @steps,
      pb_value
    )
  )

  type = Ops.get_symbol(state, "subprogress_type", :none)
  SubprogressType(type, @last_subprogress_max)

  if [:progress, :tick].include?(type)
    SubprogressTitle(Ops.get_string(state, "subprogress_label", ""))
    SubprogressValue(Ops.get_integer(state, "subprogress_value", 0))
  end

  nil
end

#PushState ⇒ Object

push the current progress into the stack



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
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
 
# File 'library/wizard/src/modules/Progress.rb', line 147

def PushState
  current_subprogress = CurrentSubprogressType()
  state = {
    # global variable
    "stages"               => @stages,
    "steps"                => @steps,
    "current_step"         => @current_step,
    "current_stage"        => @current_stage,
    "titles"               => @titles,
    "last_subprogress_max" => @last_subprogress_max,
    "visible"              => @visible,
    # state of the widgets
    "subprogress_type"     => current_subprogress,
    "progress_label"       => Convert.to_string(
      UI.QueryWidget(Id(:pb), :Label)
    ),
    "progress_value"       => Convert.to_integer(
      UI.QueryWidget(Id(:pb), :Value)
    ),
    "progress_max"         => @progress_max,
    "progress_val"         => @progress_val
  }

  case current_subprogress
  when :progress
    Ops.set(
      state,
      "subprogress_label",
      Convert.to_string(UI.QueryWidget(Id(:subprogress_progress), :Label))
    )
    Ops.set(
      state,
      "subprogress_value",
      Convert.to_integer(UI.QueryWidget(Id(:subprogress_progress), :Value))
    )
  when :tick
    Ops.set(
      state,
      "subprogress_label",
      Convert.to_string(UI.QueryWidget(Id(:subprogress_tick), :Label))
    )
  end

  Builtins.y2milestone("Current state: %1", state)

  @progress_stack = Builtins.add(@progress_stack, state)

  nil
end

#set(state) ⇒ Object

Sets progress bar state: on = normal operation, off = All Progress:: calls return immediatelly.

Parameters:

  • state (Boolean) —

    on or off

Returns:

  • previous state



266
267
268
269
270
 
# File 'library/wizard/src/modules/Progress.rb', line 266

def set(state)
  prev = @visible
  @visible = state
  prev
end

#SetProgressBarTitle(title) ⇒ Object

the bar is either ProgressBar orLabel

Parameters:



649
650
651
652
653
 
# File 'library/wizard/src/modules/Progress.rb', line 649

def SetProgressBarTitle(title)
  UI.ChangeWidget(Id(:pb), (0 == @steps) ? :Value : :Label, title)

  nil
end

#Simple(window_title, progress_title, length, help_text) ⇒ Object

Create simple progress bar with no stages, only with progress bar.

Parameters:

  • window_title (String) —

    Title of the window.

  • progress_title (String) —

    Title of the progress bar.

  • length (Fixnum) —

    Number of steps.

  • help_text (String) —

    Help text.



597
598
599
600
601
 
# File 'library/wizard/src/modules/Progress.rb', line 597

def Simple(window_title, progress_title, length, help_text)
  New(window_title, progress_title, length, [], [], help_text)

  nil
end

#StackSize ⇒ Object

return size of the progress stack



248
249
250
 
# File 'library/wizard/src/modules/Progress.rb', line 248

def StackSize
  Builtins.size(@progress_stack)
end

#Stage(stage, title, step) ⇒ Object

Go to stage st, change progress bar title to title and set progress bar step to step.

Parameters:

  • stage (Fixnum) —

    New stage.

  • title (String) —

    New title for progress bar. If nil, title specified in New is used.

  • step (Fixnum) —

    New step or -1 if step should not change.



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
758
759
760
761
762
 
# File 'library/wizard/src/modules/Progress.rb', line 727

def Stage(stage, title, step)
  return if !@visible

  Step(step) if -1 != step

  # another progress is running
  # do not change the current stage, calculate the target step
  if Ops.greater_than(StackSize(), 0)
    UpdateProgressBar()
    return
  end

  if !Mode.commandline && Ops.greater_or_equal(@current_stage, 0)
    UI.ChangeWidget(
      MarkId(@current_stage),
      :Value,
      Mark(Ops.greater_than(stage, @current_stage) ? :done : :todo)
    )
  end

  @current_stage = stage
  s = ""
  s = Ops.get_string(@titles, @current_stage, "") if Ops.less_than(@current_stage, Builtins.size(@titles))
  s = title if nil != title
  if Ops.less_than(@current_stage, Builtins.size(@titles))
    if Mode.commandline
      CommandLine.PrintVerbose(s)
      return
    else
      SetProgressBarTitle(s)
    end
  end
  UI.ChangeWidget(MarkId(@current_stage), :Value, Mark(:current)) if Ops.less_than(@current_stage, @stages)

  nil
end

#status ⇒ Boolean

Returns currently selected visibility status of all UI-modifying Progress:: functions.

Returns:

  • (Boolean) —

    whether the progress bar is used

See Also:

  • Yast::ProgressClass#Progress#Progress::set
  • Yast::ProgressClass#Progress#Progress::off
  • Yast::ProgressClass#Progress#Progress::on


278
279
280
 
# File 'library/wizard/src/modules/Progress.rb', line 278

def status
  @visible
end

#Step(step) ⇒ Object

Changes progress bar value to st.

Parameters:

  • stet (Fixnum) —

    new value



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

def Step(step)
  return if !@visible || Mode.commandline || 0 == @steps

  return if Ops.less_than(step, 0) || Ops.greater_than(step, @steps)

  @current_step = step

  UpdateProgressBar()

  nil
end

#StepSuperior ⇒ Object

Make one step in a superior progress bar.



869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 
# File 'library/wizard/src/modules/Progress.rb', line 869

def StepSuperior
  if Ops.greater_or_equal(@super_step, 0) &&
      Ops.less_than(@super_step, @super_steps) && !UI.HasSpecialWidget(:Wizard)
    UI.ChangeWidget(
      Id(Builtins.sformat("super_progress_%1", @super_step)),
      :Value,
      UI.Glyph(:CheckMark)
    )
  end
  @super_step = Ops.add(@super_step, 1)
  return if Ops.greater_or_equal(@super_step, @super_steps)

  if UI.HasSpecialWidget(:Wizard)
    UI.WizardCommand(
      term(
        :SetCurrentStep,
        Builtins.sformat("super_progress_%1", @super_step)
      )
    )
  else
    UI.ChangeWidget(
      Id(Builtins.sformat("super_progress_%1", @super_step)),
      :Value,
      UI.Glyph(:BulletArrowRight)
    )
  end

  nil
end

#SubprogressTitle(title) ⇒ Object

Set the label of the subprogress

Parameters:

  • title (String) —

    New label for the subprogress



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'library/wizard/src/modules/Progress.rb', line 559

def SubprogressTitle(title)
  return if !@visible || Mode.commandline

  current_type = CurrentSubprogressType()

  case current_type
  when :progress
    UI.ChangeWidget(Id(:subprogress_progress), :Label, title)
  when :tick
    UI.ChangeWidget(Id(:subprogress_tick), :Label, title)
  else
    Builtins.y2warning("No subprogress is defined, cannot set the label!")
  end

  nil
end

#SubprogressType(type, max_value) ⇒ Object

Create (or remove) a new subprogress above the progress bar, can be use for detailed progress of the current task tick (tick progress) ornone (no subprogress, intended for removing the progress bar from the dialog)

Parameters:

  • type (Symbol) —

    type of the subprogress widget, can be `progress (standard progress),

  • max_value (Fixnum) —

    maximum value for `progress type, for the other types it is not relevant (use any integer value or nil)



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'library/wizard/src/modules/Progress.rb', line 508

def SubprogressType(type, max_value)
  return if !@visible || Mode.commandline

  Builtins.y2debug(
    "SubprogressType: type: %1, max_value: %2",
    type,
    max_value
  )

  if type == CurrentSubprogressType()
    case type
    when :progress
      # just reset the current value of the progress bar if the requested progress is the same
      if max_value == @last_subprogress_max
        Builtins.y2milestone("Resetting the subprogressbar...")
        SubprogressValue(0)
        return
      end
    when :tick
      # just restart the animation
      UI.ChangeWidget(Id(:subprogress_tick), :Alive, true)
    else
      Builtins.y2milestone("Subprogress initialization skipped")
      return
    end
  end

  widget = Empty()

  case type
  when :progress
    widget = ProgressBar(Id(:subprogress_progress), " ", max_value, 0)
  when :tick
    widget = BusyIndicator(Id(:subprogress_tick), " ", 3000)
  when :none
    widget = Empty()
  else
    Builtins.y2error("Unknown subprogress type: %1", type)
  end

  Builtins.y2debug("widget: %1", widget)
  try_replace_widget(Id(:subprogress_replace_point), widget)

  # remember the max. value
  @last_subprogress_max = max_value

  nil
end

#SubprogressValue(value) ⇒ Object

Set value of the subprogress

Parameters:

  • value (Fixnum) —

    Current value of the subprogress, if a tick subprogress is running the value is ignored and the next tick is displayed



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'library/wizard/src/modules/Progress.rb', line 485

def SubprogressValue(value)
  return if !@visible || Mode.commandline

  current_type = CurrentSubprogressType()

  # normal progress
  case current_type
  when :progress
    UI.ChangeWidget(Id(:subprogress_progress), :Value, value)
  # tick progress
  when :tick
    UI.ChangeWidget(Id(:subprogress_tick), :Alive, true)
  else
    Builtins.y2warning("No subprogress is defined, cannot set the value!")
  end

  nil
end

#Title(title) ⇒ Object

Change progress bar title.

Parameters:

  • title. (String) —

    Use ""(empty string) if you want an empty progress bar.



777
778
779
780
781
 
# File 'library/wizard/src/modules/Progress.rb', line 777

def Title(title)
  SetProgressBarTitle(title) if @visible && !Mode.commandline

  nil
end

#TopState ⇒ Object

return the value on the top of the stack the stack is not changed



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

def TopState
  Ops.get(
    @progress_stack,
    Ops.subtract(Builtins.size(@progress_stack), 1),
    {}
  )
end

#try_replace_widget(widget_id, new_content) ⇒ Object

Try replacing a ReplacePoint widget's content with new content, but only if the ReplacePoint actually exists: It might be hidden by another dialog that was opened on top of the current one (bsc#1187676).



902
903
904
905
906
907
908
909
 
# File 'library/wizard/src/modules/Progress.rb', line 902

def try_replace_widget(widget_id, new_content)
  if UI.WidgetExists(widget_id)
    UI.ReplaceWidget(widget_id, new_content)
  else
    log.warn("No widget with ID #{widget_id} in the current dialog")
    UI.DumpWidgetTree
  end
end

#UpdateProgressBar ⇒ Object

Uses current_step



604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'library/wizard/src/modules/Progress.rb', line 604

def UpdateProgressBar
  if Ops.greater_than(@current_step, @steps)
    Builtins.y2error(
      -2,
      "Progress bar has only %1 steps, not %2.",
      @steps,
      @current_step
    )
    return
  end

  progress_value = @current_step

  if StackSize() != 0
    # recalculate the progress bar value according to the parent progress
    prev_state = TopState()
    prev_step = Ops.get_integer(prev_state, "current_step", 0)

    progress_value = Ops.add(
      Ops.multiply(prev_step, @steps),
      Ops.greater_than(@current_step, 0) ? @current_step : 0
    )
  end

  Builtins.y2debug(
    "New progress value: %1, current_step: %2/%3 (%4%%)",
    progress_value,
    @current_step,
    @steps,
    Ops.divide(
      Ops.multiply(
        100.0,
        Convert.convert(progress_value, from: "integer", to: "float")
      ),
      Convert.convert(@progress_max, from: "integer", to: "float")
    )
  )

  UI.ChangeWidget(Id(:pb), :Value, progress_value)

  nil
end