Jamba C++ API  5.1.1
Public Member Functions | List of all members
UTF8StringParamSerializer< size > Class Template Reference

A parameter backed by a UTF8String. More...

#include <GUIParamSerializers.h>

Inherits IParamSerializer< UTF8String >.

Public Member Functions

tresult readFromStream (IBStreamer &iStreamer, ParamType &oValue) const override
 This method should read from the stream and populate oValue accordingly (aka deserialization) More...
 
tresult writeToStream (const ParamType &iValue, IBStreamer &oStreamer) const override
 This method should write iValue to the stream (aka serialization) More...
 
void writeToStream (ParamType const &iValue, std::ostream &oStream) const override
 By default, this implementation simply writes the value to the stream IF it is possible (determined at compilation time). More...
 
- Public Member Functions inherited from IParamSerializer< UTF8String >
virtual std::string toString (ParamType const &iValue, int32 iPrecision) const
 

Additional Inherited Members

- Public Types inherited from IParamSerializer< UTF8String >
using ParamType = UTF8String
 

Detailed Description

template<int size = 128>
class pongasoft::VST::GUI::Params::UTF8StringParamSerializer< size >

A parameter backed by a UTF8String.

Template Parameters
sizemax size of the string saved/restored

Member Function Documentation

◆ readFromStream()

tresult readFromStream ( IBStreamer &  iStreamer,
ParamType &  oValue 
) const
inlineoverridevirtual

This method should read from the stream and populate oValue accordingly (aka deserialization)

Returns
kResultOk if reading was successful, kResultFalse otherwise (or kNotImplemented if not supported)

Reimplemented from IParamSerializer< UTF8String >.

◆ writeToStream() [1/2]

tresult writeToStream ( const ParamType &  iValue,
IBStreamer &  oStreamer 
) const
inlineoverridevirtual

This method should write iValue to the stream (aka serialization)

Returns
kResultOk if writing was successful, kResultFalse otherwise (or kNotImplemented if not supported)

Reimplemented from IParamSerializer< UTF8String >.

◆ writeToStream() [2/2]

void writeToStream ( ParamType const &  iValue,
std::ostream &  oStream 
) const
inlineoverridevirtual

By default, this implementation simply writes the value to the stream IF it is possible (determined at compilation time).

Doesn't do anything if not. Subclasses can redefine this behavior.

Reimplemented from IParamSerializer< UTF8String >.

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