wxPackageCommandOptionArray Class Reference

A list of options for one or more wxPackageCommand(s). More...

#include <packageopt.h>

List of all members.

Public Member Functions

 wxPackageCommandOptionArray ()
 Default constructor does nothing.
 wxPackageCommandOptionArray (const wxPackageCommandOptionArray &arr)
wxPackageCommandOptionArrayoperator= (const wxPackageCommandOptionArray &arr)
 WX_DECLARE_STD_OBJARRAY_HELPERS (wxPackageCommandOption, wxEmptyPackageCommandOption)
int IndexByGroup (const wxString &grpname) const
 Returns the index of the first option with the given group name or wxNOT_FOUND.
bool Add (const wxPackageCommandOption &opt, size_t copies=1)
void ResetToDefaults ()
 Resets all options to their default values.
bool UpdateOption (const wxPackageCommandOption &opt)
bool Contains (const wxPackageCommandOptionArray &arr) const
 Returns true if the given array is a subset (or coincides) with this array.
bool Remove (const wxPackageCommandOptionArray &arr)
wxPackageCommandOption & ItemByGroup (const wxString &grpname)
wxArrayString GetAllOptionGroups () const
 Returns the groups of all options.
wxArrayString GetOptionGroups (long stages=wxGetFullPackageBuildSystemStageList()) const
wxPackageCommandOptionArray GetChangedOptions () const
 Returns only the options with values != their default values.
wxString GetAsList () const
 Returns all options separed by a single space in the form optionname=optionvalue.
wxString GetDescription () const
 Returns the description for this array of options, if any.
wxPackageCondition GetCommonCondition () const
 Returns the conditions common to all options of this array.
void SetDescription (const wxString &str)
wxStringHashMap GetSubstitutionOptionsHashMap (long flags, const wxPackageCondition &cond=wxEmptyPackageCondition) const
wxString SubstituteOptions (const wxString &str, long flags, const wxPackageCondition &cond=wxEmptyPackageCondition) const
 Does a chain of SubstituteOptions and SubstituteStandard.
void SetDirty (bool d=true)
bool IsDirty () const

Protected Member Functions

wxStringHashMap GetGroupNamesHashMap (long flags, const wxPackageCondition &cond) const
wxStringHashMap GetTypeNamesHashMap (long flags, const wxPackageCondition &cond) const

Protected Attributes

bool m_bDirty
wxString m_strDesc


Detailed Description

A list of options for one or more wxPackageCommand(s).

Definition at line 209 of file packageopt.h.


Member Function Documentation

bool wxPackageCommandOptionArray::UpdateOption ( const wxPackageCommandOption &  opt  ) 

Finds an option with the same name of the given option and then replaces it with the given instance. Returns false if no matching options are found in this array.

Definition at line 302 of file packageopt.cpp.

Referenced by wxPackagePropertiesPanel::OnOptionDClick().

bool wxPackageCommandOptionArray::Remove ( const wxPackageCommandOptionArray arr  ) 

Removes all options of the given array from this array (if found). Returns true if all options have been found and removed, false otherwise.

Definition at line 332 of file packageopt.cpp.

Referenced by wxPackageXMLDescriptor::SetPackageInfo().

wxArrayString wxPackageCommandOptionArray::GetOptionGroups ( long  stages = wxGetFullPackageBuildSystemStageList()  )  const

Returns all the possible groups for the options associated with the given (set of) wxPackageBuildSystemStage.

Definition at line 274 of file packageopt.cpp.

wxStringHashMap wxPackageCommandOptionArray::GetSubstitutionOptionsHashMap ( long  flags,
const wxPackageCondition cond = wxEmptyPackageCondition 
) const

Returns the hashmap for the substitution of the keywords with the relative option values.

Definition at line 182 of file packageopt.cpp.

References GetGroupNamesHashMap(), and GetTypeNamesHashMap().

Referenced by wxPackageInfo::GetCmd(), and SubstituteOptions().


The documentation for this class was generated from the following files:
Generated on Thu Feb 1 22:14:32 2007 for wxWidgets Package Manager by  doxygen 1.5.1-p1