CheckBoxFrame

Name

CheckBoxFrame — Frame with clickable on/off toggle button

Synopsis

`CheckBoxFrame (`	string `label` ,
	boolean `checked` ,
	term `child` `)`;

Parameters

string label: the text describing the check box
boolean checked: whether the check box should start checked
term child: the child widgets for frame content - typically `VBox(...) or `HBox(...)

Options

noAutoEnable

do not enable/disable frame children upon status change

invertAutoAnable

disable frame children if check box is checked

Description

This is a combination of the check box widget and the frame widget: A frame that has a check box where a simple frame would have its frame title.

By default, the frame content (the child widgets) get disabled if the check box is set to "off" (unchecked) and enabled if the check box is set to "on" (cheched).

`opt(`invertAutoEnable) inverts this behaviour: It makes YCheckBoxFrame disable its content (its child widgets) if it is set to "on" (checked) and enable its content if it is set to "off".

`opt(`noAutoEnable) switches off disabling and enabling the frame content (the child widgets) completely. In that case, use QueryWidget() and/or `opt(`immediate).

Please note that unlike YCheckBox this widget does not support tri-state - it is always either on or off.

Usage

 	`CheckBoxFrame( `id( `custom), "&Custom", true, `VBox(`InputField(...), ... )

Examples

          // Trivial example for CheckBoxFrame
{
    UI::OpenDialog(
		   `VBox(
			 `MarginBox( 1, 0.5,
				     `CheckBoxFrame ( "E&xpert Settings", true,
						      `VBox(
							    `HBox(
								  `InputField( "&Server" ),
								  `ComboBox ( "&Mode",
									      [ "Automatic",
										"Manual",
										"Debug" ] )
								  ),
							    `Left( `CheckBox( "&Logging" ) ),
							    `InputField( "&Connections" )
							    )
						      )
				     ),
			 `PushButton("&OK")
			 )
		   );
    UI::UserInput();
    UI::CloseDialog();
}

          // Example for CheckBoxFrame with inverted check box:
// The frame content becomes active if the check box is off
{
    UI::OpenDialog(
		   `VBox(
			 `MarginBox( 1, 0.5,
				     `CheckBoxFrame (`opt(`invertAutoEnable),  "&Automatic", true,
						      `VBox(
							    `HBox(
								  `InputField( "&Server" ),
								  `ComboBox ( "&Mode",
									      [ "Automatic",
										"Manual",
										"Debug" ] )
								  ),
							    `Left( `CheckBox( "&Logging" ) ),
							    `InputField( "&Connections" )
							    )
						      )
				     ),
			 `PushButton("&OK")
			 )
		   );
    UI::UserInput();
    UI::CloseDialog();
}

          // Example for CheckBoxFrame without auto enable:
// The application has to handle the check box
{
    UI::OpenDialog(
		   `VBox(
			 `MarginBox( 1, 0.5,
				     `CheckBoxFrame (`id(`use_suse_server), `opt(`noAutoEnable, `notify),  "&SuSE Server", false,
						      `VBox(
							    `HBox(
								  `InputField(`id(`server), "&Server" ),
								  `ComboBox (`id(`mode  ), "&Mode",
									      [ "Automatic",
										"Manual",
										"Debug" ] )
								  ),
							    `Left(`id(`logging), `CheckBox( "&Logging" ) ),
							    `InputField(`id(`connections), "&Connections" )
							    )
						      )
				     ),
			 `PushButton(`id(`ok), "&OK")
			 )
		   );

    symbol widget = nil;
    string old_server = "";
    UI::FakeUserInput(`use_suse_server); // Use event loop to set up initial enabled/disabled states
    
    repeat
    {
	widget = (symbol) UI::UserInput();

	if ( widget == `use_suse_server )
	{
	    y2debug( "Changing enabled states" );
	    boolean use_suse_server = (boolean) UI::QueryWidget(`use_suse_server, `Value );
	    UI::ChangeWidget(`server, `Enabled, ! use_suse_server );
	    UI::ChangeWidget(`mode  , `Enabled, ! use_suse_server );

	    if ( use_suse_server )
	    {
		old_server = (string) UI::QueryWidget(`server, `Value );
		UI::ChangeWidget(`server, `Value, "ftp://ftp.opensuse.org" );
	    }
	    else
	    {
		UI::ChangeWidget(`server, `Value, old_server );
	    }
	}
	    
    } until ( widget == `ok || widget == `cancel );
    
    UI::CloseDialog();
}


CheckBox		ComboBox