soui 5.0.0.1
Soui5 Doc
 
Loading...
Searching...
No Matches
SNamedDimension Class Reference

Manages named dimensions. More...

#include <SNamedValue.h>

Inheritance diagram for SNamedDimension:
SNamedValue< SLayoutSize, SDimensionParser >

Public Member Functions

BOOL Get (const SStringW &strValue, SLayoutSize &ret) const
 Retrieves a dimension value by name, automatically converting named dimensions.
 
SLayoutSize Get (int idx) const
 Retrieves a dimension value by index.
 
- Public Member Functions inherited from SNamedValue< SLayoutSize, SDimensionParser >
virtual BOOL Init (SXmlNode xmlNode)
 Initializes the named values from an XML node.
 
SLayoutSize String2Value (const SStringW &strName) const
 Converts a string name to its corresponding value.
 
BOOL FindValue (const SStringW &strName, SLayoutSize &value) const
 Finds the value associated with a given name.
 
SLayoutSize GetAt (const int idx) const
 Retrieves the value at a specific index.
 
size_t Merge (const SNamedValue &src)
 Merges the named values from another SNamedValue object.
 
UINT GetCount () const
 Retrieves the number of named values.
 

Additional Inherited Members

- Public Types inherited from SNamedValue< SLayoutSize, SDimensionParser >
typedef TNAMEDVALUE< SLayoutSizeNAMEDVALUE
 
- Static Protected Member Functions inherited from SNamedValue< SLayoutSize, SDimensionParser >
static int Compare (const void *p1, const void *p2)
 Comparison function for sorting and searching.
 
- Protected Attributes inherited from SNamedValue< SLayoutSize, SDimensionParser >
SArray< NAMEDVALUEm_lstNamedValue
 

Detailed Description

Manages named dimensions.

Definition at line 354 of file SNamedValue.h.

Member Function Documentation

◆ Get() [1/2]

BOOL SNamedDimension::Get ( const SStringW & strValue,
SLayoutSize & ret ) const

Retrieves a dimension value by name, automatically converting named dimensions.

Parameters
strValueName of the dimension.
retVariable to store the retrieved dimension value.
Returns
TRUE if the dimension is found, FALSE otherwise.

Definition at line 148 of file SNamedValue.cpp.

◆ Get() [2/2]

SLayoutSize SNamedDimension::Get ( int idx) const
inline

Retrieves a dimension value by index.

Parameters
idxIndex of the dimension.
Returns
Dimension value at the specified index.

Definition at line 369 of file SNamedValue.h.


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