Panda3D
 All Classes Functions Variables Enumerations
configVariableString.h
00001 // Filename: configVariableString.h
00002 // Created by:  drose (20Oct04)
00003 //
00004 ////////////////////////////////////////////////////////////////////
00005 //
00006 // PANDA 3D SOFTWARE
00007 // Copyright (c) Carnegie Mellon University.  All rights reserved.
00008 //
00009 // All use of this software is subject to the terms of the revised BSD
00010 // license.  You should have received a copy of this license along
00011 // with this source code in a file named "LICENSE."
00012 //
00013 ////////////////////////////////////////////////////////////////////
00014 
00015 #ifndef CONFIGVARIABLESTRING_H
00016 #define CONFIGVARIABLESTRING_H
00017 
00018 #include "dtoolbase.h"
00019 #include "configVariable.h"
00020 
00021 ////////////////////////////////////////////////////////////////////
00022 //       Class : ConfigVariableString
00023 // Description : This is a convenience class to specialize
00024 //               ConfigVariable as a string type.
00025 ////////////////////////////////////////////////////////////////////
00026 class EXPCL_DTOOLCONFIG ConfigVariableString : public ConfigVariable {
00027 PUBLISHED:
00028   INLINE ConfigVariableString(const string &name);
00029   INLINE ConfigVariableString(const string &name, const string &default_value,
00030                               const string &description = string(), int flags = 0);
00031 
00032   INLINE void operator = (const string &value);
00033   INLINE operator const string & () const;
00034 
00035   // These methods help the ConfigVariableString act like a C++ string
00036   // object.
00037   INLINE const char *c_str() const;
00038   INLINE bool empty() const;
00039   INLINE size_t length() const;
00040   INLINE char operator [] (int n) const;
00041 
00042   // Comparison operators are handy.
00043   INLINE bool operator == (const string &other) const;
00044   INLINE bool operator != (const string &other) const;
00045   INLINE bool operator < (const string &other) const;
00046 
00047   INLINE void set_value(const string &value);
00048   INLINE const string &get_value() const;
00049   INLINE string get_default_value() const;
00050 
00051   INLINE string get_word(int n) const;
00052   INLINE void set_word(int n, const string &value);
00053 
00054 private:
00055   AtomicAdjust::Integer _local_modified;
00056   string _cache;
00057 };
00058 
00059 #include "configVariableString.I"
00060 
00061 #endif
 All Classes Functions Variables Enumerations