C4ScriptGuiWindowProperty Class Reference

#include <C4ScriptGuiWindow.h>

Public Member Functions
	~C4ScriptGuiWindowProperty ()
	C4ScriptGuiWindowProperty ()=default
void	Set (const C4Value &value, C4String *tag)
int32_t	GetInt ()
float	GetFloat ()
C4Object *	GetObject ()
C4Def *	GetDef ()
C4GUI::FrameDecoration *	GetFrameDecoration ()
StdCopyStrBuf *	GetStrBuf ()
C4ScriptGuiWindowAction *	GetAction ()
std::list< C4ScriptGuiWindowAction * >	GetAllActions ()
bool	SwitchTag (C4String *tag)
C4String *	GetCurrentTag ()
const C4Value	ToC4Value ()
void	ClearPointers (C4Object *pObj)

Friends
class	C4ScriptGuiWindow

Detailed Description

Definition at line 124 of file C4ScriptGuiWindow.h.

Constructor & Destructor Documentation

~C4ScriptGuiWindowProperty()

C4ScriptGuiWindowProperty::~C4ScriptGuiWindowProperty

(

)

Definition at line 285 of file C4ScriptGuiWindow.cpp.

{
    // is cleaned up from destructor of C4ScriptGuiWindow
}

C4ScriptGuiWindowProperty()

C4ScriptGuiWindowProperty::C4ScriptGuiWindowProperty ( )

default

Member Function Documentation

ClearPointers()

void C4ScriptGuiWindowProperty::ClearPointers

(

C4Object *

pObj

)

Definition at line 576 of file C4ScriptGuiWindow.cpp.

{
    // assume that we actually contain an object
    // go through all the tags and, in case the tag has anything to do with objects, check and clear it
    for (auto & taggedProperty : taggedProperties)
    {
        switch (type)
        {
        case C4ScriptGuiWindowPropertyName::symbolObject:
            if (taggedProperty.second.obj == pObj)
                taggedProperty.second.obj = nullptr;
        break;
 
        case C4ScriptGuiWindowPropertyName::onClickAction:
        case C4ScriptGuiWindowPropertyName::onMouseInAction:
        case C4ScriptGuiWindowPropertyName::onMouseOutAction:
        case C4ScriptGuiWindowPropertyName::onCloseAction:
            if (taggedProperty.second.action)
                taggedProperty.second.action->ClearPointers(pObj);
        break;
        default:
            return;
        }
    }
}

References C4ScriptGuiWindowPropertyName::onClickAction, C4ScriptGuiWindowPropertyName::onCloseAction, C4ScriptGuiWindowPropertyName::onMouseInAction, C4ScriptGuiWindowPropertyName::onMouseOutAction, and C4ScriptGuiWindowPropertyName::symbolObject.

Referenced by C4ScriptGuiWindow::ClearPointers().

Here is the caller graph for this function:

GetAction()

C4ScriptGuiWindowAction* C4ScriptGuiWindowProperty::GetAction ( )

inline

Definition at line 168 of file C4ScriptGuiWindow.h.

{ return current->action; }

Referenced by C4ScriptGuiWindow::Close(), C4ScriptGuiWindow::OnMouseIn(), C4ScriptGuiWindow::OnMouseOut(), and C4ScriptGuiWindow::ProcessMouseInput().

Here is the caller graph for this function:

GetAllActions()

std::list< C4ScriptGuiWindowAction * > C4ScriptGuiWindowProperty::GetAllActions

(

)

Definition at line 611 of file C4ScriptGuiWindow.cpp.

{
    std::list<C4ScriptGuiWindowAction*> allActions;
    for (auto & taggedProperty : taggedProperties)
    {
        Prop &p = taggedProperty.second;
        if (p.action)
            allActions.push_back(p.action);
    }
    return allActions;
}

Referenced by C4ScriptGuiWindow::ExecuteCommand().

Here is the caller graph for this function:

GetCurrentTag()

C4String* C4ScriptGuiWindowProperty::GetCurrentTag ( )

inline

