The IDictionary resource object interface. More...

#include "murl_resource_i_dictionary.h"

Inheritance diagram for Murl::Resource::IDictionary:

Classes

struct  Iff
 IFF file specific structs. More...
 

Public Member Functions

virtual IObjectGetObjectInterface ()=0
 Get the mutable Resource::IObject interface. More...
 
virtual const IObjectGetObjectInterface () const =0
 Get the constant Resource::IObject interface. More...
 
virtual Bool RegisterGlobally () const =0
 Check if the contained text objects should be registered globally with the containing package. More...
 
virtual UInt32 GetNumberOfTexts () const =0
 Get the number of text objects contained in this resource. More...
 
virtual const ITextGetText (UInt32 index) const =0
 Get the text object at a given index. More...
 
virtual const ITextGetText (const String &id) const =0
 Get the text object with a given id. More...
 

Detailed Description

The IDictionary resource object interface.

A binary resource stores one or more individual text objects.

Member Function Documentation

◆ GetObjectInterface() [1/2]

virtual IObject* Murl::Resource::IDictionary::GetObjectInterface ( )
pure virtual

Get the mutable Resource::IObject interface.

Returns
The IObject interface.

◆ GetObjectInterface() [2/2]

virtual const IObject* Murl::Resource::IDictionary::GetObjectInterface ( ) const
pure virtual

Get the constant Resource::IObject interface.

Returns
The IObject interface.

◆ RegisterGlobally()

virtual Bool Murl::Resource::IDictionary::RegisterGlobally ( ) const
pure virtual

Check if the contained text objects should be registered globally with the containing package.

Returns
true if texts should be accessible from package scope.

◆ GetNumberOfTexts()

virtual UInt32 Murl::Resource::IDictionary::GetNumberOfTexts ( ) const
pure virtual

Get the number of text objects contained in this resource.

Returns
The number of text objects.

◆ GetText() [1/2]

virtual const IText* Murl::Resource::IDictionary::GetText ( UInt32  index) const
pure virtual

Get the text object at a given index.

Parameters
indexThe index in the range from 0 to GetNumberOfTexts()-1.
Returns
The text object, or null if index is out of range.

◆ GetText() [2/2]

virtual const IText* Murl::Resource::IDictionary::GetText ( const String id) const
pure virtual

Get the text object with a given id.

Parameters
idThe text ID to search for.
Returns
The text object, or null if the given ID was not found.

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


Copyright © 2011-2018 Spraylight GmbH.