ROX-CLib: ROXOption Struct Reference

- Main Page
- Data Structures
- Files
- Related Pages

- Data Structures
- Data Fields

# ROXOption Struct Reference

`#include <options.h>`

## Data Fields
gchar * | value
long | int_value
gboolean | has_changed
gchar * | backup
GtkWidget * | widget
void(* | update_widget )(ROXOption *option)
gchar *(* | read_widget )(ROXOption *option)

## Detailed Description

An option, stored as a string. It may have an integer value

## Field Documentation

gchar* ROXOption::value

Current value of the option

long ROXOption::int_value

Result of atol(value)

gboolean ROXOption::has_changed

Non-zero if changed

gchar* ROXOption::backup

Copy of value to Revert to

GtkWidget* ROXOption::widget

`NULL` => No UI yet

void(* ROXOption::update_widget)(ROXOption *option)

Called to set the widget to reflect the options current value

Parameters:

  `[in,out]` | option | the option

gchar*(* ROXOption::read_widget)(ROXOption *option)

Called to read the current value from the widget

Parameters:

  `[in]` | option | the option

Returns:
  new value

The documentation for this struct was generated from the following file:

- options.h