Definition at line 172 of file C4ScriptGuiWindow.h.

{ return currentTag; }

GetDef()

C4Def* C4ScriptGuiWindowProperty::GetDef ( )

inline

Definition at line 165 of file C4ScriptGuiWindow.h.

{ return current->def; }

Referenced by C4ScriptGuiWindow::Draw().

Here is the caller graph for this function:

GetFloat()

float C4ScriptGuiWindowProperty::GetFloat ( )

inline

Definition at line 163 of file C4ScriptGuiWindow.h.

{ return current->f; }

Referenced by C4ScriptGuiWindow::CalculateRelativeSize(), and C4ScriptGuiWindow::UpdateLayout().

Here is the caller graph for this function:

GetFrameDecoration()

C4GUI::FrameDecoration* C4ScriptGuiWindowProperty::GetFrameDecoration ( )

inline

Definition at line 166 of file C4ScriptGuiWindow.h.

{ return current->deco; }

Referenced by C4ScriptGuiWindow::Draw().

Here is the caller graph for this function:

GetInt()

int32_t C4ScriptGuiWindowProperty::GetInt ( )

inline

Definition at line 162 of file C4ScriptGuiWindow.h.

{ return current->d; }

Referenced by C4ScriptGuiWindow::Draw(), C4ScriptGuiWindow::DrawChildren(), C4ScriptGuiWindow::GetClippingRect(), C4ScriptGuiWindow::IsVisibleTo(), C4ScriptGuiWindow::MouseInput(), C4ScriptGuiWindow::ProcessMouseInput(), C4ScriptGuiWindow::RequestLayoutUpdate(), and C4ScriptGuiWindow::UpdateLayout().

Here is the caller graph for this function:

GetObject()

C4Object* C4ScriptGuiWindowProperty::GetObject ( )

inline

Definition at line 164 of file C4ScriptGuiWindow.h.

{ return current->obj; }

Referenced by C4ScriptGuiWindow::Draw().

Here is the caller graph for this function:

GetStrBuf()

StdCopyStrBuf* C4ScriptGuiWindowProperty::GetStrBuf ( )

inline

Definition at line 167 of file C4ScriptGuiWindow.h.

{ return current->strBuf; }

Referenced by C4ScriptGuiWindow::Draw(), C4ScriptGuiWindow::OnMouseIn(), and C4ScriptGuiWindow::UpdateLayout().

Here is the caller graph for this function:

Set()

void C4ScriptGuiWindowProperty::Set	(	const C4Value &	value,
		C4String *	tag
	)

Definition at line 439 of file C4ScriptGuiWindow.cpp.

