Struct amfnengine::core::list_column::ListColumn

pub struct ListColumn { /* private fields */ }

Implementations

impl ListColumn

List of columns implementation.

pub fn new() -> ListColumn

Create and return a new list column element.

Return

• See description.

pub fn add_column(
    &mut self,
    col_name_param: &str,
    col_name_index_param: usize,
    col_header_param: &str,
    col_description_param: &str,
    group_param: &str,
    name_param: &str,
    col_type_param: &str,
    code_param: &str,
    format_param: FormatType,
    decimal_digits_param: usize,
    column_width_param: usize,
    column_editable_param: bool
) -> bool

Add a new column into the column list.

Arguments

• col_name_param - Column name.
• col_name_index_param - Column index.
• col_header_param - Column header.
• col_description_param - Column description.
• group_param - Group parameter.
• name_param - Name parameter.
• col_type_param - Column type.
• code_param - Code parameter.
• column_empty_value_param - Column empty value.
• format_param - Column format.
• decimal_digits_param - Decimal digits.
• column_width_param - Column width.
• column_exclude_param - Column exclude.

Return

• True if successful, otherwise false.

pub fn column(&self) -> &ElemColumn

Get the selected column.

Return

• See description.

pub fn col_name(&self) -> &str

Get the name of the column.

Return

• See description.

pub fn col_name_index(&self) -> usize

Index of the column name.

Return

• See description.

pub fn col_header(&self) -> &str

Get the header text of the column.

Return

• See description.

pub fn col_description(&self) -> &str

Get the description of the column.

Return

• See description.

pub fn group(&self) -> &str

Get the group of the descriptor.

Return

• See description.

pub fn name(&self) -> &str

Get the name of the descriptor.

Return

• See description.

pub fn col_type(&self) -> &str

Get the type of the descriptor.

Return

• See description.

pub fn code(&self) -> &str

Get the code of the descriptor.

Return

• See description.

pub fn format(&self) -> FormatType

Get the format of the column.

Return

• See description.

pub fn decimal_digits(&self) -> usize

Get the number of significant decimal digits.

Return

• See description.

pub fn column_width(&self) -> usize

Get the width of the column.

Return

• See description.

pub fn column_editable(&self) -> bool

Get the column editable.

Return

• See description.

pub fn get_element_by_col_name_index(&self, col_name_index: usize) -> bool

Select the column that matches a column name index.

Arguments

• col_name_index - The column name index to select.

Return

• True if successful, otherwise false.

pub fn remove(&mut self) -> bool

Remove the selected column from the column list.

Return

• True if successful, otherwise false.

Trait Implementations

impl Default for ListColumn

List of columns default implementation.

fn default() -> Self

Create and return a new list column element.

Return

• See description.

impl ListTrait for ListColumn

List of columns list implementation.

fn clear(&mut self)

Clear all columns from the column list.

fn count(&self) -> usize

Get the count of the columns.

Return

• See description.

fn index(&self) -> usize

Get the index of the selected column (starting from 0).

Return

• See description.

fn get_element(&self, index_param: usize) -> bool

Select a column based upon an index value.

Arguments

• index_param - The index value of the column to select (starting from 0).

Return

• True if successful, otherwise false.

fn set_index(&self, index_param: usize) -> bool

Set the list index.

Arguments

• index_param - See description.

Return

• True if successful, otherwise false.