YaST2 Developers Documentation: Unknown YCP Module

Unknown YCP Module

This module has an unstable interface.

Includes

  • squid/SquidACL_local_functions.ycp

Global Functions

Local Variables

Info:

File: modules/SquidACL.ycp Package: Configuration of squid Summary: Definition and handling of ACL groups in Squid configuration Authors: Daniel Fiser

local acl_map -> map<string,map>

map of acl definition. format: $[ "type" : $[ "name" : "Name shown in dialogs", "widget" : `WidgetDescribingThisType, "widget_init" : FunctionWithInitsOfWidget, "verification" : FunctionCalledToVerificateContentsOfWidget, "options" : FunctionThatReturnsListOfOptions ] ]

local acl -> list<string>

List of available acls. Also specify order of acls. Values must corespond with keys in acl_map.

global SupportedACLs () -> list<string>

Returns list of supported ACLs. It's necessary to have saved unsupported ACLs but do not handle with them.

global GetTypesToComboBox () -> list<term>

Returns list of terms in form: [ `item(`id(key), acl_map[key]["name"]:""), `item(... ) ] Returned list is preferably to place in UI::ComboBox as list of all available types of ACLs.

global InitWidget (string id_acl_type, integer id_item, any help_widget_id) -> void

Initialize widget of acl identified by id_acl_type. If id_item is not nil, function initialize widgets by default values from module Squid.

Parameters:
id_acl_type
id_item
help_widget_id
global Replace (any widget_id, string id_acl_type) -> void

Replace widget with id widget_id by widget acl_map[id_acl_type]["widget"].

Parameters:
widget_id
id_acl_type
global Verify (string id_acl_type) -> boolean

This function call verification function joined with acl type identified by id_acl_type. Returns return value of verification function.

Parameters:
id_acl_type
global GetOptions (string id_acl_type) -> list<string>

Returns values from widget as list of options in correct form to store them into Squid module.

Parameters:
id_acl_type