YaST2 Developers Documentation: Unknown YCP Module

Unknown YCP Module

SourceDialogs.ycp
  • Jiri Srain
  • Klaus Kaempf
  • Gabriele Strattner
  • Stefan Schubert
  • Cornelius Schumacher
  • Purpose:
  • Displays possibilities to install from NFS, CD or partion

This module has an unstable interface.

Imports

  • CWM
  • Hostname
  • IP
  • Label
  • Message
  • NetworkPopup
  • Popup
  • ProductControl
  • ProductFeatures
  • Report
  • SourceManager
  • String
  • URL
  • URLRecode

Global Functions

Local Variables

Local Functions

local _url -> string

URL to work with

local _plaindir -> boolean

The repo at _url is plaindir

local _repo_name -> string

Repo name to work with

local _allow_https -> boolean

Allow HTTPS for next repository dialog?

local iso_help -> string

Help text suffix for some types of the media

local multi_cd_help -> string

Help text suffix for some types of the media

global SetURL (string url) -> void

Set the URL to work with

Parameters:
url string URL to run the dialogs with
global SetURLType (string url, boolean plaindir_type) -> void

Set the URL to work with, set the plaindir flag (type of the repository)

Parameters:
url string URL to run the dialogs with
plaindir_type true if the repo type is plaindir
global GetURL () -> string

Return URL after the run of the dialog

Return value:
the URL
global GetRawURL () -> string

Return the configured URL in the dialog, do not do any conversion (return the internal value)

Return value:
raw internal URL
global SetRepoName (string repo_name) -> void

Set the RepoName to work with

Parameters:
repo_name string RepoName to run the dialogs with
global GetRepoName () -> string

Return RepoName after the run of the dialog

Return value:
the RepoName
local PosprocessISOURL (string url) -> string

Postprocess URL of an ISO image

Parameters:
url string URL in the original form
Return value:
postprocessed URL
local IsISOURL (string url) -> boolean

Check if URL is an ISO URL

Parameters:
url string URL to check
Return value:
true if URL is an ISO URL, false otherwise
local PreprocessISOURL (string url) -> string

Preprocess the ISO URL to be used in the dialogs

Parameters:
url string URL to preprocess
Return value:
preprocessed URL
local PathIsISO (string url) -> boolean

check if given path points to ISO file

Parameters:
url string URL to check
Return value:
true if URL is ISO image
local Slashed (string urlpart) -> string

Add a slash to the part of url, if it is not already present

Parameters:
urlpart string a part of the URL
Return value:
urlpart with leading slash
local NormalizeHost (string host) -> string

Remove leading and trailing (and inner) spaces from the host name

Parameters:
host string original host name
Return value:
host without leading and trailing spaces
local PopupButtons () -> term

Return an HBox with ok and cancel buttons for use by other dialogs.

Return value:
An HBox term for use in a CreateDialog call.
local URLScheme (string url) -> string

Get scheme of a URL, also for ISO URL get scheme of the access protocol

Parameters:
url string URL to get scheme for
Return value:
URL scheme
local RepoNameInit (string key) -> void

Init function of a widget

Parameters:
key string widget key
local RepoNameStore (string key, map event) -> void

Store function of a widget

Parameters:
key string widget key
event map which caused settings being stored
local RepoNameWidget () -> map<string,any>

Get widget description map

Return value:
widget description map
local PlainURLInit (string key) -> void

Init function of a widget

Parameters:
key string widget key
local PlainURLStore (string key, map event) -> void

Store function of a widget

Parameters:
key string widget key
event map which caused settings being stored
local PlainURLWidget () -> map<string,any>

Get widget description map

Return value:
widget description map
local NFSInit (string key) -> void

Init function of a widget

Parameters:
key string widget key
local NFSStore (string key, map event) -> void

Store function of a widget

Parameters:
key string widget key
event map which caused settings being stored
local NFSHandle (string key, map event) -> symbol

Handle function of a widget

Parameters:
key string widget key
event map which caused settings being stored
Return value:
always nil
local NFSWidget () -> map<string,any>

Get widget description map

Return value:
widget description map
local CDInit (string key) -> void

Init function of a widget

