![]() |
![]() |
![]() |
[Insert name here] Reference Manual | ![]() |
---|---|---|---|---|
#define tpa_parameter_GET_CLASS (obj) #define TPA_PARAMETER_GET_PRIVATE (obj) TpaParameterPrivate; TpaParameter; TpaParameter* tpa_parameter_new (const gchar *name, GType type); const gchar* tpa_parameter_get_name (TpaParameter *self); GValue* tpa_parameter_get_default_value (TpaParameter *self); gchar* tpa_parameter_get_default_value_as_string (TpaParameter *self); guint tpa_parameter_get_default_value_as_uint (TpaParameter *self); gint tpa_parameter_get_default_value_as_int (TpaParameter *self); gboolean tpa_parameter_get_default_value_as_boolean (TpaParameter *self); gboolean tpa_parameter_set_default_value (TpaParameter *self, GValue *value); gboolean tpa_parameter_set_default_value_as_string (TpaParameter *self, const gchar *value_as_string); gboolean tpa_parameter_set_default_value_as_uint (TpaParameter *self, guint value_as_uint); gboolean tpa_parameter_set_default_value_as_int (TpaParameter *self, gint value_as_int); gboolean tpa_parameter_set_default_value_as_boolean (TpaParameter *self, gboolean value_as_boolean); GValue* tpa_parameter_get_value (TpaParameter *self); gchar* tpa_parameter_get_value_as_string (TpaParameter *self); guint tpa_parameter_get_value_as_uint (TpaParameter *self); gint tpa_parameter_get_value_as_int (TpaParameter *self); gboolean tpa_parameter_get_value_as_boolean (TpaParameter *self); gboolean tpa_parameter_set_value (TpaParameter *self, GValue *value); gboolean tpa_parameter_set_value_as_string (TpaParameter *self, const gchar *value_as_string); gboolean tpa_parameter_set_value_as_uint (TpaParameter *self, guint value_as_uint); gboolean tpa_parameter_set_value_as_int (TpaParameter *self, gint value_as_int); gboolean tpa_parameter_set_value_as_boolean (TpaParameter *self, gboolean value_as_boolen); TpaParameterFlags tpa_parameter_get_flags (TpaParameter *self); #define tpa_parameter_has_required_flag (self) #define tpa_parameter_has_register_flag (self) #define tpa_parameter_has_default_flag (self) gboolean tpa_parameter_set_flags (TpaParameter *self, TpaParameterFlags flags); #define tpa_parameter_set_required_flag (self) #define tpa_parameter_set_register_flag (self) #define tpa_parameter_set_default_flag (self)
TpaParameter* tpa_parameter_new (const gchar *name, GType type);
Create new instance of TpaParameter.
name : |
|
type : |
|
Returns : | TpaParametes instance. |
const gchar* tpa_parameter_get_name (TpaParameter *self);
Get parameter's name.
self : |
TpaParameter instance |
Returns : | NULL if fail. |
GValue* tpa_parameter_get_default_value (TpaParameter *self);
Get copy of parameter default value that must be free.
self : |
TpaParameter instance |
Returns : | NULL if fail. |
gchar* tpa_parameter_get_default_value_as_string (TpaParameter *self);
Function to get any parameter default value to string. Note that self function convert parameter value to string.
Supports convertions to: boolean: "true" for TRUE value. "false" for FALSE value. double integer string
self : |
TpaParameter instance |
Returns : | NULL if fail. |
guint tpa_parameter_get_default_value_as_uint (TpaParameter *self);
Fast function to get parameter default value that has known type as unsigned integer. DO NOT USE IT FOR NON-UINTEGER PARAMETERS.
self : |
TpaParameter instance |
Returns : | 0 if fail. |
gint tpa_parameter_get_default_value_as_int (TpaParameter *self);
Fast function to get parameter default value that has known type as integer. DO NOT USE IT FOR NON-INTEGER PARAMETERS.
self : |
TpaParameter instance |
Returns : | 0 if fail. |
gboolean tpa_parameter_get_default_value_as_boolean (TpaParameter *self);
Fast function to get parameter default value that has known type as boolean. DO NOT USE IT FOR NON-BOOLEAN PARAMETERS.
self : |
TpaParameter instance |
Returns : | -1 if fail. |
gboolean tpa_parameter_set_default_value (TpaParameter *self, GValue *value);
Set parameter default value, givin value must hold the same type as parameter.
self : |
TpaParameter instance |
value : |
New GValue value. |
Returns : | FALSE if fail. |
gboolean tpa_parameter_set_default_value_as_string (TpaParameter *self, const gchar *value_as_string);
Function to set any string default value to parameter value. Note that self function convert the given value to parameter type if it is not string type.
Supports convertions to: boolean: "true" for TRUE value. "false" for FALSE value. double integer string
self : |
TpaParameter instance |
value_as_string : |
New string value or string to be converted. |
Returns : | FALSE if fail. |
gboolean tpa_parameter_set_default_value_as_uint (TpaParameter *self, guint value_as_uint);
Fast function to set parameter default value that has known type as unsigned integer. DO NOT USE IT FOR NON-UINTEGER PARAMETERS.
self : |
TpaParameter instance |
value_as_uint : |
New integer value. |
Returns : | FALSE if fail. |
gboolean tpa_parameter_set_default_value_as_int (TpaParameter *self, gint value_as_int);
Fast function to set parameter default value that has known type as integer. DO NOT USE IT FOR NON-INTEGER PARAMETERS.
self : |
TpaParameter instance |
value_as_int : |
New integer value. |
Returns : | FALSE if fail. |
gboolean tpa_parameter_set_default_value_as_boolean (TpaParameter *self, gboolean value_as_boolean);
Fast function to set parameter dafault value that has known type as boolean. DO NOT USE IT FOR NON-BOOLEAN PARAMETERS.
self : |
TpaParameter instance |
value_as_boolean : |
New boolean value. |
Returns : | FALSE if fail. |
GValue* tpa_parameter_get_value (TpaParameter *self);
Get copy of parameter value that must be free.
self : |
TpaParameter instance |
Returns : | NULL if fail. |
gchar* tpa_parameter_get_value_as_string (TpaParameter *self);
Function to get any parameter value to string. Note that self function convert parameter value to string.
Supports convertions to: boolean: "true" for TRUE value. "false" for FALSE value. double integer string
self : |
TpaParameter instance |
Returns : | NULL if fail. |
guint tpa_parameter_get_value_as_uint (TpaParameter *self);
Fast function to get parameter value that has known type as unsigned integer. DO NOT USE IT FOR NON-UINTEGER PARAMETERS.
self : |
TpaParameter instance |
Returns : | 0 if fail. |
gint tpa_parameter_get_value_as_int (TpaParameter *self);
Fast function to get parameter value that has known type as integer. DO NOT USE IT FOR NON-INTEGER PARAMETERS.
self : |
TpaParameter instance |
Returns : | 0 if fail. |
gboolean tpa_parameter_get_value_as_boolean (TpaParameter *self);
Fast function to get parameter value that has known type as boolean. DO NOT USE IT FOR NON-BOOLEAN PARAMETERS.
self : |
TpaParameter instance |
Returns : | -1 if fail. |
gboolean tpa_parameter_set_value (TpaParameter *self, GValue *value);
Set parameter value, givin value must hold the same type as parameter.
self : |
TpaParameter instance |
value : |
New GValue value. |
Returns : | FALSE if fail. |
gboolean tpa_parameter_set_value_as_string (TpaParameter *self, const gchar *value_as_string);
Function to set any string value to parameter value. Note that this function convert the given value to parameter type if it is not string type.
Supports convertions to: boolean: "true" for TRUE value "false" for FALSE value double integer string
self : |
TpaParameter instance |
value_as_string : |
New string value or string to be converted. |
Returns : | FALSE if fail. |
gboolean tpa_parameter_set_value_as_uint (TpaParameter *self, guint value_as_uint);
Fast function to set parameter value that has known type as unsigned integer. DO NOT USE IT FOR NON-UINTEGER PARAMETERS.
self : |
TpaParameter instance |
value_as_uint : |
New unsigned integer value. |
Returns : | FALSE if fail. |
gboolean tpa_parameter_set_value_as_int (TpaParameter *self, gint value_as_int);
Fast function to set parameter value that has known type as integer. DO NOT USE IT FOR NON-INTEGER PARAMETERS.
self : |
TpaParameter instance |
value_as_int : |
New integer value. |
Returns : | FALSE if fail. |
gboolean tpa_parameter_set_value_as_boolean (TpaParameter *self, gboolean value_as_boolen);
Fast function to set parameter value that has known type as boolean. DO NOT USE IT FOR NON-BOOLEAN PARAMETERS.
self : |
TpaParameter instance |
value_as_boolen : |
|
Returns : | FALSE if fail. |
TpaParameterFlags tpa_parameter_get_flags (TpaParameter *self);
Get parameter flags.
self : |
TpaParameter instance |
Returns : | TpaParameterFlags |
gboolean tpa_parameter_set_flags (TpaParameter *self, TpaParameterFlags flags);
Set parameter flags.
self : |
TpaParameter instance |
flags : |
|
Returns : | FALSE if fail. |