Baby Language Lab Scripts
A collection of data processing tools.
 All Classes Namespaces Files Functions Variables Pages
data_structs.combo_option.ComboOption Class Reference

This class represents a single entry in a UI combo box. More...

Inheritance diagram for data_structs.combo_option.ComboOption:

Public Member Functions

def __init__
 Constructor. More...
 
- Public Member Functions inherited from data_structs.base_objects.BLLObject
def __str__
 Builds a nicely formatted string containing all attributes of this object (except those in omit_attr_names), for debugging purposes. More...
 

Public Attributes

 db_id
 
 code_name
 
 group_id
 
 disp_desc
 
 hidden
 

Detailed Description

This class represents a single entry in a UI combo box.

This class is instantiated automatically by machinery in utils/ui_utils; it should never need to be directly instantiated by other code. See UIUtils.COMBOS if you need to access combo box data. Note: Although it is tied to the database, this object is not a subclass of DBObject because DBObjects can be inserted and removed via Python code, and that is not the intention for this ComboOptions (they should be added or deleted only by SQL update scripts).

Definition at line 7 of file combo_option.py.

Constructor & Destructor Documentation

def data_structs.combo_option.ComboOption.__init__ (   self,
  db_id,
  code_name,
  group_id,
  disp_desc,
  hidden 
)

Constructor.

Parameters
self
db_id(int) corresponding id from the combo_options DB table
code_name(string) value corresponding to the code_name column in the combo_options DB table
group_id(int) value corresponding to the group_id column in combo_options DB table. All options belong to a group (from the combo_groups DB table), and each groups corresponds to a single combo box in the UI.
disp_desc(string) value from the corresponding value from the combo_options DB table - this is the text the user sees for the combobox option
hidden(boolean integer) value from the corresponding column in combo_options DB table - if 0, this option is not shown in the UI. If 1, it is shown.

Definition at line 15 of file combo_option.py.

Member Data Documentation

data_structs.combo_option.ComboOption.code_name

Definition at line 17 of file combo_option.py.

data_structs.combo_option.ComboOption.db_id

Definition at line 16 of file combo_option.py.

data_structs.combo_option.ComboOption.disp_desc

Definition at line 19 of file combo_option.py.

data_structs.combo_option.ComboOption.group_id

Definition at line 18 of file combo_option.py.

data_structs.combo_option.ComboOption.hidden

Definition at line 20 of file combo_option.py.


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