Parameters:
key string widget key
local CDStore (string key, map event) -> void

Store function of a widget

Parameters:
key string widget key
event map which caused settings being stored
local CDWidget () -> map<string,any>

Get widget description map

Return value:
widget description map
local DirInit (string key) -> void

Init function of a widget

Parameters:
key string widget key
local IsoInit (string key) -> void

Init function of a widget

Parameters:
key string widget key
local DirStore (string key, map event) -> void

Store function of a widget

Parameters:
key string widget key
event map which caused settings being stored
local IsoStore (string key, map event) -> void

Store function of a widget

Parameters:
key string widget key
event map which caused settings being stored
local DirHandle (string key, map event) -> symbol

Handle function of a widget

Parameters:
key string widget key
event map which caused settings being stored
Return value:
always nil
local IsoHandle (string key, map event) -> symbol

Handle function of a widget

Parameters:
key string widget key
event map which caused settings being stored
Return value:
always nil
local DirWidget () -> map<string,any>

Get widget description map

Return value:
widget description map
local USBInit (string key) -> void

Init function of a widget

Parameters:
key string widget key
local USBStore (string key, map event) -> void

Store function of a widget

Parameters:
key string widget key
event map which caused settings being stored
local USBWidget () -> map<string,any>

Get widget description map

Return value:
widget description map
local DiskInit (string key) -> void

Init function of a widget

Parameters:
key string widget key
local DiskStore (string key, map event) -> void

Store function of a widget

Parameters:
key string widget key
event map which caused settings being stored
local DiskWidget () -> map<string,any>

Get widget description map

Return value:
widget description map
local IsoWidget () -> map<string,any>

Get widget description map

Return value:
widget description map
local ServerHandle (string key, map event) -> symbol

Handle function of a widget

Parameters:
key string widget key
event map which caused settings being stored
Return value:
always nil
local ServerInit (string key) -> void

Init function of a widget

Parameters:
key string widget key
local ServerStore (string key, map event) -> void

Store function of a widget

Parameters:
key string widget key
event map which caused settings being stored
local ServerWidget () -> map<string,any>

Get widget description map

Return value:
widget description map
local IsAnyNetworkAvailable () -> boolean

Checks whether some network is available in the current moment, see the bug #170147 for more information.

local CRURLDefined () -> boolean

Returns whether Community Repositories are defined in the control file.

Return value:
whether defined
local _widgets -> map<string,map<string,any> >

Individual widgets

local Widgets () -> map<string,map<string,any> >

Get individual widgets

Return value:
individual widgets
local _caption -> map<string,string>

Captions for individual protocols

local PopupContents (string proto, boolean repository) -> term

Get contents of a popup for specified protocol

Parameters:
proto string protocol to display popup for
repository
Return value:
popup contents
global EditPopup (string url) -> string

URL editation popup

Parameters:
url string url URL to edit
Return value:
modified URL or empty string if canceled
global EditPopupService (string url) -> string

URL editation popup

Parameters:
url string url URL to edit
Return value:
modified URL or empty string if canceled
global EditPopupType (string url, boolean plaindir_type) -> string

URL editation popup, allows setting plaindir type

Parameters:
url string url URL to edit
plaindir_type set to true if the repository is plaindor
Return value:
modified URL or empty string if canceled
global EditPopupNoHTTPS (string url) -> string

URL editation popup without the HTTPS option

Parameters:
url string url URL to edit
Return value:
modified URL or empty string if canceled
global EditDialogProtocol (string proto) -> symbol

Sample implementation of URL selection dialog

Parameters:
proto
Return value:
for wizard sequencer
global EditDialogProtocolService (string proto) -> symbol

Sample implementation of URL selection dialog

Parameters:
proto
Return value:
for wizard sequencer
global EditDialog () -> symbol

Sample implementation of URL selection dialog

Return value:
for wizard sequencer
global TypePopup () -> string

URL editation popup with the HTTPS option

Return value:
modified URL or empty string if canceled
global TypeDialog () -> symbol

Sample implementation of URL type selection dialog

Return value:
for wizard sequencer
global TypeDialogDownloadOpt () -> map<string,any>

Sample implementation of URL type selection dialog

Return value:
for wizard sequencer