Plasma Engine  2.0
Loading...
Searching...
No Matches
plDynamicBitflags Class Reference

Stores the valid values and names for 'dynamic' bitflags. More...

#include <DynamicBitflags.h>

Public Member Functions

const plMap< plUInt64, plString > & GetAllValidValues () const
 Returns all bitflag values and current names.
 
void Clear ()
 Resets stored values.
 
void SetValueAndName (plUInt32 uiBitPos, plStringView sName)
 Sets the name for the given bit position.
 
void RemoveValue (plUInt32 uiBitPos)
 Removes a value, if it exists.
 
bool IsValueValid (plUInt32 uiBitPos) const
 Returns whether a certain value is known.
 
bool TryGetValueName (plUInt32 uiBitPos, plStringView &out_sName) const
 Returns the name for the given value.
 

Static Public Member Functions

static plDynamicBitflagsGetDynamicBitflags (plStringView sName)
 Returns a plDynamicBitflags under the given name. Creates a new one, if the name has not been used before.
 

Detailed Description

Stores the valid values and names for 'dynamic' bitflags.

The names and valid values for dynamic bitflags may change due to user configuration changes. The UI should show these user specified names without restarting the tool.

Call the static function GetDynamicBitflags() to create or get the plDynamicBitflags for a specific type.


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