SCR_UIName.c

Go to the documentation of this file.

[BaseContainerProps(), SCR_BaseContainerLocalizedTitleField("Name")]
class SCR_UIName
{
    [Attribute(uiwidget: UIWidgets.LocaleEditBox)]
    protected LocalizedString Name;
    
    //------------------------------------------------------------------------------------------------
    LocalizedString GetUnformattedName()
    {
        return Name;
    }
    
    //------------------------------------------------------------------------------------------------
    void SetName(LocalizedString name)
    {
        Name = name;
    }
    
    //------------------------------------------------------------------------------------------------
    LocalizedString GetName()
    {
        return Name;
    }
 
    //------------------------------------------------------------------------------------------------
    bool HasName()
    {
        return !GetName().IsEmpty();
    }
 
//---- REFACTOR NOTE START: This code will need to be refactored as current implementation is not conforming to the standards ----  
// This class is meant to hold data, not manipulate widgets! Such methods should be in SCR_WidgetTools or SCR_WidgetHelper. In this case, I would expect whatever component is handling the layout to make sure the text widget exists, so this method is not needed
    
    //------------------------------------------------------------------------------------------------
    bool SetNameTo(TextWidget textWidget)
    {
        if (!textWidget)
            return false;
        
        textWidget.SetText(GetName());
        return true;
    }
 
//---- REFACTOR NOTE END ----
    
    //------------------------------------------------------------------------------------------------
    void Log(string prefix = string.Empty, LogLevel logLevel = LogLevel.VERBOSE)
    {
        Print(string.Format(prefix + "%1: \"%2\"", Type(), Name), logLevel);
    }
    
    //--- Protected, to be overridden and/or made public by inherited classes
    protected void CopyFrom(SCR_UIName source)
    {
        if (source)
            Name = source.Name;
    }
}