{
    C4PropList *proplist = value.getPropList();
    bool isTaggedPropList = false;
    if (proplist)
        isTaggedPropList = !(proplist->GetDef() || proplist->GetObject());
 
    if (isTaggedPropList)
    {
        std::unique_ptr<C4ValueArray> properties(proplist->GetProperties());
        properties->SortStrings();
        for (int32_t i = 0; i < properties->GetSize(); ++i)
        {
            const C4Value &entry = properties->GetItem(i);
            C4String *key = entry.getStr();
            assert(key && "Proplist returns non-string as key");
 
            C4Value property;
            proplist->GetPropertyByS(key, &property);
            Set(property, key);
        }
        return;
    }
 
    // special treatment for some that have to be deleted (due to owning string/frame deco/...)
    if (taggedProperties.count(tag))
        CleanUp(taggedProperties[tag]);
    else // new tag, retain the proplist if not standard
        if (tag != &Strings.P[P_Std])
            tag->IncRef();
 
    taggedProperties[tag] = Prop();
    // in order to make /current/ sane, always reset it - not relying on implementation details of std::map
    // if the user wants a special tag selected, he should do that (standard selection will still be "Std")
    current = &taggedProperties[tag];
    currentTag = tag;
    
    
    // now that a new property entry has been created and the old has been cleaned up, get the data from the C4Value
    switch (type)
    {
    case C4ScriptGuiWindowPropertyName::left:
    case C4ScriptGuiWindowPropertyName::right:
    case C4ScriptGuiWindowPropertyName::top:
    case C4ScriptGuiWindowPropertyName::bottom:
    case C4ScriptGuiWindowPropertyName::relLeft:
    case C4ScriptGuiWindowPropertyName::relRight:
    case C4ScriptGuiWindowPropertyName::relTop:
    case C4ScriptGuiWindowPropertyName::relBottom:
    case C4ScriptGuiWindowPropertyName::leftMargin:
    case C4ScriptGuiWindowPropertyName::rightMargin:
    case C4ScriptGuiWindowPropertyName::topMargin:
    case C4ScriptGuiWindowPropertyName::bottomMargin:
    case C4ScriptGuiWindowPropertyName::relLeftMargin:
    case C4ScriptGuiWindowPropertyName::relRightMargin:
    case C4ScriptGuiWindowPropertyName::relTopMargin:
    case C4ScriptGuiWindowPropertyName::relBottomMargin:
        assert (false && "Trying to set positional properties directly. Those should always come parsed from a string.");
        break;
 
    case C4ScriptGuiWindowPropertyName::backgroundColor:
    case C4ScriptGuiWindowPropertyName::style:
    case C4ScriptGuiWindowPropertyName::priority:
        current->d = value.getInt();
        break;
 
    case C4ScriptGuiWindowPropertyName::player:
        if (value == C4VNull)
            current->d = ANY_OWNER;
        else
            current->d = value.getInt();
        break;
 
    case C4ScriptGuiWindowPropertyName::symbolObject:
    {
        C4PropList *symbol = value.getPropList();
        if (symbol)
            current->obj = symbol->GetObject();
        else current->obj = nullptr;
        break;
    }
    case C4ScriptGuiWindowPropertyName::symbolDef:
    {
        C4PropList *symbol = value.getPropList();
        if (symbol)
            current->def = symbol->GetDef();
        else current->def = nullptr;
        break;
    }
    case C4ScriptGuiWindowPropertyName::frameDecoration:
    {
        C4Def *def = value.getDef();
        
        if (def)
        {
            current->deco = new C4GUI::FrameDecoration();
            if (!current->deco->SetByDef(def))
            {
                delete current->deco;
                current->deco = nullptr;
            }
        }
        break;
    }
    case C4ScriptGuiWindowPropertyName::text:
    case C4ScriptGuiWindowPropertyName::symbolGraphicsName:
    case C4ScriptGuiWindowPropertyName::tooltip:
    {
        C4String *string = value.getStr();
        StdCopyStrBuf *buf = new StdCopyStrBuf();
        if (string)
            buf->Copy(string->GetCStr());
        else buf->Copy("");
        current->strBuf = buf;
        break;
    }
    case C4ScriptGuiWindowPropertyName::onClickAction:
    case C4ScriptGuiWindowPropertyName::onMouseInAction:
    case C4ScriptGuiWindowPropertyName::onMouseOutAction:
    case C4ScriptGuiWindowPropertyName::onCloseAction:
    {
        C4ValueArray *array = value.getArray();
        if (array)
        {
            assert (!current->action && "Prop() contains action prior to assignment");
            current->action = new C4ScriptGuiWindowAction();
            current->action->Init(array);
        }
        break;
    }
 
    default:
        assert(false && "C4ScriptGuiWindowAction should never have undefined type");
        break;
    } // switch
}

