VOP_LanguageInfo.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        VOP_LanguageInfo.h (  Library, C++)
 *
 * COMMENTS:
 */

#ifndef __VOP_LanguageInfo__
#define __VOP_LanguageInfo__

#include "VOP_API.h"
#include "VOP_Types.h"
#include <UT/UT_StringHolder.h>


// ============================================================================
/// Class for referencing languages in VOPs.
/// It can be used to obtain the registered VOP_Language definition object.
class VOP_LanguageInfo
{
public:
    /// @{
    /// A constructor and a destructor.
    // NB: explicit keyword is useful during sweeps to convert code from 
    //     VOP_LanguageType to VOP_Languagenfo.
    explicit     VOP_LanguageInfo( VOP_LanguageType type = VOP_LANGUAGE_INVALID,
                        const UT_StringRef &lang_name = UT_StringRef() )
                    : myType(type), myName(lang_name)
                 {
                 }
    /// @}
    
    /// Returns the type enumeration value of the language.
    VOP_LanguageType        getType() const
                                { return myType; }

    /// Returns the language name this info refers to.
    const UT_StringHolder & getName() const
                                { return myName; }

private:
    /// The basic type of a language.
    VOP_LanguageType    myType;

    /// The name of the language, for custom languages.
    /// For hard-coded languages it is an empty string 
    /// (though it could contain the official name too).
    UT_StringHolder     myName;
};

#endif