The base interface for a text resource. More...

#include "murl_resource_i_text.h"

Inheritance diagram for Murl::Resource::IText:

Public Member Functions

virtual const StringGetId () const =0
 Get the ID of the text resource. More...
 
virtual const StringGetValue () const =0
 Get the string value of the text resource. More...
 
virtual Bool SetMetaData (const IMetaData *metaData)=0
 Set optional meta data for this object. More...
 
virtual const IMetaDataGetMetaData () const =0
 Get the optional meta data held by this object. More...
 
virtual Bool SetTags (const StringArray &tags)=0
 Set optional resource tags for this object. More...
 
virtual const StringArrayGetTags () const =0
 Get the optional resource tags held by this object. More...
 

Detailed Description

The base interface for a text resource.

Member Function Documentation

◆ GetId()

virtual const String& Murl::Resource::IText::GetId ( ) const
pure virtual

Get the ID of the text resource.

Returns
The text ID.

◆ GetValue()

virtual const String& Murl::Resource::IText::GetValue ( ) const
pure virtual

Get the string value of the text resource.

Returns
The string value.

◆ SetMetaData()

virtual Bool Murl::Resource::IText::SetMetaData ( const IMetaData metaData)
pure virtual

Set optional meta data for this object.

If set, the object takes ownership of the meta data. The meta data object is automatically deleted when the object is destroyed, or a different meta data object is set.

Parameters
metaDataThe meta data, or null for removing.
Returns
true if successful.

◆ GetMetaData()

virtual const IMetaData* Murl::Resource::IText::GetMetaData ( ) const
pure virtual

Get the optional meta data held by this object.

Returns
The meta data, or null if not present.

◆ SetTags()

virtual Bool Murl::Resource::IText::SetTags ( const StringArray tags)
pure virtual

Set optional resource tags for this object.

Parameters
tagsThe resource tags.
Returns
true if successful.

◆ GetTags()

virtual const StringArray& Murl::Resource::IText::GetTags ( ) const
pure virtual

Get the optional resource tags held by this object.

Returns
The resource tags.

The documentation for this interface was generated from the following file:
  • murl_resource_i_text.h


Copyright © 2011-2023 Spraylight GmbH.