Panda3D
|
This is a convenience class to specialize ConfigVariable as a Filename type. More...
Public Member Functions | |
__init__ (const ConfigVariableFilename) | |
__init__ (str name) | |
__init__ (str name, const Filename default_value, str description, int flags) | |
str | cStr () |
bool | empty () |
str | getBasename () |
Returns the basename part of the filename. More... | |
str | getBasenameWoExtension () |
Returns the basename part of the filename, without the file extension. More... | |
Filename | getDefaultValue () |
Returns the variable's default value. More... | |
str | getDirname () |
Returns the directory part of the filename. More... | |
str | getExtension () |
Returns the file extension. More... | |
str | getFullpath () |
Returns the entire filename: directory, basename, extension. More... | |
str | getFullpathWoExtension () |
Returns the full filename–directory and basename parts–except for the extension. More... | |
Filename | getValue () |
Returns the variable's value. More... | |
Filename | getWord (int n) |
Returns the variable's nth value. More... | |
int | length () |
bool | operator!= (const Filename other) |
bool | operator< (const Filename other) |
ConfigVariableFilename | operator= (const Filename value) |
bool | operator== (const Filename other) |
char | operator[] (int n) |
setValue (const Filename value) | |
Reassigns the variable's local value. More... | |
setWord (int n, const Filename value) | |
Reassigns the variable's nth value. More... | |
![]() | |
__init__ (const ConfigVariable) | |
__init__ (str name) | |
Use this constructor to make a ConfigVariable of an unspecified type. More... | |
clearValue () | |
Removes the value assigned to this variable, and lets its original value (as read from the prc files) show through. More... | |
int | getNumWords () |
Returns the number of words in the variable's value. More... | |
str | getStringValue () |
Returns the toplevel value of the variable, formatted as a string. More... | |
setStringValue (str value) | |
Changes the value assigned to this variable. More... | |
![]() | |
bool | clearLocalValue () |
Removes the local value defined for this variable, and allows its value to be once again retrieved from the .prc files. More... | |
str | getDescription () |
Returns the brief description of this variable, if it has been defined. More... | |
int | getFlags () |
Returns the flags value as set by set_flags(). More... | |
str | getName () |
Returns the name of the variable. More... | |
int | getTrustLevel () |
Returns the minimum trust_level a prc file must demonstrate in order to redefine the value for this variable. More... | |
ConfigFlags::ValueType | getValueType () |
Returns the stated type of this variable. More... | |
bool | hasLocalValue () |
Returns true if this variable's value has been shadowed by a local assignment (as created via make_local_value()), or false otherwise. More... | |
bool | hasValue () |
Returns true if this variable has an explicit value, either from a prc file or locally set, or false if variable has its default value. More... | |
bool | isClosed () |
Returns true if the variable is not trusted by any prc file (and hence cannot be modified from its compiled-in default value), or false for the normal case, in which the variable can be modified by any prc file at or above its trust level (see get_trust_level()). More... | |
bool | isDynamic () |
Returns true if the variable was indicated as "dynamic" by its constructor, indicating that its name was dynamically generated, possibly from a large pool, and it should not be listed along with the other variables. More... | |
output (Ostream out) | |
write (Ostream out) | |
![]() | |
__init__ () | |
__init__ (const ConfigFlags) | |
Public Attributes | |
Filename | default_value |
Returns the variable's default value. More... | |
Filename | value |
Returns the variable's value. More... | |
![]() | |
bool | closed |
Returns true if the variable is not trusted by any prc file (and hence cannot be modified from its compiled-in default value), or false for the normal case, in which the variable can be modified by any prc file at or above its trust level (see get_trust_level()). More... | |
const String | description |
Returns the brief description of this variable, if it has been defined. More... | |
bool | dynamic |
Returns true if the variable was indicated as "dynamic" by its constructor, indicating that its name was dynamically generated, possibly from a large pool, and it should not be listed along with the other variables. More... | |
const String | name |
Returns the name of the variable. More... | |
int | trust_level |
Returns the minimum trust_level a prc file must demonstrate in order to redefine the value for this variable. More... | |
ConfigFlags::ValueType | value_type |
Returns the stated type of this variable. More... | |
Additional Inherited Members | |
![]() | |
enum | ValueType { VT_undefined = 0, VT_list = 1, VT_string = 2, VT_filename = 3, VT_bool = 4, VT_int = 5, VT_double = 6, VT_enum = 7, VT_search_path = 8, VT_int64 = 9, VT_color = 10 } |
enum | VariableFlags { F_trust_level_mask = 4095, F_open = 4096, F_closed = 8192, F_dynamic = 16384, F_dconfig = 32768 } |
This is a convenience class to specialize ConfigVariable as a Filename type.
It is almost the same thing as ConfigVariableString, except it handles an implicit Filename::expand_from() operation so that the user may put OS-specific filenames, or filenames based on environment variables, in the prc file.
__init__ | ( | const | ConfigVariableFilename | ) |
__init__ | ( | str | name | ) |
__init__ | ( | str | name, |
const Filename | default_value, | ||
str | description, | ||
int | flags | ||
) |
str cStr | ( | ) |
bool empty | ( | ) |
str getBasename | ( | ) |
Returns the basename part of the filename.
This is everything in the filename after the rightmost slash, including any extensions.
str getBasenameWoExtension | ( | ) |
Returns the basename part of the filename, without the file extension.
Filename getDefaultValue | ( | ) |
Returns the variable's default value.
str getDirname | ( | ) |
Returns the directory part of the filename.
This is everything in the filename up to, but not including the rightmost slash.
str getExtension | ( | ) |
Returns the file extension.
This is everything after the rightmost dot, if there is one, or the empty string if there is not.
str getFullpath | ( | ) |
Returns the entire filename: directory, basename, extension.
This is the same thing returned by the string typecast operator, so this function is a little redundant.
str getFullpathWoExtension | ( | ) |
Returns the full filename–directory and basename parts–except for the extension.
Filename getValue | ( | ) |
Returns the variable's value.
Filename getWord | ( | int | n | ) |
Returns the variable's nth value.
int length | ( | ) |
bool operator!= | ( | const Filename | other | ) |
bool operator< | ( | const Filename | other | ) |
ConfigVariableFilename operator= | ( | const Filename | value | ) |
bool operator== | ( | const Filename | other | ) |
char operator[] | ( | int | n | ) |
setValue | ( | const Filename | value | ) |
Reassigns the variable's local value.
setWord | ( | int | n, |
const Filename | value | ||
) |
Reassigns the variable's nth value.
This makes a local copy of the variable's overall value.
Filename default_value |
Returns the variable's default value.
Filename value |
Returns the variable's value.