Table of Contents
- XXII. Address manipulation routines
- Address::Check -
Check syntax of a network address (IP address or hostname)
- Address::Check4 -
Check syntax of a network address (ip4 or name)
- Address::Check6 -
Check syntax of a network address (ip6 or name)
- Address::Valid4 -
Return a description of a valid address (ip4 or name)
- XXIII. Confirmation routines
- Confirm::Delete -
Opens a popup yes/no confirmation.
- Confirm::DeleteSelected -
Opens a popup yes/no confirmation.
- Confirm::Detection -
Confirm hardware detection (only in manual installation)
- Confirm::MustBeRoot -
If we are running as root, return true.
Otherwise ask the user whether we should continue even though things
might not work
- XXIV. Command line interface for YaST2 modules
- CommandLine::Abort -
Abort the command line handling
- CommandLine::Aborted -
User asked for abort (forgetting the changes)
- CommandLine::Command - Get next user-given command
- CommandLine::Done -
Are there some commands to be processed?
- CommandLine::Error - Print an Error Message
- CommandLine::Init - Initialize Module
- CommandLine::Interactive -
Is module started in interactive command-line mode?
- CommandLine::Parse - Parse a list of arguments.
- CommandLine::PasswordInput - Read input from command line
- CommandLine::Print - Print a String
- CommandLine::Run - Parse the Command Line
- CommandLine::Scan - Scan a command line from stdin, return it split into a list
- CommandLine::StartGUI -
Should module start UI?
- CommandLine::UniqueOption - Check uniqueness of an option
- CommandLine::UserInput -
Read input from command line
- XXV. Hostname manipulation routines
- Hostname::Check -
Check syntax of hostname entry
(that is a domain name component, unqualified, without dots)
- Hostname::CheckDomain -
Check syntax of domain entry
- Hostname::CheckFQ -
Check syntax of fully qualified hostname
- Hostname::MergeFQ -
Merge short hostname and domain to full-qualified host name
- Hostname::SplitFQ -
Split FQ hostname to hostname and domain name
- Hostname::ValidDomain -
describe a valid domain name
- Hostname::ValidFQ -
describe a valid FQ host name
- XXVI. Generic HTML formatting
- HTML::Bold -
Make a piece of HTML code bold
- HTML::ColoredList -
Make a HTML (unsorted) colored list from a list of strings
- HTML::Colorize -
Colorize a piece of HTML code
- HTML::Heading -
Make a HTML heading from a text
- HTML::Link -
Make a HTML link
- HTML::List -
Make a HTML (unsorted) list from a list of strings
- HTML::ListEnd -
End a HTML (unsorted) list
- HTML::ListItem -
Make a HTML list item
- HTML::ListStart -
Start a HTML (unsorted) list
- HTML::Newline -
Make a forced HTML line break
- HTML::Newlines -
Make a number of forced HTML line breaks
- HTML::Para -
Make a HTML paragraph from a text
- XXVII. IP manipulation routines
- IP::Check -
Check syntax of IP address
- IP::Check4 -
Check syntax of IPv4 address
- IP::Check6 -
Check syntax of IPv6 address
- IP::ComputeBroadcast -
Compute IPv4 broadcast address from ip4 address and network mask.
- IP::ComputeNetwork -
Compute IPv4 network address from ip4 address and network mask.
- IP::ToHex -
Converts IPv4 address from string to hex format
- IP::ToInteger -
Convert IPv4 address from string to integer
- IP::ToString -
Convert IPv4 address from integer to string
- IP::Valid4 -
Describe a valid IPv4 address
- XXVIII. Map manipulation routines
- Map::CheckKeys -
Check if a map contains all needed keys
- Map::FromString -
Convert string "var=val ..." to map $[val:var, ...]
- Map::Keys -
Return all keys from the map
- Map::KeysToLower -
Switch map keys to lower case
- Map::KeysToUpper -
Switch map keys to upper case
- Map::ToString -
Convert options map $[var:val, ...] to string "var=val ..."
- Map::Values -
Return all values from the map
- XXIX. Netmask manipulation routines
- Netmask::Check -
Check the netmask
- Netmask::Check4 -
Check the IPv4 netmask
Note that 0.0.0.0 is not a correct netmask.
- Netmask::Check6 -
Check the IPv6 netmask
- Netmask::FromBits -
Convert netmask in bits form (24) to netmask string (255.255.240.0)
- Netmask::ToBits -
Convert IPv4 netmask as string (255.255.240.0) to bits form (24)
- XXX.
Popup dialogs for browsing the local network
- NetworkPopup::ChooseItem -
Let the user choose one of a list of items
- NetworkPopup::HostName -
Give me one host name on the local network
- NetworkPopup::NFSExport -
Give me export path of selected server
- NetworkPopup::NFSServer -
Give me NFS server name on the local network
- XXXI. Packages manipulation
- Package::DoInstall -
Install list of packages
- Package::DoInstallAndRemove -
Install and Remove list of packages in one go
- Package::DoRemove -
Remove list of packages
- Package::AvailableAll -
Are all of these packages available?
- Package::AvailableAny -
Is any of these packages available?
- Package::InstallAllMsg -
Install list of packages with a custom text message
- Package::InstallMsg -
Install a package with a custom text message
- Package::InstalledAll -
Are all of these packages installed?
- Package::InstalledAny -
Is any of these packages installed?
- Package::LastOperationCanceled -
Return result of the last operation
Use immediately after calling any Package*:: function
- Package::RemoveAllMsg -
Remove a list of packages with a custom text message
- Package::RemoveMsg -
Remove a package with a custom text message
- Package::RunSUSEconfig -
Run SUSEconfig, create new wizard dialog before it,
close after it is finished
- XXXII. Progress bar
- Progress::CloseSuperior -
Replaces stages of superior progress by an empty help text.
- Progress::Finish -
Moves progress bar to the end and marks all stages as completed.
- Progress::New -
New complex progress bar with stages.
- Progress::NextStage -
Advance stage, advance step by 1 and set progress bar caption to
that defined in New.
- Progress::NextStageStep -
Jumps to the next stage and sets step to st.
- Progress::NextStep -
Some people say it is the best operating system ever. But now to the
function. Advances progress bar value by 1.
- Progress::OpenSuperior -
Creates a higher-level progress bar made of stages. Currently it is
placed instead of help text.
- Progress::Simple -
Create simple progress bar with no stages, only with progress bar.
- Progress::Stage -
Go to stage st, change progress bar title to title and set progress
bar step to step.
- Progress::Step -
Changes progress bar value to st.
- Progress::StepSuperior -
Make one step in a superior progress bar.
- Progress::Title -
Change progress bar title.
- Progress::off -
Turns progress bar off. All Progress:: calls return immediatelly.
- Progress::on -
Turns progress bar on after calling Progress::off.
- XXXIII. Messages handling
- Report::AnyQuestion -
Question with headline and Yes/No Buttons
- Report::ClearAll -
Clear all stored messages (errors, messages and warnings)
- Report::ClearErrors -
Clear stored errors
- Report::ClearMessages -
Clear stored messages
- Report::ClearWarnings -
Clear stored warnings
- Report::ClearYesNoMessages -
Clear stored yes/no messages
- Report::DisplayErrors -
Error popup dialog can displayed immediately when new error is stored.
- Report::DisplayMessages -
Message popup dialog can be displayed immediately when a new message is stored.
- Report::DisplayWarnings -
Warning popup dialog can displayed immediately when new warningr is stored.
- Report::DisplayYesNoMessages -
Yes/No Message popup dialog can be displayed immediately when a new message is stored.
- Report::Error -
Store new error text
- Report::Export -
Dump the Report settings to a map, for autoinstallation use.
- Report::GetMessages -
Create rich text string from stored warning, message or error messages.
- Report::GetModified -
Functions which returns if the settings were modified
- Report::Import -
Get all the Report configuration from a map.
- Report::LogErrors -
Set warnings logging to .y2log file
- Report::LogMessages -
Set messages logging to .y2log file
- Report::LogWarnings -
Set warnings logging to .y2log file
- Report::LogYesNoMessages -
Set yes/no messages logging to .y2log file
- Report::Message -
Store new message text
- Report::NumErrors -
Return number of stored errors
- Report::NumMessages -
Return number of stored messages
- Report::NumWarnings -
Return number of stored warnings
- Report::NumYesNoMessages -
Return number of stored yes/no messages
- Report::SetModified -
Function sets internal variable, which indicates, that any
settings were modified, to "true"
- Report::ShowText -
Store new message text
- Report::Summary -
Summary of current settings
- Report::Warning -
Store new warning text
- XXXIV. Rich text manipulation routines
- RichText::Rich2Plain -
Convert a richtext string into a formatted plain text.
- XXXV. Wizard Sequencer
- Sequencer::Run -
The Wizard Sequencer
- Sequencer::WS_alias -
Find an aliases in the aliases map
- Sequencer::WS_check -
Check correct types in maps and alias presence for sequence.
- Sequencer::WS_error -
Report error and return nil
- Sequencer::WS_next -
Find a next item in the sequence
- Sequencer::WS_pop -
Pop one item from the stack (remove an item and return the stack top item)
- Sequencer::WS_push -
Push one item to the stack
- Sequencer::WS_run -
Run a function from the aliases map
- Sequencer::WS_special -
Decide if an alias is special
- Sequencer::WS_testall -
Test (run) all dialogs in the aliases map
- XXXVI. Service manipulation
- Service::Adjust -
Adjust runlevels in which the service runs.
- Service::Disable -
Disable service
- Service::Enable -
Enable service
- Service::Enabled -
Check if service is enabled
- Service::Error -
Error Message
- Service::Finetune -
Set service to run in selected runlevels.
- Service::FullInfo -
Get service info and find out whether service is running.
- Service::Info -
Get service info without peeking if service runs.
- Service::Reload -
Reload service
- Service::Restart -
Restart service
- Service::RunInitScript -
Run init script.
- Service::RunInitScriptOutput -
Run init script and return output
- Service::Start -
Start service
- Service::Status -
Get service status.
- Service::Stop -
Stop service
- XXXVII. String manipulation routines
- String::CAlnum -
- String::CAlpha -
- String::CDigit -
- String::CGraph -
- String::CLower -
- String::CPrint -
- String::CPunct -
- String::CSpace -
- String::CUpper -
- String::CXdigit -
- String::CutBlanks -
Remove blanks at begin and end of input string.
- String::CutRegexMatch -
Remove first or every match of given regular expression from a string
- String::CutZeros -
Remove any leading zeros
- String::EscapeTags -
Function for escaping (replacing) (HTML|XML...) tags with their
(HTML|XML...) meaning.
- String::FirstChunk -
Shorthand for select (splitstring (s, separators), 0, "")
Useful now that the above produces a deprecation warning.
- String::FormatSize -
Return a pretty description of a byte count
- String::FormatSizeWithPrecision -
Return a pretty description of a byte count
- String::Pad -
Add spaces after the text to make it long enough
- String::PadZeros -
Add zeros before the text to make it long enough.
- String::ParseOptions -
Parse string of values
- String::Quote -
Quote a string with 's
- String::UnQuote -
Unquote a string with 's (quoted with quote)
- String::ValidCharsFilename -
Characters valid in a filename (not pathname).
Naturally "/" is disallowed. Otherwise, the graphical ASCII
characters are allowed.
- XXXVIII. Support for summaries of the configured devices
- Summary::AddHeader -
Add a RichText section header to an existing summary.
- Summary::AddLine -
Add a line to an existing summary.
- Summary::AddListItem -
Add a list item to an existing summary.
Requires a previous call to 'summaryOpenList()'.
- Summary::AddNewLine -
Add a newline to an existing summary.
- Summary::AddSimpleSection -
Add a simple section to an existing summary,
consisting of a header and one single item.
- Summary::CloseList -
End a list within a summary.
- Summary::Device -
Function that creates description of one device.
- Summary::DevicesList -
Function that creates the whole final product. "Not detected" will be returned
if the list is empty.
- Summary::NotConfigured -
Function that creates a 'Not configured.' message.
- Summary::OpenList -
Start a list within a summary.
- XXXIX. Type repository for validation of user-defined types
- TypeRepository::TypeRepository -
Constructor, defines the known types.
- TypeRepository::enum_validator -
Generic enumerated type validator.
- TypeRepository::is_a -
Validate, that the given value is of given type.
- TypeRepository::regex_validator -
Generic regular expression validator.
- XL. Manipulate and Parse URLs
- URL::Build -
Build URL from tokens as parsed with Parse
- URL::Check -
Check URL
- URL::Parse -
Tokenize URL
- XLI. Wizard dialogs for hardware configuration
- Wizard_hw::ConfiguredContent -
Create the contents of screen with configured items.
- Wizard_hw::DetectedContent -
Create the content of the screen with the detected devices.
- Wizard_hw::SizeAtLeast -
Encloses the content into VBoxes and HBoxes
- Wizard_hw::SpacingAround -
Encloses the content into VBoxes and HBoxes with the appropriate
spacings around it.
- XLII. Wizard dialog
- Wizard::AbortAcceptButtonBox -
Returns a button box with buttons "Abort", "Accept"
- Wizard::AbortApplyFinishButtonBox -
Returns a button box with buttons "Abort", "Apply", "Finish"
- Wizard::AbortInstallationAcceptButtonBox -
Returns a button box with buttons "Abort Installation", "Accept"
- Wizard::AcceptDialog -
Returns a standard wizard dialog with buttons "Cancel", "Accept"
- Wizard::AddMenu -
Add Menu
- Wizard::AddMenuEntry -
Add Menu Entry
- Wizard::AddSubMenu -
Add Sub Menu
- Wizard::AddTreeItem -
Add Tree Item to tree enabled Wizard
- Wizard::BackAbortInstallationNextButtonBox -
Returns a button box with buttons "Back", "Abort Installation", "Next"
- Wizard::BackAbortNextButtonBox -
Returns a button box with buttons "Back", "Abort", "Next"
- Wizard::BackNextButtonBox -
Returns a button box with buttons "Back", "Next"
- Wizard::CancelAcceptButtonBox -
Returns a button box with buttons "Cancel", "Accept"
- Wizard::ClearContents -
Clear the wizard contents.
- Wizard::ClearTitleIcon -
Clear the wizard 'title' icon, i.e. replace it with nothing
- Wizard::CloseDialog -
Close a wizard dialog.
- Wizard::CreateDialog -
Create and open a typical installation wizard dialog.
- Wizard::CreateMenu -
Create the menu in the dialog
- Wizard::CreateTree -
Create the tree in the dialog, replaces helpspace with new tree widget
- Wizard::CreateTreeDialog -
Create and open a Tree wizard dialog.
- Wizard::DeleteMenus -
Delete Menu items
- Wizard::DeleteTreeItems -
Delete Tree items
- Wizard::DisableAbortButton -
Disable the wizard's "Abort" button.
- Wizard::DisableBackButton -
Disable the wizard's "Back" button.
- Wizard::DisableCancelButton -
Disable the wizard's "Cancel" button.
- Wizard::DisableNextButton -
Disable the wizard's "Next" (or "Accept") button.
- Wizard::EnableAbortButton -
Enable the wizard's "Abort" button.
- Wizard::EnableBackButton -
Enable the wizard's "Back" button.
- Wizard::EnableCancelButton -
Enable the wizard's "Cancel" button.
- Wizard::EnableNextButton -
Enable the wizard's "Next" (or "Accept") button.
- Wizard::GenericDialog - Create a Generic Dialog
- Wizard::HideAbortButton -
Hide the Wizard's "Abort" button.
Restore it later with RestoreAbortButton():
- Wizard::HideBackButton -
Hide the Wizard's "Back" button.
Restore it later with RestoreBackButton():
- Wizard::HideNextButton -
Hide the Wizard's "Next" button.
Restore it later with RestoreNextButton():
- Wizard::IsWizardDialog -
Check if the topmost dialog is a wizard dialog
(i.e. has a widget with `id(`WizardDialog) )
- Wizard::NextBackDialog -
Returns a standard wizard dialog with buttons "Next", "Back", "Abort".
- Wizard::OpenAbortApplyFinishDialog -
Open a dialog with "Accept", "Cancel"
and set the keyboard focus to "Accept".
- Wizard::OpenAcceptAbortStepsDialog -
Open a dialog with "Accept", "Cancel" that will also accept workflow steps.
- Wizard::OpenAcceptDialog -
Open a dialog with "Accept", "Cancel"
and set the keyboard focus to "Accept".
- Wizard::OpenAcceptStepsDialog -
Open a dialog with "Accept", "Cancel" that will also accept workflow steps.
- Wizard::OpenCustomDialog -
Open a wizard dialog with simple layout
- Wizard::OpenDialog -
Open any wizard dialog.
- Wizard::OpenNextBackDialog -
Open a dialog with buttons "Next", "Back", "Abort"
and set the keyboard focus to "Next".
- Wizard::OpenNextBackStepsDialog -
Open a dialog with "Back", "Next", "Abort" that will also accept workflow steps.
- Wizard::OpenTreeNextBackDialog -
Open a Tree dialog with buttons "Next", "Back", "Abort"
and set the keyboard focus to "Next".
- Wizard::QueryTreeItem -
Query Tree Item
- Wizard::ReplaceAbortButton -
Replace the wizard 'abort' button with a custom widget.
THIS FUNCTION IS DEPRECATED!
- Wizard::ReplaceBackButton -
Replace the wizard 'back' button with a custom widget.
THIS FUNCTION IS DEPRECATED!
- Wizard::ReplaceCustomHelp -
Replace the help widget for dialogs opened with Wizard::OpenCustomDialog().
- Wizard::ReplaceHelp -
Replace the wizard help subwindow with a custom widget.
- Wizard::ReplaceNextButton -
Replace the wizard 'next' button with a custom widget.
THIS FUNCTION IS DEPRECATED!
- Wizard::RestoreAbortButton -
Restore the wizard 'abort' button.
- Wizard::RestoreBackButton -
Restore the wizard 'back' button.
- Wizard::RestoreHelp -
Restore the wizard help subwindow.
- Wizard::RestoreNextButton -
Restore the wizard 'next' button.
- Wizard::RestoreScreenShotName -
Restore the screenshot name.
- Wizard::RetranslateButtons -
Retranslate the wizard buttons.
- Wizard::SelectTreeItem -
Select Tree item
- Wizard::SetAbortButton -
Set the dialog's "Abort" button with a new label and a new ID
- Wizard::SetBackButton -
Set the dialog's "Back" button with a new label and a new ID
- Wizard::SetContents -
Set the contents of a wizard dialog
- Wizard::SetContentsButtons -
Set contents and Buttons of wizard dialog
- Wizard::SetDesktopIcon -
Set Desktop Icon
- Wizard::SetFocusToBackButton -
Set the keyboard focus to the wizard's "Back" (or "Cancel") button.
- Wizard::SetFocusToNextButton -
Set the keyboard focus to the wizard's "Next" (or "Accept") button.
- Wizard::SetHelpText -
Set a new help text.
- Wizard::SetNextButton -
Set the dialog's "Next" button with a new label and a new ID
- Wizard::SetProductName -
Set the product name for UI
- Wizard::SetScreenShotName -
Declare a name for the current dialog
- Wizard::SetTitleIcon -
Set the wizard 'title' icon
- Wizard::ShowHelp -
Open a popup dialog that displays a help text (rich text format).
- Wizard::UserInput -
Substitute for UI::UserInput
- XLIII. Commonly used popup dialogs
- Popup::AnyMessage -
Generic message popup
- Popup::AnyQuestion -
Generic question popup with two buttons.
- Popup::AnyQuestion3 -
Generic question popup with three buttons.
- Popup::AnyQuestionRichText -
Show a question that might need scrolling.
- Popup::AnyTimedMessage -
Generic message popup
- Popup::ClearFeedback -
Clear feedback message
- Popup::ConfirmAbort -
Confirmation for "Abort" button during installation.
- Popup::ContinueCancel -
Dialog which displays the "message" and has a <b>Continue</b>
and a <b>Cancel</b> button.
- Popup::ContinueCancelHeadline -
Dialog which displays the "message" and has a <b>Continue</b>
and a <b>Cancel</b> button.
- Popup::Error -
Show an error message and wait until user clicked "OK".
- Popup::LongText -
Show a long text that might need scrolling.
- Popup::Message -
Show a simple message and wait until user clicked "OK".
- Popup::ModuleError -
Special error popup for YCP modules that don't work.
- Popup::NoHeadline -
Indicator for empty headline for popups that can optionally have one
- Popup::Notify -
Show a notification message and wait until user clicked "OK".
- Popup::ReallyAbort -
Confirmation popup when user clicked "Abort".
- Popup::ShowFeedback -
Show popup with a headline and a message for feedback
- Popup::ShowFile -
Show the contents of an entire file in a popup.
- Popup::ShowText -
Show the contents of an entire file in a popup.
- Popup::ShowTextTimed -
Show the contents of an entire file in a popup.
- Popup::TimedAnyQuestion -
Timed question popup with two buttons and time display
- Popup::TimedError -
Show an error message and wait specified amount of time or until user clicked "OK".
- Popup::TimedMessage -
Display a message with a timeout and return when the user clicks "OK"
or when the timeout expires.
- Popup::TimedOKCancel -
Display a message with a timeout
- Popup::TimedWarning -
Show a warning message and wait specified amount of time or until user clicked "OK".
- Popup::Warning -
Show a warning message and wait until user clicked "OK".
- Popup::YesNo -
Display a yes/no question and wait for answer.
- Popup::YesNoHeadline -
This dialog displays "message" (a question) and has a <b>Yes</b> and
a <b>No</b> button.
