Options API


Functions

oyWIDGEToyWidgetListGet (oyGROUP group, int *count)
 all widgets of a group
oyWIDGET_TYPE oyWidgetTitleGet (oyWIDGET option, const oyGROUP **categories, const char **name, const char **tooltip, int *flags)
 Get a special Options UI strings.
int oyOptionChoicesGet (oyWIDGET option, int *choices, const char ***choices_string_list, int *current)
 Get a Options choices UI strings.
void oyOptionChoicesFree (oyWIDGET_TYPE option, char ***list, int size)
 delete list of choices from a option

Detailed Description

The idea behind this API is to provide one layout for presenting a configuration dialog to users. The advantage is, every application, like KDE and Gnome Kontrolpanels, will inherit the same logic. A user can easily use the one and the other panel without too much relearning.

Functions are provided to set and query for Options layout and UI strings in Oyranos.


Function Documentation

void oyOptionChoicesFree ( oyWIDGET_TYPE  option,
char ***  list,
int  size 
)

delete list of choices from a option

Parameters:
list string list
size number of strings in the list to free

int oyOptionChoicesGet ( oyWIDGET  option,
int *  choices,
const char ***  choices_string_list,
int *  current 
)

Get a Options choices UI strings.

This function is checked for double occuring profiles. Such are sorted out.

Todo:
In the future a second choices_string_list may appear for displaying.
param option merge oyBEHAVIOUR and oyDEFAULT_PROFILE param[out] choices n choices; if choices is zero then you need to optain the choices otherwise, like for profiles param[out] choices_strings translated list of n choices param[out] current the actual setting

return success

oyWIDGET* oyWidgetListGet ( oyGROUP  group,
int *  count 
)

all widgets of a group

param group specify which group dialog to build param[out] count number of widgets contained in list

return list of widgets to create in correct order

oyWIDGET_TYPE oyWidgetTitleGet ( oyWIDGET  option,
const oyGROUP **  categories,
const char **  name,
const char **  tooltip,
int *  flags 
)

Get a special Options UI strings.

param option merges oyBEHAVIOUR and oyDEFAULT_PROFILE param[out] categories enums list, to place into the right group widget { n, first category, second c., ... , n'th c. } for widget of type oyGROUP this is empty param[out] name transated widget title param[out] tooltip transated tooltip

return widget type, gives a hint to further properties, { like choices or int/float value ranges ... }


Generated on Sat Jun 16 21:05:41 2007 for Oyranos by  doxygen 1.5.1