synfig::ParamDesc Class Reference

Parameter Description Class. More...

#include <paramdesc.h>

List of all members.

Public Member Functions

 ParamDesc (const String &a="IM_A_BUG_SO_REPORT_ME")
 ParamDesc (const ValueBase &, const String &a)
 ParamDesc (synfig::Color::BlendMethod, const String &a)
const std::list< EnumData > & get_enum_list () const
ParamDescset_local_name (const String &n)
 Sets the localized name of the parameter.
ParamDescset_description (const String &d)
 Sets the localized description of the parameter.
ParamDescset_group (const String &n)
 Sets the group that this parameter is a member of.
ParamDescset_hint (const String &h)
 Sets a "hint" for the parameter.
ParamDescset_connect (const String &h)
ParamDescset_box (const String &h)
ParamDescset_invisible_duck (bool x=true)
 Sets a flag regarding the duck visibility.
bool get_invisible_duck ()
 Returns the flag regarding duck visibility.
ParamDescset_animation_only (bool x=true)
bool get_animation_only ()
ParamDescset_origin (const String &h)
 Sets which parameter is to be used as the origin when the user edits visually.
ParamDescset_scalar (const Real &n)
 Sets the scalar value for the parameter.
ParamDescnot_critical ()
 Marks the parameter as not necessary for saving or copying.
ParamDeschidden ()
ParamDescread_only ()
 Marks the parameter as only readable. Implies not_critical().
ParamDescwrite_only ()
 Marks the parameter as only writable. Implies not_critical().
ParamDescadd_enum_value (int val, const String &enum_name, const String &enum_local_name)
 Adds a description of a possible enumeration value.
const Stringget_local_name () const
 Returns the localized name of the parameter.
const Stringget_name () const
 Returns the name of the parameter.
const Stringget_description () const
 Returns the localized description of the parameter.
const Stringget_group () const
 Returns the parameter's group.
const Stringget_hint () const
 Returns a "hint" about the parameter, regarding how it is to be displayed to the user.
const Stringget_origin () const
 Returns the name of the parameter that is defined as the "origin". Used for visual editing.
const Stringget_connect () const
const Stringget_box () const
const Realget_scalar () const
 Returns the scalar value for the parameter. Used for visual editing.
bool get_critical () const
 Returns true if the layer is critical, false otherwise.
bool get_hidden () const
 Returns true if the layer is hidden, false otherwise.
ParamDescset_is_distance (bool x=true)
bool get_is_distance () const

Classes

struct  EnumData


Detailed Description

Parameter Description Class.

Todo:
writeme

Constructor & Destructor Documentation

synfig::ParamDesc::ParamDesc ( const String a = "IM_A_BUG_SO_REPORT_ME"  )  [inline]

ParamDesc::ParamDesc ( const ValueBase ,
const String a 
)

ParamDesc::ParamDesc ( synfig::Color::BlendMethod  ,
const String a 
)


Member Function Documentation

const std::list<EnumData>& synfig::ParamDesc::get_enum_list (  )  const [inline]

Todo:
This needs to be documented further.

ParamDesc& synfig::ParamDesc::set_local_name ( const String n  )  [inline]

Sets the localized name of the parameter.

Referenced by ParamDesc().

ParamDesc& synfig::ParamDesc::set_description ( const String d  )  [inline]

Sets the localized description of the parameter.

ParamDesc& synfig::ParamDesc::set_group ( const String n  )  [inline]

Sets the group that this parameter is a member of.

ParamDesc& synfig::ParamDesc::set_hint ( const String h  )  [inline]

Sets a "hint" for the parameter.

Referenced by ParamDesc().

ParamDesc& synfig::ParamDesc::set_connect ( const String h  )  [inline]

Todo:
This needs to be documented further.

ParamDesc& synfig::ParamDesc::set_box ( const String h  )  [inline]

Todo:
This needs to be documented further.

ParamDesc& synfig::ParamDesc::set_invisible_duck ( bool  x = true  )  [inline]

Sets a flag regarding the duck visibility.

bool synfig::ParamDesc::get_invisible_duck (  )  [inline]

Returns the flag regarding duck visibility.

ParamDesc& synfig::ParamDesc::set_animation_only ( bool  x = true  )  [inline]

Todo:
This needs to be documented further.

bool synfig::ParamDesc::get_animation_only (  )  [inline]

Todo:
This needs to be documented further.

ParamDesc& synfig::ParamDesc::set_origin ( const String h  )  [inline]

Sets which parameter is to be used as the origin when the user edits visually.

ParamDesc& synfig::ParamDesc::set_scalar ( const Real n  )  [inline]

Sets the scalar value for the parameter.

This value determines how the value is to be presented to the user when editing visually.

ParamDesc& synfig::ParamDesc::not_critical (  )  [inline]

Marks the parameter as not necessary for saving or copying.

ParamDesc& synfig::ParamDesc::hidden (  )  [inline]

Todo:
This needs to be documented further.

ParamDesc& synfig::ParamDesc::read_only (  )  [inline]

Marks the parameter as only readable. Implies not_critical().

Todo:
This function needs to be written, as it is only a stub

ParamDesc& synfig::ParamDesc::write_only (  )  [inline]

Marks the parameter as only writable. Implies not_critical().

Todo:
This function needs to be written, as it is only a stub

ParamDesc& synfig::ParamDesc::add_enum_value ( int  val,
const String enum_name,
const String enum_local_name 
) [inline]

Adds a description of a possible enumeration value.

Only relevant if the parameter is of an integer type and hint set to "enum" .

Referenced by ParamDesc().

const String& synfig::ParamDesc::get_local_name (  )  const [inline]

Returns the localized name of the parameter.

const String& synfig::ParamDesc::get_name (  )  const [inline]

Returns the name of the parameter.

const String& synfig::ParamDesc::get_description (  )  const [inline]

Returns the localized description of the parameter.

const String& synfig::ParamDesc::get_group (  )  const [inline]

Returns the parameter's group.

const String& synfig::ParamDesc::get_hint (  )  const [inline]

Returns a "hint" about the parameter, regarding how it is to be displayed to the user.

const String& synfig::ParamDesc::get_origin (  )  const [inline]

Returns the name of the parameter that is defined as the "origin". Used for visual editing.

const String& synfig::ParamDesc::get_connect (  )  const [inline]

Todo:
This needs to be documented further.

const String& synfig::ParamDesc::get_box (  )  const [inline]

Todo:
This needs to be documented further.

const Real& synfig::ParamDesc::get_scalar (  )  const [inline]

Returns the scalar value for the parameter. Used for visual editing.

bool synfig::ParamDesc::get_critical (  )  const [inline]

Returns true if the layer is critical, false otherwise.

bool synfig::ParamDesc::get_hidden (  )  const [inline]

Returns true if the layer is hidden, false otherwise.

ParamDesc& synfig::ParamDesc::set_is_distance ( bool  x = true  )  [inline]

bool synfig::ParamDesc::get_is_distance (  )  const [inline]


The documentation for this class was generated from the following files:

Generated on Fri Jul 31 00:01:59 2009 for synfig-core by  doxygen 1.5.6