GL Studio C++ Runtime API
GlsPropString Class Reference

#include <util.h>

Public Member Functions

 GlsPropString ()
 
 GlsPropString (const std::string &str)
 
 GlsPropString (const char *str)
 
std::string & String ()
 

Friends

bool operator== (const GlsPropString &str1, const GlsPropString &str2)
 
bool operator!= (const GlsPropString &str1, const GlsPropString &str2)
 

Detailed Description

GlsPropString is designed to be used as a string in GL Studio Class Properties. It writes itself out as a single line, and will read in up to the next newline. It will attempt to convert itself to and from std::strings. If it is used in a GlsMultiVal, there must be only one, and it must be the last entry in the GlsMultiVal instance. See GlsPropStringQuoted for more usefulness in GlsMultiVal.

Constructor & Destructor Documentation

GlsPropString ( )
inline

Default constructor Creates an empty GlsPropString.

GlsPropString ( const std::string &  str)
inline

Create a new GlsPropString using the provided std string.

Parameters
strstd::string to use to create the GlsPropString
Returns
GlsPropString ( const char *  str)
inline

Create a new GlsPropString using the provided c-style string.

Parameters
strc-style string to use to create the GlsPropString.
Returns

Member Function Documentation

std::string& String ( )
inline

Get the string value for this object.

Returns
std::string containing the string value for this object.

Friends And Related Function Documentation

bool operator!= ( const GlsPropString str1,
const GlsPropString str2 
)
friend

Checks lexicographic inequality of the two arguments

bool operator== ( const GlsPropString str1,
const GlsPropString str2 
)
friend

Checks lexicographic equality of the two arguments


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