YaST2 Developers Documentation: Installation



functions
files
intro

Installation

clients/inst_proposal.ycp
Create and display proposal
Create and display reasonable proposal for basic installation and call sub-workflows as required on user request. See also file proposal-API.txt for details.

Imports

  • Arch
  • AutoinstConfig
  • HTML
  • Installation
  • Language
  • Mode
  • Popup
  • ProductControl
  • Wizard

Local Functions

local display_proposal (string proposal) -> void

Display preformatted proposal in the RichText widget

Parameters:
proposal human readable proposal preformatted in HTML

local submod_make_proposal (string submodule, boolean force_reset, boolean language_changed) -> map

Call a submodule's MakeProposal() function.

Parameters:
submodule name of the submodule's proposal dispatcher
force_reset discard any existing (cached) proposal
language_changed installation language changed since last call
Return value:
proposal_map see proposal-API.txt

local submod_ask_user (string submodule, boolean has_next) -> symbol

Call a submodule's AskUser() function.

Parameters:
submodule name of the submodule's proposal dispatcher
has_next force a "next" button even if the submodule would otherwise rename it
Return value:
workflow_sequence see proposal-API.txt

local submod_description (string submodule) -> map

Call a submodule's Description() function.

Parameters:
submodule name of the submodule's proposal dispatcher or nil if no such module
Return value:
description_map see proposal-API.txt

local make_proposal (boolean force_reset, boolean language_changed) -> void

Call each submodule's MakeProposal() function in turn and display the proposals in the RichText widget.

Parameters:
force_reset discard any existing (cached) proposal
language_changed installation language changed since last call

local format_sub_proposal (map prop) -> string

Format a submodule's proposal in HTML

Parameters:
prop proposal map - see proposal-API.txt
Return value:
HTML string

local submod_write_settings (string submodule) -> boolean

Call a submodule's Write() function.

Parameters:
submodule name of the submodule's proposal dispatcher
Return value:
success true if Write() was successful of if there is no Write() function

local write_settings () -> void

Call each submodule's "Write()" function to let it write its settings, i.e. the settings effective.

local richtext_busy_cursor (any widget_id) -> void

Force a RichText widget to use the busy cursor

Parameters:
widget_id ID of the widget, e.g. `id(`proposal)

local richtext_normal_cursor (any widget_id) -> void

Switch a RichText widget back to use the normal cursor

Parameters:
widget_id ID of the widget, e.g. `id(`proposal)

local retranslate_proposal_dialog () -> void

Retranslate the proposal (wizard) dialog after the language is changed.

local load_submodules_list (string file_name, list fallback_list) -> list

Load a list of submodules. Try loading it from a file named 'file_name' from one of several predefined directories. If there is no such list, use 'fallback_list'.

Parameters:
file_name YCP file name to load from
fallback_list fallback list of submodule names (strings)
Return value:
submodules_list list of submodule names (strings)

local load_matching_submodules_list () -> list<string>

Load a list of submodules matching the current internal states

Return value:
submodules_list list of submodule names (strings)

local have_network_card () -> boolean

Find out if the target machine has a network card.

Return value:
true if a network card is found, false otherwise

local build_dialog () -> void

Create the proposal dialog (the inner part, excluding the wizard frame)

local get_submod_descriptions_and_build_menu () -> boolean

Query all submodules about their descriptions, build a "Change" menu from that, and cache the descriptions for further usage: They will become hyperlinks in the RichText widget, too. Return false if no submodule exists.

local set_icon () -> void

Set an appropriate wizard icon for the current proposal mode. .desktop files may or may not be available (e.g. in the inst-sys they are not), so use icon names directly rather than looking them up in the .desktop file with Wizard::SetDesktopIcon().

local help_text () -> string

Help text for proposal dialog.

Return value:
help text

Info:

Deliberately omitting "boot installed system" here to avoid confusion: The user will be prompted for that if Linux partitions are found. - sh@suse.de 2002-02-26

Info:

Deliberately omitting "boot installed system" here to avoid confusion: The user will be prompted for that if Linux partitions are found. - sh@suse.de 2002-02-26


YaST2 Developers Documentation