LocationComboBox Class Reference

Combo box to display locations. More...

#include <casecombobox.h>

List of all members.

Public Member Functions

 LocationComboBox (const LocationMap &locations)
 Constructor.
bool empty () const
 See if the combo box is empty.
void set_active_internal (const Glib::ustring &id)
 Set the active location by internal name.
Glib::ustring get_selected_name () const
 Get the selected location's name.
Glib::ustring get_selected_internal ()
 Get the selected locations's internal name.
Case::Locationget_selected_location ()
 Get the selected location.

Protected Member Functions

Glib::ustring is_court_location (const Glib::ustring &str)
 Check if a location is a court location.
Glib::ustring internal_is_court_location (const Glib::ustring &str)
 Check if a location is a court location by internal ID.

Protected Attributes

LocationMap m_Locations
 Internal map of locations.


Detailed Description

Combo box to display locations.

Constructor & Destructor Documentation

LocationComboBox::LocationComboBox ( const LocationMap &  locations  ) 

Constructor.

Parameters:
locations Map of locations to display


Member Function Documentation

bool LocationComboBox::empty (  )  const [inline]

See if the combo box is empty.

Returns:
true if empty, false otherwise

void LocationComboBox::set_active_internal ( const Glib::ustring &  id  ) 

Set the active location by internal name.

Parameters:
id The internal ID

Glib::ustring LocationComboBox::get_selected_name (  )  const

Get the selected location's name.

Returns:
The selected location's display name

Glib::ustring LocationComboBox::get_selected_internal (  ) 

Get the selected locations's internal name.

Returns:
The internal name

Case::Location * LocationComboBox::get_selected_location (  ) 

Get the selected location.

Returns:
Pointer to selected Case::Location object

Glib::ustring LocationComboBox::is_court_location ( const Glib::ustring &  str  )  [protected]

Check if a location is a court location.

Parameters:
str The display name of the location to test
Returns:
"null" if not a court location, internal ID of court location otherwise

Glib::ustring LocationComboBox::internal_is_court_location ( const Glib::ustring &  str  )  [protected]

Check if a location is a court location by internal ID.

Parameters:
str The internal ID of the location to test
Returns:
"null" if not a court location, display name of court location otherwise


The documentation for this class was generated from the following files:
Generated on Fri Feb 22 22:34:18 2008 for Phoenix Wright Case Editor API by  doxygen 1.5.3