mmOptionList Struct Reference

Holds a an option list (a vector of listItems). More...

#include <mmoptionmodel.h>

Inherits mmOptionModel.

Collaboration diagram for mmOptionList:
Collaboration graph
[legend]

Public Types

enum  ControlType { ct_undefined, ct_someothers }

Public Member Functions

 mmOptionList (wxString name_, wxString key_, wxString description_, wxString def_, wxString section_=SLGlobals::nosection_name, wxString style_=SLGlobals::nostyle_name)
 sets members accordingly; listitems,cbx_choices remain empty
 mmOptionList ()
 def, value are set to ""; listitems,cbx_choices remain empty
void addItem (wxString key_, wxString name_, wxString desc_)
 creates a new listitem from params, pushes it on the vector and adds name_ to cbx_choices

Data Fields

wxString def
wxString value
 will always reflect the name of the currently "selected" listitem
int cur_choice_index
 index of current value in cbx_choices, so one can assign new combox value
ListItemVec listitems
 holds a variable amount of ListItems
wxArrayString cbx_choices
 for easy mapping to a combobox
wxString name
wxString key
wxString description
OptionType type
ControlType ct_type
wxString section
wxString ct_type_string
 control style string, as of yet undefined

Detailed Description

Holds a an option list (a vector of listItems).

Most complex of option types. A convenience method for adding new Listitems is provided, as well as a wxArrayString that contains the names of the added Listitems (useful for comboboxes)

Definition at line 126 of file mmoptionmodel.h.


Member Enumeration Documentation

enum mmOptionModel::ControlType [inherited]
Enumerator:
ct_undefined 
ct_someothers 

Definition at line 47 of file mmoptionmodel.h.


Constructor & Destructor Documentation

mmOptionList::mmOptionList ( wxString  name_,
wxString  key_,
wxString  description_,
wxString  def_,
wxString  section_ = SLGlobals::nosection_name,
wxString  style_ = SLGlobals::nostyle_name 
)

sets members accordingly; listitems,cbx_choices remain empty

Definition at line 77 of file mmoptionmodel.cpp.

mmOptionList::mmOptionList (  ) 

def, value are set to ""; listitems,cbx_choices remain empty

Definition at line 85 of file mmoptionmodel.cpp.


Member Function Documentation

void mmOptionList::addItem ( wxString  key_,
wxString  name_,
wxString  desc_ 
)

creates a new listitem from params, pushes it on the vector and adds name_ to cbx_choices

Definition at line 91 of file mmoptionmodel.cpp.


Field Documentation

for easy mapping to a combobox

Definition at line 145 of file mmoptionmodel.h.

Definition at line 66 of file mmoptionmodel.h.

control style string, as of yet undefined

Definition at line 69 of file mmoptionmodel.h.

index of current value in cbx_choices, so one can assign new combox value

Definition at line 141 of file mmoptionmodel.h.

Definition at line 137 of file mmoptionmodel.h.

Definition at line 64 of file mmoptionmodel.h.

Definition at line 64 of file mmoptionmodel.h.

holds a variable amount of ListItems

Definition at line 143 of file mmoptionmodel.h.

Definition at line 64 of file mmoptionmodel.h.

Definition at line 67 of file mmoptionmodel.h.

Definition at line 65 of file mmoptionmodel.h.

will always reflect the name of the currently "selected" listitem

Definition at line 139 of file mmoptionmodel.h.


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

Generated on Thu Dec 29 00:11:47 2011 for SpringLobby by doxygen 1.6.3