YaST2 Developers Documentation: Unknown YCP Module

Unknown YCP Module

This module has an unstable interface.

Imports

  • Message
  • Progress
  • Report
  • Summary

Global Functions

Local Variables

Info:

File: modules/XXPkgXX.ycp Package: Configuration of XXpkgXX Summary: XXPkgXX settings, input and output functions Authors: XXmaintainerXX

$Id$

global Modified () -> boolean

Prototypes

local modified -> boolean

Data was modified?

local proposal_valid -> boolean

local write_only -> boolean

Write only, used during autoinstallation. Don't run services, it's all done at one place.

Info:

Abort function return boolean return true if abort

global Abort () -> boolean

Abort function

Return value:
return true if abort
global Modified () -> boolean

Data was modified?

Return value:
true if modified
global SetModified (boolean value) -> void

Mark as modified, for Autoyast.

Parameters:
value
global WriteOnly () -> boolean

Return value:
true if module is marked as "write only" (don't start services etc...)
global SetWriteOnly (boolean value) -> void

Set write_only flag (for autoinstalation).

Parameters:
value
global Read () -> boolean

Read all XXpkgXX settings

Return value:
true on success
global Write () -> boolean

Write all XXpkgXX settings

Return value:
true on success
global Import (map settings) -> boolean

Get all XXpkgXX settings from the first parameter (For use by autoinstallation.)

Parameters:
settings The YCP structure to be imported.
Return value:
True on success
global Export () -> map

Dump the XXpkgXX settings to a single map (For use by autoinstallation.)

Return value:
Dumped settings (later acceptable by Import ())
global Summary () -> list

Create a textual summary and a list of unconfigured cards

Return value:
summary of the current configuration
global Overview () -> list

Create an overview table with all configured cards

Return value:
table items
global AutoPackages () -> map

Return packages needed to be installed and removed during Autoinstallation to insure module has all needed software installed.

Return value:
with 2 lists.