References ANY_OWNER, C4ScriptGuiWindowPropertyName::backgroundColor, C4ScriptGuiWindowPropertyName::bottom, C4ScriptGuiWindowPropertyName::bottomMargin, C4VNull, StdStrBuf::Copy(), C4ScriptGuiWindowPropertyName::frameDecoration, C4Value::getArray(), C4String::GetCStr(), C4PropList::GetDef(), C4Value::getDef(), C4Value::getInt(), C4PropList::GetObject(), C4PropList::GetProperties(), C4PropList::GetPropertyByS(), C4Value::getPropList(), C4Value::getStr(), C4RefCnt::IncRef(), C4ScriptGuiWindowPropertyName::left, C4ScriptGuiWindowPropertyName::leftMargin, C4ScriptGuiWindowPropertyName::onClickAction, C4ScriptGuiWindowPropertyName::onCloseAction, C4ScriptGuiWindowPropertyName::onMouseInAction, C4ScriptGuiWindowPropertyName::onMouseOutAction, C4StringTable::P, P_Std, C4ScriptGuiWindowPropertyName::player, C4ScriptGuiWindowPropertyName::priority, C4ScriptGuiWindowPropertyName::relBottom, C4ScriptGuiWindowPropertyName::relBottomMargin, C4ScriptGuiWindowPropertyName::relLeft, C4ScriptGuiWindowPropertyName::relLeftMargin, C4ScriptGuiWindowPropertyName::relRight, C4ScriptGuiWindowPropertyName::relRightMargin, C4ScriptGuiWindowPropertyName::relTop, C4ScriptGuiWindowPropertyName::relTopMargin, C4ScriptGuiWindowPropertyName::right, C4ScriptGuiWindowPropertyName::rightMargin, Strings, C4ScriptGuiWindowPropertyName::style, C4ScriptGuiWindowPropertyName::symbolDef, C4ScriptGuiWindowPropertyName::symbolGraphicsName, C4ScriptGuiWindowPropertyName::symbolObject, C4ScriptGuiWindowPropertyName::text, C4ScriptGuiWindowPropertyName::tooltip, C4ScriptGuiWindowPropertyName::top, and C4ScriptGuiWindowPropertyName::topMargin.

Referenced by C4ScriptGuiWindow::CreateFromPropList().

Here is the call graph for this function:

Here is the caller graph for this function:

SwitchTag()

bool C4ScriptGuiWindowProperty::SwitchTag

(

C4String *

tag

)

Definition at line 602 of file C4ScriptGuiWindow.cpp.

{
    if (!taggedProperties.count(tag)) return false; // tag not available
    if (current == &taggedProperties[tag]) return false; // tag already set?
    current = &taggedProperties[tag];
    currentTag = tag;
    return true;
}

ToC4Value()

const C4Value C4ScriptGuiWindowProperty::ToC4Value

(

)

Definition at line 345 of file C4ScriptGuiWindow.cpp.

