SCR_UIDescription.c

Go to the documentation of this file.

[BaseContainerProps(), SCR_BaseContainerLocalizedTitleField("Name")]
class SCR_UIDescription : SCR_UIName
{
    [Attribute(uiwidget: UIWidgets.EditBoxMultiline)]
    protected LocalizedString Description;
    
    //------------------------------------------------------------------------------------------------
    LocalizedString GetUnformattedDescription()
    {
        return Description;
    }
    
    //------------------------------------------------------------------------------------------------
    void SetDescription(LocalizedString description)
    {
        Description = description;
    }
    
    //------------------------------------------------------------------------------------------------
    LocalizedString GetDescription()
    {
        return Description;
    }
    
    //------------------------------------------------------------------------------------------------
    bool HasDescription()
    {
        return !GetDescription().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 SetDescriptionTo(TextWidget textWidget)
    {
        if (!textWidget)
            return false;
        
        textWidget.SetText(GetDescription());
        return true;
    }
    
//---- REFACTOR NOTE END ----
    
    //------------------------------------------------------------------------------------------------
    override void Log(string prefix = string.Empty, LogLevel logLevel = LogLevel.VERBOSE)
    {
        Print(string.Format(prefix + "%1: \"%2\", \"%3\"", Type(), Name, Description), logLevel);
    }
    
    //------------------------------------------------------------------------------------------------
    //--- Protected, to be overridden and/or made public by inherited classes
    override protected void CopyFrom(SCR_UIName source)
    {
        SCR_UIDescription sourceDescription = SCR_UIDescription.Cast(source);
        if (sourceDescription)
        {
            Description = sourceDescription.Description;
        }
        
        super.CopyFrom(source);
    }
}