Entire Class Index | Main Class Index | Cross Index | Global Index

# Class CL_ComponentOptions

Sets the options for components
Contained in: global
Derived from: none
Derived by: none
Group: GUI (Framework)

#include <ClanLib/gui.h>

### public function member index:
### Attributes:
``bool`` | `exists` | `(`const` `std::string`& `option_name`) `const``;
``int`` | `count` | `(`const` `std::string`& `option_name`) `const``;
``void`` | `remove_option` | `(`const` `std::string`& `option_name`)`;
``const` `std::string`&` | `get_value` | `(`const` `std::string`& `option_name`, `int` `offset`=0) `const``;
``const` `std::string`&` | `operator``[]` | `(`const` `std::string`& `option_name`) `const``;
``int`` | `get_value_as_int` | `(`const` `std::string`& `option_name`, `int` `offset`=0) `const``;
``bool`` | `get_value_as_bool` | `(`const` `std::string`& `option_name`, `int` `offset`=0) `const``;
### Operations:
``void`` | `add_option` | `(`const` `std::string`& `option_name`, `const` `std::string`& `option_value`)`;
``void`` | `add_option` | `(`const` `std::string`& `option_name`, `int` `option_value`)`;
``void`` | `clear` | `()`;
`iterator` | `begin` | `()`;
`iterator` | `end` | `()`;
`const_iterator` | `begin` | `() `const``;
`const_iterator` | `end` | `() `const``;

## Description:

## Function Member Descriptions:

CL_ComponentOptions::add_option - Add option
``void`` `add_option``(`const` `std::string`& `option_name`, `const` `std::string`& `option_value`)`;

CL_ComponentOptions::add_option - Add option
``void`` `add_option``(`const` `std::string`& `option_name`, `int` `option_value`)`;

CL_ComponentOptions::clear - Clear
``void`` `clear``()`;

CL_ComponentOptions::count - Count
``int`` `count``(`const` `std::string`& `option_name`) `const``;

CL_ComponentOptions::exists - Exists
``bool`` `exists``(`const` `std::string`& `option_name`) `const``;

CL_ComponentOptions::get_value - Getting the value of a unexisting option is undefined, so use the 'exists' function
first to check if the option exists
``const` `std::string`&` `get_value``(`const` `std::string`& `option_name`, `int` `offset`=0) `const``;

CL_ComponentOptions::get_value_as_bool - Get value as bool
``bool`` `get_value_as_bool``(`const` `std::string`& `option_name`, `int` `offset`=0) `const``;

CL_ComponentOptions::get_value_as_int - Get value as int
``int`` `get_value_as_int``(`const` `std::string`& `option_name`, `int` `offset`=0) `const``;

## Variable Member Descriptions:

CL_ComponentOptions::options - Options
`options_t` ``options`;`