{
    C4PropList *proplist = nullptr;
    
    bool onlyOneTag = taggedProperties.size() == 1;
    if (!onlyOneTag) // we will need a tagged proplist
        proplist = C4PropList::New();
 
    // go through all of the tagged properties and add a property to the proplist containing both the tag name
    // and the serialzed C4Value of the properties' value
    for(auto & taggedProperty : taggedProperties)
    {
        C4String *tagString = taggedProperty.first;
        const Prop &prop = taggedProperty.second;
 
        C4Value val;
 
        // get value to save
        switch (type)
        {
        case C4ScriptGuiWindowPropertyName::left:
        case C4ScriptGuiWindowPropertyName::right:
        case C4ScriptGuiWindowPropertyName::top:
        case C4ScriptGuiWindowPropertyName::bottom:
        case C4ScriptGuiWindowPropertyName::relLeft:
        case C4ScriptGuiWindowPropertyName::relRight:
        case C4ScriptGuiWindowPropertyName::relTop:
        case C4ScriptGuiWindowPropertyName::relBottom:
        case C4ScriptGuiWindowPropertyName::leftMargin:
        case C4ScriptGuiWindowPropertyName::rightMargin:
        case C4ScriptGuiWindowPropertyName::topMargin:
        case C4ScriptGuiWindowPropertyName::bottomMargin:
        case C4ScriptGuiWindowPropertyName::relLeftMargin:
        case C4ScriptGuiWindowPropertyName::relRightMargin:
        case C4ScriptGuiWindowPropertyName::relTopMargin:
        case C4ScriptGuiWindowPropertyName::relBottomMargin:
            assert (false && "Trying to get a single positional value from a GuiWindow for saving. Those should always be saved in pairs of two in a string.");
            break;
 
        case C4ScriptGuiWindowPropertyName::backgroundColor:
        case C4ScriptGuiWindowPropertyName::style:
        case C4ScriptGuiWindowPropertyName::priority:
        case C4ScriptGuiWindowPropertyName::player:
            val = C4Value(prop.d);
            break;
 
        case C4ScriptGuiWindowPropertyName::symbolObject:
            val = C4Value(prop.obj);
            break;
 
        case C4ScriptGuiWindowPropertyName::symbolDef:
            val = C4Value(prop.def);
            break;
 
        case C4ScriptGuiWindowPropertyName::frameDecoration:
            if (prop.deco)
                val = C4Value(prop.deco->pSourceDef);
            break;
 
        case C4ScriptGuiWindowPropertyName::text:
        case C4ScriptGuiWindowPropertyName::symbolGraphicsName:
        case C4ScriptGuiWindowPropertyName::tooltip:
        {
            if (prop.strBuf)
            {
                // string existing?
                C4String *s = Strings.FindString(prop.strBuf->getData());
                if (!s) s = Strings.RegString(prop.strBuf->getData());
                val = C4Value(s);
            }
            break;
        }
 
        case C4ScriptGuiWindowPropertyName::onClickAction:
        case C4ScriptGuiWindowPropertyName::onMouseInAction:
        case C4ScriptGuiWindowPropertyName::onMouseOutAction:
        case C4ScriptGuiWindowPropertyName::onCloseAction:
            if (prop.action)
                val = prop.action->ToC4Value();
            break;
 
        default:
            assert(false && "C4ScriptGuiWindowAction should never have undefined type");
            break;
        } // switch
 
        if (onlyOneTag) return val;
        assert(proplist);
        proplist->SetPropertyByS(tagString, val);
    }
 
    return C4Value(proplist);
}

References C4ScriptGuiWindowPropertyName::backgroundColor, C4ScriptGuiWindowPropertyName::bottom, C4ScriptGuiWindowPropertyName::bottomMargin, C4StringTable::FindString(), C4ScriptGuiWindowPropertyName::frameDecoration, C4ScriptGuiWindowPropertyName::left, C4ScriptGuiWindowPropertyName::leftMargin, C4PropList::New(), C4ScriptGuiWindowPropertyName::onClickAction, C4ScriptGuiWindowPropertyName::onCloseAction, C4ScriptGuiWindowPropertyName::onMouseInAction, C4ScriptGuiWindowPropertyName::onMouseOutAction, C4ScriptGuiWindowPropertyName::player, C4ScriptGuiWindowPropertyName::priority, C4StringTable::RegString(), C4ScriptGuiWindowPropertyName::relBottom, C4ScriptGuiWindowPropertyName::relBottomMargin, C4ScriptGuiWindowPropertyName::relLeft, C4ScriptGuiWindowPropertyName::relLeftMargin, C4ScriptGuiWindowPropertyName::relRight, C4ScriptGuiWindowPropertyName::relRightMargin, C4ScriptGuiWindowPropertyName::relTop, C4ScriptGuiWindowPropertyName::relTopMargin, C4ScriptGuiWindowPropertyName::right, C4ScriptGuiWindowPropertyName::rightMargin, s, C4PropList::SetPropertyByS(), Strings, C4ScriptGuiWindowPropertyName::style, C4ScriptGuiWindowPropertyName::symbolDef, C4ScriptGuiWindowPropertyName::symbolGraphicsName, C4ScriptGuiWindowPropertyName::symbolObject, C4ScriptGuiWindowPropertyName::text, C4ScriptGuiWindowPropertyName::tooltip, C4ScriptGuiWindowPropertyName::top, and C4ScriptGuiWindowPropertyName::topMargin.

Referenced by C4ScriptGuiWindow::ToC4Value().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

C4ScriptGuiWindow

friend class C4ScriptGuiWindow

friend

Definition at line 126 of file C4ScriptGuiWindow.h.

---

The documentation for this class was generated from the following files:

• C4ScriptGuiWindow.h
• C4ScriptGuiWindow.cpp