Struct amfnengine::engine::elem_preferences::ElemPreferences

pub struct ElemPreferences { /* fields omitted */ }

Implementations

impl ElemPreferences

Preferences definition implementation.

pub fn new(
    calc_manager_param: &Rc<RefCell<CalcManager>>,
    locale_str_param: &str,
    cross_rate_code_param: &str,
    default_encoding_param: &str,
    group_param: &str,
    fiscal_year_start_param: usize,
    decimal_digits_param: usize,
    combine_principal_param: i32,
    compress_descriptor_param: i32,
    statistic_events_param: i32,
    list_parameter_param: Option<&ListParameter>,
    list_descriptor_param: Option<&ListDescriptor>,
    copy_propagate_param: bool,
    updating_json: bool
) -> ElemPreferences

Create and return a new preferences element.

Arguments

• calc_manager_param - Calculator manager element.
• locale_str_param - Locale string.
• cross_rate_code_param - Cross rate code.
• default_encoding_param - Default encoding.
• group_param - Group name.
• fiscal_year_start_param - Fiscal year start.
• decimal_digits_param - Decimal digits.
• combine_principal_param - Combine principal.
• compress_descriptor_param - Compress descriptors.
• statistic_events_param - Statistic events.
• list_parameter_param - List parameter.
• list_descriptor_param - List descriptor.
• copy_propagate_param - Copy propogate.
• elem_level_param - Element level
• updating_json - Updating from Json.

Return

• See description.

pub fn clear(&mut self)

Clear all values and lists.

pub fn copy(&self, updating_json: bool) -> ElemPreferences

Copy this preferences element and return a new preferences element.

Arguments

• updating_json - Updating from Json.

Return

• See description.

pub fn copy_with_calc_manager(
    &self,
    calc_manager: &Rc<RefCell<CalcManager>>,
    updating_json: bool
) -> ElemPreferences

Copy this preferences element and return a new preferences element.

Arguments

• calc_manager - Calculator manager element.
• elem_level_param - Element level
• updating_json - Updating from Json.

Return

• See description.

pub fn locale_str(&self) -> &str

Get the locale.

Return

• ISO language code (ISO 639)_ISO country code (ISO 3166).

pub fn cross_rate_code(&self) -> &str

Get the cross rate international currency code (e.g., USD, GBP, JPY, AUD, EUR, other currency code).

Return

• See description.

pub fn default_encoding(&self) -> &str

Get the default encoding (us-ascii, iso-8859-1, utf-8, utf-16be, utf-16le, utf-16, other encoding).

Return

• See description.

pub fn group(&self) -> &str

Get the template group name.

Return

• See description.

pub fn fiscal_year_start(&self) -> usize

Get the start of fiscal year in MMDD format.

Return

• See description.

pub fn decimal_digits(&self) -> usize

Get the number of significant decimal digits.

Return

• See description.

pub fn combine_principal(&self) -> i32

Get the combine principal change events that are identical except their values and ListDescriptor objects (1=set,0=reset,-1=not set).

Return

• See description.

pub fn compress_descriptor(&self) -> i32

Get the after balancing and during compression, merge ListDescriptor objects (1=set,0=reset,-1=not set).

Return

• See description.

pub fn statistic_events(&self) -> i32

Get the eliminate statistic events from the compressed event list (1=set,0=reset,-1=not set).

Return

• See description.

pub fn list_parameter(&self) -> &ListParameter

Get the parameter list.

Return

• See description.

pub fn list_parameter_mut(&mut self) -> &mut ListParameter

Get the mut parameter list.

Return

• See description.

pub fn list_descriptor(&self) -> &ListDescriptor

Get the descriptor list.

Return

• See description.

pub fn list_descriptor_mut(&mut self) -> &mut ListDescriptor

Get the mut descriptor list.

Return

• See description.

pub fn set_locale_str(&mut self, locale_str_param: &str)

Set the locale name.

Arguments

• locale_str_param - See description.

pub fn set_cross_rate_code(&mut self, cross_rate_code_param: &str)

Set the cross rate international currency code (e.g., USD, GBP, JPY, AUD, EUR, other currency code).

Arguments

• cross_rate_code_param - See description.

pub fn set_default_encoding(&mut self, default_encoding_param: &str)

Set the default encoding (us-ascii, iso-8859-1, utf-8, utf-16be, utf-16le, utf-16, other encoding).

Arguments

• default_encoding_param - See description.

pub fn set_group(&mut self, group_param: &str)

Set the template group name.

Arguments

• group_param - See description.

pub fn set_group_result(&mut self, group_param: &str)

Set the template group name result.

Arguments

• group_param - See description.

pub fn set_fiscal_year_start(
    &self,
    fiscal_year_start_param: usize,
    cashflow_level: bool
)

Set the start of fiscal year in MMDD format.

Arguments

• fiscal_year_start_param - See description.
• cashflow_level - Cashflow level.

pub fn set_decimal_digits(
    &self,
    decimal_digits_param: usize,
    cashflow_level: bool
)

Set the number of significant decimal digits.

Arguments

• decimal_digits_param - See description.
• cashflow_level - Cashflow level.

pub fn set_combine_principal(&mut self, combine_principal_param: i32)

Set the combine principal change events that are identical except their values and ListDescriptor objects (1=set,0=reset,-1=not set).

Arguments

• combine_principal_param - See description.

pub fn set_compress_descriptor(&mut self, compress_descriptor_param: i32)

Set the After balancing and during compression, merge ListDescriptor objects (1=set,0=reset,-1=not set).

Arguments

• compress_descriptor_param - See description.

pub fn set_statistic_events(&mut self, statistic_events_param: i32)

Set the Eliminate statistic events from the compressed event list (1=set,0=reset,-1=not set).

Arguments

• statistic_events_param - See description.