#include <C4ScriptGuiWindow.h>

Inheritance diagram for C4ScriptGuiWindow:

Collaboration diagram for C4ScriptGuiWindow:

Public Types
enum	MouseState { None = 0 , Focus = 1 , MouseDown = 2 }

Public Member Functions
void	SetTag (C4String *tag)

	C4ScriptGuiWindow ()

	~C4ScriptGuiWindow () override

int32_t	GetID ()

C4ScriptGuiWindow *	GetChildByID (int32_t child)

C4ScriptGuiWindow *	GetChildByName (C4String *childName)

C4ScriptGuiWindow *	GetSubWindow (int32_t childID, C4Object *childTarget)

bool	CreateFromPropList (C4PropList *proplist, bool resetStdTag=false, bool isUpdate=false, bool isLoading=false)

const C4Value	ToC4Value ()

void	SetEnumeratedID (int enumID)

void	Denumerate (C4ValueNumbers *numbers)

C4ScriptGuiWindow *	AddChild (C4ScriptGuiWindow *child)

C4ScriptGuiWindow *	AddChild ()

void	ClearChildren (bool close=true)

void	RemoveChild (C4ScriptGuiWindow *child, bool close=true, bool all=false)

void	Close ()

void	ClearPointers (C4Object *pObj)

float	CalculateRelativeSize (float parentWidthOrHeight, C4ScriptGuiWindowPropertyName::type absoluteProperty, C4ScriptGuiWindowPropertyName::type relativeProperty)

void	RequestLayoutUpdate ()

bool	UpdateLayout (C4TargetFacet &cgo)

bool	UpdateLayout (C4TargetFacet &cgo, float parentWidth, float parentHeight)

bool	UpdateChildLayout (C4TargetFacet &cgo, float parentWidth, float parentHeight)

void	UpdateLayoutGrid ()

void	UpdateLayoutTightGrid ()

void	UpdateLayoutVertical ()

void	Draw (C4TargetFacet &cgo) override

bool	DrawAll (C4TargetFacet &cgo, int32_t player)

bool	Draw (C4TargetFacet &cgo, int32_t player, C4Rect *currentClippingRect)

bool	GetClippingRect (int32_t &left, int32_t &top, int32_t &right, int32_t &bottom)

bool	DrawChildren (C4TargetFacet &cgo, int32_t player, int32_t withMultipleFlag=-1, C4Rect *currentClippingRect=nullptr)

bool	ExecuteCommand (int32_t actionID, int32_t player, int32_t subwindowID, int32_t actionType, C4Object *target)

virtual bool	MouseInput (int32_t iButton, int32_t iX, int32_t iY, DWORD dwKeyParam)

virtual bool	ProcessMouseInput (int32_t iButton, int32_t iX, int32_t iY, DWORD dwKeyParam, int32_t parentOffsetX, int32_t parentOffsetY)

void	MouseEnter (C4GUI::CMouse &rMouse) override

void	MouseLeave (C4GUI::CMouse &rMouse) override

void	OnMouseOut (int32_t player)

void	OnMouseIn (int32_t player, int32_t parentOffsetX, int32_t parentOffsetY)

bool	HasMouseFocus ()

bool	IsVisibleTo (int32_t player)

void	MouseInput (CMouse &rMouse, int32_t iButton, int32_t iX, int32_t iY, DWORD dwKeyParam) override

bool	IsComponentOutsideClientArea () override

void	Update ()

void	UpdateOwnPos () override

void	Freeze ()

void	UnFreeze ()

bool	IsFrozen () const

void	SetClientHeight (int32_t iToHgt)

void	SetDecoration (ScrollBarFacets *pToGfx, bool fAutoScroll)

void	SetScroll (int32_t iToScroll)

void	ScrollToBottom ()

void	ScrollPages (int iPageCount)

void	ScrollBy (int iAmount)

void	ScrollRangeInView (int32_t iY, int32_t iHgt)

bool	IsRangeInView (int32_t iY, int32_t iHgt)

int32_t	GetScrollY ()

void	SetScrollBarEnabled (bool fToVal, bool noAutomaticPositioning=false)

bool	IsScrollBarEnabled ()

bool	IsScrollingActive ()

bool	IsScrollingNecessary ()

void	SetPos (int32_t iXPos, int32_t iYPos)

C4Rect &	GetClientRect () override

void	ApplyElementOffset (int32_t &riX, int32_t &riY) override

void	ApplyInvElementOffset (int32_t &riX, int32_t &riY) override

virtual int32_t	GetMarginTop ()

virtual int32_t	GetMarginLeft ()

virtual int32_t	GetMarginRight ()

virtual int32_t	GetMarginBottom ()

void	Clear ()

void	ClearChildren ()

void	RemoveElement (Element *pChild) override

void	MakeLastElement (Element *pChild)

void	AddElement (Element *pChild)

void	ReaddElement (Element *pChild)

void	InsertElement (Element pChild, Element pInsertBefore)

Element *	GetNextNestedElement (Element *pPrevElement, bool fBackwards)

Element *	GetFirstContained () override

virtual Element *	GetLastContained ()

Element *	GetFirstNestedElement (bool fBackwards) override

Iterator	begin ()

Iterator	end ()

ReverseIterator	rbegin ()

ReverseIterator	rend ()

Element *	GetFirst ()

Element *	GetLast ()

Container *	GetContainer () override

Element *	GetElementByIndex (int32_t i)

int32_t	GetElementCount ()

void	SetVisibility (bool fToValue) override

virtual bool	IsFocused (Control *pCtrl)

virtual bool	IsSelectedChild (Element *pChild)

bool	IsParentOf (Element *pEl) override

virtual void	StartDragging (CMouse &rMouse, int32_t iX, int32_t iY, DWORD dwKeyParam)

virtual void	DoDragging (CMouse &rMouse, int32_t iX, int32_t iY, DWORD dwKeyParam)

virtual void	StopDragging (CMouse &rMouse, int32_t iX, int32_t iY, DWORD dwKeyParam)

bool	DoContext ()

Container *	GetParent ()

virtual class Dialog *	GetDlg ()

virtual Screen *	GetScreen ()

virtual Control *	IsFocusElement ()

void	ScreenPos2ClientPos (int32_t &riX, int32_t &riY)

void	ClientPos2ScreenPos (int32_t &riX, int32_t &riY)

void	SetToolTip (const char *szNewTooltip, bool is_immediate=false)

const char *	GetToolTip ()

const char *	GetOwnToolTip ()

bool	IsImmediateToolTip () const

int32_t	GetWidth ()

int32_t	GetHeight ()

C4Rect &	GetBounds ()

void	SetBounds (const C4Rect &rcNewBound)

C4Rect	GetContainedClientRect ()

Element *	GetNext () const

Element *	GetPrev () const

bool	IsInActiveDlg (bool fForKeyboard)

C4Rect	GetToprightCornerRect (int32_t iWidth=16, int32_t iHeight=16, int32_t iHIndent=4, int32_t iVIndent=4, int32_t iIndexX=0)

bool	IsVisible ()

virtual int32_t	GetListItemTopSpacing ()

virtual bool	GetListItemTopSpacingBar ()

void	SetDragTarget (Window *pToWindow)

void	SetContextHandler (ContextHandler *pNewHd)

virtual ContextHandler *	GetContextHandler ()

Public Attributes
int32_t	currentMouseState

bool	fVisible {true}

Static Public Attributes
static const float	standardWidth = 50.0f

static const float	standardHeight = 31.0f

Protected Member Functions
void	ElementSizeChanged (Element *pOfElement) override

void	ElementPosChanged (Element *pOfElement) override

virtual void	AfterElementRemoval ()

bool	OnHotkey (uint32_t cHotkey) override

virtual void	DrawElement (C4TargetFacet &cgo)

virtual void	UpdateSize ()

virtual void	UpdatePos ()

void	Draw3DFrame (C4TargetFacet &cgo, bool fUp=false, int32_t iIndent=1, BYTE byAlpha=C4GUI_BorderAlpha, bool fDrawTop=true, int32_t iTopOff=0, bool fDrawLeft=true, int32_t iLeftOff=0)

void	DrawBar (C4TargetFacet &cgo, DynBarFacet &rFacets)

void	DrawVBar (C4TargetFacet &cgo, DynBarFacet &rFacets)

void	DrawHBarByVGfx (C4TargetFacet &cgo, DynBarFacet &rFacets)

void	DrawHVBar (C4TargetFacet &cgo, DynBarFacet &rFacets, C4DrawTransform &trf, int32_t iMiddleLength)

virtual bool	IsOwnPtrElement ()

virtual bool	IsExternalDrawDialog ()

virtual bool	IsMenu ()

virtual class DialogWindow *	GetDialogWindow ()

virtual bool	CheckNameHotkey (const char *)

Protected Attributes
ScrollBar *	pScrollBar

int32_t	iScrollY

int32_t	iClientHeight

bool	fHasBar

int32_t	iFrozen

C4Rect	rcClientRect

Element *	pFirst

Element *	pLast

Container *	pParent {nullptr}

Element *	pPrev

Element *	pNext

Window *	pDragTarget {nullptr}

int32_t	iDragX

int32_t	iDragY

bool	fDragging {false}

ContextHandler *	pContextHandler {nullptr}

C4Rect	rcBounds

Friends
class	C4ScriptGuiWindowAction

class	C4ScriptGuiWindowScrollBar

Detailed Description

Definition at line 179 of file C4ScriptGuiWindow.h.

Member Enumeration Documentation

◆ MouseState

enum C4ScriptGuiWindow::MouseState

Enumerator
None
Focus
MouseDown

Definition at line 339 of file C4ScriptGuiWindow.h.

     {
         None = 0,
         Focus = 1,
         MouseDown = 2
     };

Constructor & Destructor Documentation

◆ C4ScriptGuiWindow()

C4ScriptGuiWindow::C4ScriptGuiWindow ( )

Definition at line 624 of file C4ScriptGuiWindow.cpp.

                                      : C4GUI::ScrollWindow(this)
 {
     Init();
 }

Referenced by AddChild(), and CreateFromPropList().

Here is the caller graph for this function:

◆ ~C4ScriptGuiWindow()

C4ScriptGuiWindow::~C4ScriptGuiWindow ( )

override

Definition at line 688 of file C4ScriptGuiWindow.cpp.

 {
     ClearChildren(false);
  
     // delete certain properties that contain allocated elements or referenced strings
     for (auto & prop : props)
         prop.CleanUpAll();
  
     if (pScrollBar)
         delete pScrollBar;
     if (name)
         name->DecRef();
 }

References C4GUI::Container::ClearChildren(), C4RefCnt::DecRef(), and C4GUI::ScrollWindow::pScrollBar.

Here is the call graph for this function:

Member Function Documentation

◆ AddChild() [1/2]

C4ScriptGuiWindow* C4ScriptGuiWindow::AddChild ( )

inline

Definition at line 286 of file C4ScriptGuiWindow.h.

286 { return AddChild(new C4ScriptGuiWindow()); }

C4ScriptGuiWindow::C4ScriptGuiWindow

C4ScriptGuiWindow()

Definition: C4ScriptGuiWindow.cpp:624

C4ScriptGuiWindow::AddChild

C4ScriptGuiWindow * AddChild()

Definition: C4ScriptGuiWindow.h:286

References AddChild(), and C4ScriptGuiWindow().

Referenced by AddChild(), and CreateFromPropList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddChild() [2/2]

C4ScriptGuiWindow * C4ScriptGuiWindow::AddChild ( C4ScriptGuiWindow * child )

Definition at line 1187 of file C4ScriptGuiWindow.cpp.

 {
     if (IsRoot())
     {
         child->SetID(GenerateMenuID());
         child->isMainWindow = true;
         // update all windows asap
         mainWindowNeedsLayoutUpdate = true;
     }
  
     // child's priority is ususally 0 here, so just insert it in front of other windows with a priority below 0
     // when the child's priority updates, the update function will be called and the child will be sorted to the correct position
     ChildChangedPriority(child);
  
     return child;
 }

◆ AddElement()

void C4GUI::Container::AddElement ( Element * pChild )

inherited

Definition at line 118 of file C4GuiContainers.cpp.

     {
         // safety
         if (!pChild) return;
         // remove from any previous container
         if (pChild->pParent) pChild->pParent->RemoveElement(pChild);
         // add to end of list
         if (pLast) pLast->pNext = pChild; else pFirst = pChild;
         pChild->pPrev = pLast; pChild->pNext = nullptr; pLast = pChild;
         pChild->pParent = this;
  
         assert(pChild->pNext != pChild);
         assert(pChild->pPrev != pChild);
         assert(pChild->pParent != pChild);
     }

References C4GUI::Container::pFirst, C4GUI::Container::pLast, C4GUI::Element::pNext, C4GUI::Element::pParent, C4GUI::Element::pPrev, and C4GUI::Container::RemoveElement().

Referenced by C4GUI::Tabular::AddCustomSheet(), C4GUI::ListBox::AddElement(), C4ChartDialog::C4ChartDialog(), C4ChatControl::C4ChatControl(), C4ChatDlg::C4ChatDlg(), C4DownloadDlg::C4DownloadDlg(), C4GameOptionButtons::C4GameOptionButtons(), C4GameOverDlg::C4GameOverDlg(), C4LeagueSignupDialog::C4LeagueSignupDialog(), C4Menu::C4Menu(), C4Network2ClientListDlg::C4Network2ClientListDlg(), C4Network2StartWaitDlg::C4Network2StartWaitDlg(), C4StartupAboutDlg::C4StartupAboutDlg(), C4StartupLegalDlg::C4StartupLegalDlg(), C4StartupMainDlg::C4StartupMainDlg(), C4StartupModsDlg::C4StartupModsDlg(), C4StartupModsListEntry::C4StartupModsListEntry(), C4StartupNetDlg::C4StartupNetDlg(), C4StartupNetListEntry::C4StartupNetListEntry(), C4StartupOptionsDlg::C4StartupOptionsDlg(), C4StartupPlrColorPickerDlg::C4StartupPlrColorPickerDlg(), C4StartupPlrPropertiesDlg::C4StartupPlrPropertiesDlg(), C4StartupPlrSelDlg::C4StartupPlrSelDlg(), C4StartupScenSelDlg::C4StartupScenSelDlg(), C4GUI::ContextButton::ContextButton(), C4MapFolderData::CreateGUIElements(), C4GUI::InfoDialog::CreateSubComponents(), C4FileSelDlg::DefaultListItem::DefaultListItem(), C4GUI::FullscreenDialog::FullscreenDialog(), C4FileSelDlg::InitElements(), C4GUI::InputDialog::InputDialog(), C4GUI::Container::InsertElement(), C4GUI::LabeledEdit::LabeledEdit(), C4GameLobby::MainDlg::MainDlg(), C4GUI::MessageDialog::MessageDialog(), C4ChatControl::ChatSheet::NickItem::NickItem(), C4GUI::ProgressDialog::ProgressDialog(), C4GUI::RenameEdit::RenameEdit(), C4GameLobby::ScenDesc::ScenDesc(), C4StartupScenSelDlg::ScenListItem::ScenListItem(), C4GUI::ScrollWindow::ScrollWindow(), C4GUI::InputDialog::SetCustomEdit(), C4GoalDisplay::SetGoals(), C4GUI::FullscreenDialog::SetTitle(), C4GUI::Dialog::SetTitle(), and C4GUI::TextWindow::TextWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AfterElementRemoval()

virtual void C4GUI::Container::AfterElementRemoval ( )

inlineprotectedvirtualinherited

Reimplemented in C4GUI::ListBox.

Definition at line 756 of file C4Gui.h.

757 { if (pParent) pParent->AfterElementRemoval(); } // called by ScrollWindow to parent after an element has been removed

C4GUI::Container::AfterElementRemoval

virtual void AfterElementRemoval()

Definition: C4Gui.h:756

References C4GUI::Container::AfterElementRemoval(), and C4GUI::Element::pParent.

Referenced by C4GUI::Container::AfterElementRemoval(), C4GUI::ListBox::AfterElementRemoval(), and C4GUI::Container::RemoveElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ApplyElementOffset()

void C4GUI::Window::ApplyElementOffset	(	int32_t &	riX,
		int32_t &	riY
	)

inlineoverridevirtualinherited

Reimplemented from C4GUI::Container.

Reimplemented in C4GUI::Dialog.

Definition at line 866 of file C4Gui.h.

867 { riX -= rcClientRect.x; riY -= rcClientRect.y; }

C4GUI::Window::rcClientRect

C4Rect rcClientRect

Definition: C4Gui.h:851

C4Rect::y

int32_t y

Definition: C4Rect.h:30

C4Rect::x

int32_t x

Definition: C4Rect.h:30

References C4GUI::Window::rcClientRect, C4Rect::x, and C4Rect::y.

Referenced by C4GUI::Dialog::ApplyElementOffset().

Here is the caller graph for this function:

◆ ApplyInvElementOffset()

void C4GUI::Window::ApplyInvElementOffset	(	int32_t &	riX,
		int32_t &	riY
	)

inlineoverridevirtualinherited

Reimplemented from C4GUI::Container.

Reimplemented in C4GUI::Dialog.

Definition at line 868 of file C4Gui.h.

869 { riX += rcClientRect.x; riY += rcClientRect.y; }

References C4GUI::Window::rcClientRect, C4Rect::x, and C4Rect::y.

Referenced by C4GUI::Dialog::ApplyInvElementOffset().

Here is the caller graph for this function:

◆ begin()

Iterator C4GUI::Container::begin ( )

inlineinherited

Definition at line 824 of file C4Gui.h.

824 { return Iterator(pFirst); }

References C4GUI::Container::pFirst.

Referenced by ClearPointers().

Here is the caller graph for this function:

◆ CalculateRelativeSize()

float C4ScriptGuiWindow::CalculateRelativeSize	(	float	parentWidthOrHeight,
		C4ScriptGuiWindowPropertyName::type	absoluteProperty,
		C4ScriptGuiWindowPropertyName::type	relativeProperty
	)

Definition at line 1398 of file C4ScriptGuiWindow.cpp.

 {
     const float widthOrHeight = Em2Pix(props[absoluteProperty].GetFloat())
         + float(parentWidthOrHeight) * props[relativeProperty].GetFloat();
     return widthOrHeight;
 }

References C4ScriptGuiWindowProperty::GetFloat().

Referenced by UpdateLayoutGrid(), UpdateLayoutTightGrid(), and UpdateLayoutVertical().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckNameHotkey()

virtual bool C4GUI::Element::CheckNameHotkey ( const char * )

inlineprotectedvirtualinherited

Reimplemented in C4StartupScenSelDlg::ScenListItem.

Definition at line 407 of file C4Gui.h.

407 { return false; }

Referenced by C4GUI::ListBox::CharIn().

Here is the caller graph for this function:

◆ Clear()

void C4GUI::Container::Clear ( )

inherited

Definition at line 63 of file C4GuiContainers.cpp.

     {
         ClearChildren();
     }

References C4GUI::Container::ClearChildren().

Referenced by C4GUI::Screen::Clear(), C4GUI::ComboBox_FillCB::ClearEntries(), C4StartupNetListEntry::ClearRef(), C4GUI::Container::~Container(), and C4GUI::ContextMenu::~ContextMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearChildren() [1/2]

void C4GUI::Container::ClearChildren ( )

inherited

Definition at line 68 of file C4GuiContainers.cpp.

     {
         // delete all items; dtor will update list
         while (pFirst)
         {
             if (pFirst->IsOwnPtrElement())
             {
                 // unlink from list
                 Element *pANext = pFirst->pNext;
                 pFirst->pPrev = pFirst->pNext = nullptr;
                 pFirst->pParent = nullptr;
                 if ((pFirst = pANext))
                     pFirst->pPrev = nullptr;
                 else
                     pLast = nullptr;
             }
             else
                 delete pFirst;
         }
     }

References C4GUI::Element::IsOwnPtrElement(), C4GUI::Container::pFirst, C4GUI::Container::pLast, C4GUI::Element::pNext, C4GUI::Element::pParent, and C4GUI::Element::pPrev.

Referenced by C4GUI::Container::Clear(), Close(), RemoveChild(), C4GoalDisplay::SetGoals(), and ~C4ScriptGuiWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearChildren() [2/2]

void C4ScriptGuiWindow::ClearChildren ( bool close = true )

Definition at line 1337 of file C4ScriptGuiWindow.cpp.

 {
     RemoveChild(nullptr, close, true);
 }

References RemoveChild().

Here is the call graph for this function:

◆ ClearPointers()

void C4ScriptGuiWindow::ClearPointers ( C4Object * pObj )

Definition at line 1159 of file C4ScriptGuiWindow.cpp.

 {
     // not removing or clearing anything twice
     // if this flag is set, the object will not be used after this frame (callbacks?) anyway
     if (wasRemovedFromParent) return;
  
     // all properties which have anything to do with objects need to be called from here!
     props[C4ScriptGuiWindowPropertyName::symbolObject].ClearPointers(pObj);
     props[C4ScriptGuiWindowPropertyName::onClickAction].ClearPointers(pObj);
     props[C4ScriptGuiWindowPropertyName::onMouseInAction].ClearPointers(pObj);
     props[C4ScriptGuiWindowPropertyName::onMouseOutAction].ClearPointers(pObj);
     props[C4ScriptGuiWindowPropertyName::onCloseAction].ClearPointers(pObj);
  
     for (auto iter = begin(); iter != end();)
     {
         C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(*iter);
         // increment the iterator before (possibly) deleting the child
         ++iter;
         child->ClearPointers(pObj);
     }
  
     if (target == pObj)
     {
         MenuDebugLogF("Closing window (%d, %s, @%p, target: %p) due to target removal.", id, name, this, this->target);
         Close();
     }
 }

References C4GUI::Container::begin(), C4ScriptGuiWindowProperty::ClearPointers(), ClearPointers(), Close(), C4GUI::Container::end(), MenuDebugLogF, C4ScriptGuiWindowPropertyName::onClickAction, C4ScriptGuiWindowPropertyName::onCloseAction, C4ScriptGuiWindowPropertyName::onMouseInAction, C4ScriptGuiWindowPropertyName::onMouseOutAction, and C4ScriptGuiWindowPropertyName::symbolObject.

Referenced by ClearPointers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClientPos2ScreenPos()

void C4GUI::Element::ClientPos2ScreenPos	(	int32_t &	riX,
		int32_t &	riY
	)

inherited

Definition at line 231 of file C4Gui.cpp.

     {
         // apply all parent offsets
         Container *pCont = pParent;
         while (pCont)
         {
             pCont->ApplyInvElementOffset(riX, riY);
             pCont = pCont->GetParent();
         }
         // apply own offset
         riX += rcBounds.x; riY += rcBounds.y;
     }

References C4GUI::Container::ApplyInvElementOffset(), C4GUI::Element::GetParent(), C4GUI::Element::pParent, C4GUI::Element::rcBounds, C4Rect::x, and C4Rect::y.

Referenced by C4MapFolderData::CreateGUIElements(), C4GUI::Screen::DoContext(), and C4Menu::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Close()

void C4ScriptGuiWindow::Close ( )

Definition at line 1342 of file C4ScriptGuiWindow.cpp.

 {
     // This can only be called once.
     if (wasClosed)
         return;
     wasClosed = true;
     // first, close all children and dispose of them properly
     ClearChildren(true);
  
     // make call to target object if applicable
     C4ScriptGuiWindowAction *action = props[C4ScriptGuiWindowPropertyName::onCloseAction].GetAction();
     // only calls are valid actions for OnClose
     if (action && action->action == C4ScriptGuiWindowActionID::Call)
     {
         // close is always syncronized (script call/object removal) and thus the action can be executed immediately
         // (otherwise the GUI&action would have been removed anyway..)
         lockRemovalForClosingCallback();
         action->ExecuteCommand(action->id, this, NO_OWNER);
         unlockRemovalForClosingCallback();
     }
  
     target = nullptr;
  
     if (!wasRemovedFromParent)
     {
         assert(GetParent() && "Close()ing GUIWindow without parent");
         static_cast<C4ScriptGuiWindow*>(GetParent())->RemoveChild(this);
     }
 }

References C4ScriptGuiWindowActionID::Call, C4GUI::Container::ClearChildren(), C4ScriptGuiWindowAction::ExecuteCommand(), C4ScriptGuiWindowProperty::GetAction(), C4GUI::Element::GetParent(), NO_OWNER, C4ScriptGuiWindowPropertyName::onCloseAction, and RemoveChild().

Referenced by ClearPointers(), and RemoveChild().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CreateFromPropList()

bool C4ScriptGuiWindow::CreateFromPropList	(	C4PropList *	proplist,
		bool	resetStdTag = `false`,
		bool	isUpdate = `false`,
		bool	isLoading = `false`
	)

Definition at line 988 of file C4ScriptGuiWindow.cpp.

 {
     if (!proplist) return false;
     C4ScriptGuiWindow * parent = static_cast<C4ScriptGuiWindow*>(GetParent());
     assert((parent || isLoading) && "GuiWindow created from proplist without parent (fails for ID tag)");
  
     bool layoutUpdateRequired = false; // needed for position changes etc
  
     // Get properties from proplist and check for those, that match an allowed property to set them;
     // We take ownership here. Automatically destroy the object when we're done.
     std::unique_ptr<C4ValueArray> properties(proplist->GetProperties());
     properties->SortStrings();
     C4String *stdTag = &Strings.P[P_Std];
     const int32_t propertySize = properties->GetSize();
     for (int32_t i = 0; i < propertySize; ++i)
     {
         const C4Value &entry = properties->GetItem(i);
         C4String *key = entry.getStr();
         assert(key && "PropList returns non-string as key");
         MenuDebugLogF("--%s\t\t(I am %d)", key->GetCStr(), id);
         C4Value property;
         proplist->GetPropertyByS(key, &property);
  
         if(&Strings.P[P_Left] == key)
         {
             SetPositionStringProperties(property, C4ScriptGuiWindowPropertyName::relLeft, C4ScriptGuiWindowPropertyName::left, stdTag);
             layoutUpdateRequired = true;
         }
         else if(&Strings.P[P_Top] == key)
         {
             SetPositionStringProperties(property, C4ScriptGuiWindowPropertyName::relTop, C4ScriptGuiWindowPropertyName::top, stdTag);
             layoutUpdateRequired = true;
         }
         else if(&Strings.P[P_Right] == key)
         {
             SetPositionStringProperties(property, C4ScriptGuiWindowPropertyName::relRight, C4ScriptGuiWindowPropertyName::right, stdTag);
             layoutUpdateRequired = true;
         }
         else if(&Strings.P[P_Bottom] == key)
         {
             SetPositionStringProperties(property, C4ScriptGuiWindowPropertyName::relBottom, C4ScriptGuiWindowPropertyName::bottom, stdTag);
             layoutUpdateRequired = true;
         }
         else if (&Strings.P[P_Margin] == key)
         {
             SetMarginProperties(property, stdTag);
             layoutUpdateRequired = true;
         }
         else if(&Strings.P[P_BackgroundColor] == key)
             props[C4ScriptGuiWindowPropertyName::backgroundColor].Set(property, stdTag);
         else if(&Strings.P[P_Target] == key)
             target = property.getObj();
         else if(&Strings.P[P_Symbol] == key)
         {
             props[C4ScriptGuiWindowPropertyName::symbolDef].Set(property, stdTag);
             props[C4ScriptGuiWindowPropertyName::symbolObject].Set(property, stdTag);
         }
         else if(&Strings.P[P_Decoration] == key)
         {
             props[C4ScriptGuiWindowPropertyName::frameDecoration].Set(property, stdTag);
         }
         else if(&Strings.P[P_Text] == key)
         {
             props[C4ScriptGuiWindowPropertyName::text].Set(property, stdTag);
             layoutUpdateRequired = true;
         }
         else if (&Strings.P[P_GraphicsName] == key)
         {
             props[C4ScriptGuiWindowPropertyName::symbolGraphicsName].Set(property, stdTag);
         }
         else if (&Strings.P[P_Tooltip] == key)
         {
             props[C4ScriptGuiWindowPropertyName::tooltip].Set(property, stdTag);
         }
         else if(&Strings.P[P_Prototype] == key)
             ; // do nothing
         else if (&Strings.P[P_Mode] == key) // note that "Mode" is abused here for saving whether we have mouse focus
         {
             if (isLoading)
                 currentMouseState = property.getInt();
         }
         else if(&Strings.P[P_ID] == key)
         {
             // setting IDs is only valid for subwindows or when loading savegames!
             if (parent && !isMainWindow)
             {
                 if (id) // already have an ID? remove from parent
                     parent->ChildWithIDRemoved(this);
                 id = property.getInt();
                 if (id != 0)
                     parent->ChildGotID(this);
             }
             else
                 if (isLoading)
                     id = property.getInt();
         }
         else if (&Strings.P[P_OnClick] == key)
         {
             MenuDebugLogF("Adding new action, I am window %d with parent %d", id, static_cast<C4ScriptGuiWindow*>(parent)->id);
             props[C4ScriptGuiWindowPropertyName::onClickAction].Set(property, stdTag);
         }
         else if(&Strings.P[P_OnMouseIn] == key)
             props[C4ScriptGuiWindowPropertyName::onMouseInAction].Set(property, stdTag);
         else if(&Strings.P[P_OnMouseOut] == key)
             props[C4ScriptGuiWindowPropertyName::onMouseOutAction].Set(property, stdTag);
         else if(&Strings.P[P_OnClose] == key)
             props[C4ScriptGuiWindowPropertyName::onCloseAction].Set(property, stdTag);
         else if(&Strings.P[P_Style] == key)
         {
             props[C4ScriptGuiWindowPropertyName::style].Set(property, stdTag);
             layoutUpdateRequired = true;
         }
         else if(&Strings.P[P_Priority] == key)
         {
             props[C4ScriptGuiWindowPropertyName::priority].Set(property, stdTag);
             layoutUpdateRequired = true;
             // resort into parent's list
             if (parent)
                 parent->ChildChangedPriority(this);
         }
         else if(&Strings.P[P_Player] == key)
             props[C4ScriptGuiWindowPropertyName::player].Set(property, stdTag);
         else
         {
             // possibly sub-window?
             C4PropList *subwindow = property.getPropList();
             if (subwindow)
             {
                 // remember the name of the child; but ignore names starting with underscores
                 C4String *childName = nullptr;
                 if (key->GetCStr()[0] != '_')
                     childName = key;
  
                 // Do we already have a child with that name? That implies that we are updating here.
                 C4ScriptGuiWindow *child = GetChildByName(childName);
                 bool freshlyAdded = false;
                 
                 // first time referencing a child with that name? Create a new one!
                 if (!child)
                 {
                     child = new C4ScriptGuiWindow();
                     if (childName != nullptr)
                     {
                         child->name = childName;
                         child->name->IncRef();
                     }
                     AddChild(child);
                     freshlyAdded = true;
                 }
  
                 if (!child->CreateFromPropList(subwindow, isUpdate == true, false, isLoading))
                 {
                     // Remove the child again if we just added it. However, ignore when just updating an existing child.
                     if (freshlyAdded)
                         RemoveChild(child, false);
                 }
                 else
                     layoutUpdateRequired = true;
             }
         }
     }
  
     if (!isLoading && layoutUpdateRequired)
         RequestLayoutUpdate();
  
     if (resetStdTag || isLoading)
         SetTag(stdTag);
  
     return true;
 }

Referenced by CreateFromPropList(), and Denumerate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Denumerate()

void C4ScriptGuiWindow::Denumerate ( C4ValueNumbers * numbers )

Definition at line 867 of file C4ScriptGuiWindow.cpp.

 {
     assert(IsRoot());
     if (id == 0)
     {
         // nothing to do, note that the id is abused for the id in the enumeration
         return;
     }
     C4Value value = numbers->GetValue(id);
     id = 0;
     CreateFromPropList(value.getPropList(), false, false, true);
  
     for (C4GUI::Element * element : *this)
     {
         C4ScriptGuiWindow *mainWindow = static_cast<C4ScriptGuiWindow*>(element);
         mainWindow->RequestLayoutUpdate();
     }
 }

References CreateFromPropList(), C4Value::getPropList(), C4ValueNumbers::GetValue(), and RequestLayoutUpdate().

Here is the call graph for this function:

◆ DoContext()

bool C4GUI::Element::DoContext ( )

inherited

Definition at line 417 of file C4Gui.cpp.

     {
         if (!pContextHandler) return false;
         return pContextHandler->OnContext(this, rcBounds.Wdt/2, rcBounds.Hgt/2);
     }

References C4Rect::Hgt, C4GUI::ContextHandler::OnContext(), C4GUI::Element::pContextHandler, C4GUI::Element::rcBounds, and C4Rect::Wdt.

Referenced by C4GUI::Control::KeyContext(), and C4GUI::ContextButton::MouseInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDragging()

void C4GUI::Element::DoDragging	(	CMouse &	rMouse,
		int32_t	iX,
		int32_t	iY,
		DWORD	dwKeyParam
	)

virtualinherited

Reimplemented in C4GUI::Edit, and C4GUI::ScrollBar.

Definition at line 269 of file C4Gui.cpp.

     {
         // check if anything moved
         if (pDragTarget && (iX != iDragX || iY != iDragY))
         {
             // move position, then
             pDragTarget->rcBounds.x += iX-iDragX;
             pDragTarget->rcBounds.y += iY-iDragY;
             // drag X/Y is up-to-date if this is a child element of the drag target
             pDragTarget->UpdatePos();
         }
     }

References C4GUI::Element::iDragX, C4GUI::Element::iDragY, C4GUI::Element::pDragTarget, C4GUI::Element::rcBounds, C4GUI::Element::UpdatePos(), C4Rect::x, and C4Rect::y.

Referenced by C4GUI::Screen::MouseInput(), and C4GUI::Element::StopDragging().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Draw() [1/2]

void C4ScriptGuiWindow::Draw ( C4TargetFacet & cgo )

inlineoverridevirtual

Reimplemented from C4GUI::Window.

Definition at line 308 of file C4ScriptGuiWindow.h.

308 {}

Referenced by DrawChildren().

Here is the caller graph for this function:

◆ Draw() [2/2]

bool C4ScriptGuiWindow::Draw	(	C4TargetFacet &	cgo,
		int32_t	player,
		C4Rect *	currentClippingRect
	)

Definition at line 1904 of file C4ScriptGuiWindow.cpp.

 {
     assert(!IsRoot()); // not root, root needs to receive DrawAll
  
     // message hidden?
     if (!IsVisibleTo(player)) return false;
     
     const int32_t &style = props[C4ScriptGuiWindowPropertyName::style].GetInt();
  
     if (mainWindowNeedsLayoutUpdate)
     {
         assert(GetParent() && (static_cast<C4ScriptGuiWindow*>(GetParent())->IsRoot()));
         assert(isMainWindow);
         assert(!(style & C4ScriptGuiWindowStyleFlag::Multiple) && "\"Multiple\"-style window not updated by a full refresh of the root window.");
         C4ScriptGuiWindow * parent = static_cast<C4ScriptGuiWindow*>(GetParent());
         UpdateLayout(cgo, parent->rcBounds.Wdt, parent->rcBounds.Hgt);
         assert(!mainWindowNeedsLayoutUpdate);
     }
  
     const int32_t outDrawX = cgo.X + cgo.TargetX + rcBounds.x;
     const int32_t outDrawY = cgo.Y + cgo.TargetY + rcBounds.y;
     const int32_t outDrawWdt = rcBounds.Wdt;
     const int32_t outDrawHgt = rcBounds.Hgt;
     const int32_t outDrawRight = outDrawX + rcBounds.Wdt;
     const int32_t outDrawBottom = outDrawY + rcBounds.Hgt;
     // draw various properties
     C4Facet cgoOut(cgo.Surface, outDrawX, outDrawY, outDrawWdt, outDrawHgt);
  
     const int32_t &backgroundColor = props[C4ScriptGuiWindowPropertyName::backgroundColor].GetInt();
     if (backgroundColor)
         pDraw->DrawBoxDw(cgo.Surface, outDrawX, outDrawY, outDrawRight - 1.0f, outDrawBottom - 1.0f, backgroundColor);
  
     C4GUI::FrameDecoration *frameDecoration = props[C4ScriptGuiWindowPropertyName::frameDecoration].GetFrameDecoration();
  
     if (frameDecoration)
     {
         // the frame decoration will adjust for cgo.TargetX/Y itself
         C4Rect rect(
             outDrawX - frameDecoration->iBorderLeft - cgo.TargetX,
             outDrawY - frameDecoration->iBorderTop - cgo.TargetY,
             outDrawWdt + frameDecoration->iBorderRight + frameDecoration->iBorderLeft,
             outDrawHgt + frameDecoration->iBorderBottom + frameDecoration->iBorderTop);
         frameDecoration->Draw(cgo, rect);
     }
  
     C4Object *symbolObject = props[C4ScriptGuiWindowPropertyName::symbolObject].GetObject();
     if (symbolObject)
     {
         symbolObject->DrawPicture(cgoOut, false, nullptr);
     }
     else
     {
         C4Def *symbolDef = props[C4ScriptGuiWindowPropertyName::symbolDef].GetDef();
         StdCopyStrBuf *graphicsName = props[C4ScriptGuiWindowPropertyName::symbolGraphicsName].GetStrBuf();
         if (symbolDef)
         {
             symbolDef->Draw(cgoOut, false, 0UL, nullptr, 0, 0, nullptr, graphicsName ? graphicsName->getData() : nullptr);
         }
     }
  
     StdCopyStrBuf *strBuf = props[C4ScriptGuiWindowPropertyName::text].GetStrBuf();
  
     if (strBuf)
     {
         StdStrBuf sText;
         int alignment = ALeft;
         // If we are showing a scrollbar, we need to leave a bit of space for it so that it doesn't overlap the text.
         const int scrollbarXOffset = pScrollBar->IsVisible() ? pScrollBar->rcBounds.Wdt : 0;
         const int scrollbarScroll = pScrollBar->IsVisible() ? this->GetScrollY() : 0;
         const int actualDrawingWidth = outDrawWdt - scrollbarXOffset;
         
         // If we are set to NoCrop, the message will be split by string-defined line breaks only.
         int allowedTextWidth = actualDrawingWidth;
         
         if (style & C4ScriptGuiWindowStyleFlag::NoCrop)
             allowedTextWidth = std::numeric_limits<int>::max();
         int32_t textHgt = ::GraphicsResource.FontRegular.BreakMessage(strBuf->getData(), allowedTextWidth, &sText, true);
         float textYOffset = static_cast<float>(-scrollbarScroll), textXOffset = 0.0f;
         if (style & C4ScriptGuiWindowStyleFlag::TextVCenter)
             textYOffset = float(outDrawHgt) / 2.0f - float(textHgt) / 2.0f;
         else if (style & C4ScriptGuiWindowStyleFlag::TextBottom)
             textYOffset = float(outDrawHgt) - float(textHgt);
         if (style & C4ScriptGuiWindowStyleFlag::TextHCenter)
         {
             int wdt, hgt;
             ::GraphicsResource.FontRegular.GetTextExtent(sText.getData(), wdt, hgt, true);
             textXOffset = float(actualDrawingWidth) / 2.0f;
             alignment = ACenter;
         }
         else if (style & C4ScriptGuiWindowStyleFlag::TextRight)
         {
             alignment = ARight;
             int wdt, hgt;
             ::GraphicsResource.FontRegular.GetTextExtent(sText.getData(), wdt, hgt, true);
             textXOffset = float(actualDrawingWidth);
         }
         pDraw->TextOut(sText.getData(), ::GraphicsResource.FontRegular, 1.0, cgo.Surface, outDrawX + textXOffset, outDrawY + textYOffset, 0xffffffff, alignment);
     }
  
  
     if (GraphicsSystem.ShowMenuInfo) // print helpful debug info
     {
         DWORD frameColor = C4RGB(100, 150, 100);
         if (currentMouseState & MouseState::Focus) frameColor = C4RGB(0, 255, 0);
  
         pDraw->DrawFrameDw(cgo.Surface, outDrawX, outDrawY, outDrawRight, outDrawBottom, frameColor);
         if (target || id)
         {
             StdStrBuf buf = FormatString("%s(%d)", target ? target->GetName() : "", id);
             pDraw->TextOut(buf.getData(), ::GraphicsResource.FontCaption, 1.0, cgo.Surface, cgo.X + outDrawRight, cgo.Y + outDrawBottom - ::GraphicsResource.FontCaption.GetLineHeight(), 0xffff00ff, ARight);
         }
         //StdStrBuf buf2 = FormatString("(%d, %d, %d, %d)", rcBounds.x, rcBounds.y, rcBounds.Wdt, rcBounds.Hgt);
         //pDraw->TextOut(buf2.getData(), ::GraphicsResource.FontCaption, 1.0, cgo.Surface, cgo.X + outDrawX + rcBounds.Wdt / 2, cgo.Y + outDrawY + +rcBounds.Hgt / 2, 0xff00ffff, ACenter);
     }
  
     DrawChildren(cgo, player, -1, currentClippingRect);
     return true;
 }

References ACenter, ALeft, ARight, C4ScriptGuiWindowPropertyName::backgroundColor, CStdFont::BreakMessage(), C4RGB, currentMouseState, C4Draw::DrawBoxDw(), DrawChildren(), C4Draw::DrawFrameDw(), C4GraphicsResource::FontCaption, C4GraphicsResource::FontRegular, FormatString(), C4ScriptGuiWindowPropertyName::frameDecoration, StdStrBuf::getData(), C4ScriptGuiWindowProperty::GetDef(), C4ScriptGuiWindowProperty::GetFrameDecoration(), C4ScriptGuiWindowProperty::GetInt(), CStdFont::GetLineHeight(), C4PropList::GetName(), C4ScriptGuiWindowProperty::GetObject(), C4GUI::Element::GetParent(), C4GUI::ScrollWindow::GetScrollY(), C4ScriptGuiWindowProperty::GetStrBuf(), CStdFont::GetTextExtent(), GraphicsResource, GraphicsSystem, C4Rect::Hgt, C4GUI::Element::IsVisible(), IsVisibleTo(), C4ScriptGuiWindowStyleFlag::Multiple, C4ScriptGuiWindowStyleFlag::NoCrop, pDraw, C4ScriptGuiWindowPropertyName::player, C4GUI::ScrollWindow::pScrollBar, C4GUI::Element::rcBounds, C4GraphicsSystem::ShowMenuInfo, C4ScriptGuiWindowPropertyName::style, C4Facet::Surface, C4ScriptGuiWindowPropertyName::symbolDef, C4ScriptGuiWindowPropertyName::symbolGraphicsName, C4ScriptGuiWindowPropertyName::symbolObject, C4TargetFacet::TargetX, C4TargetFacet::TargetY, C4ScriptGuiWindowPropertyName::text, C4ScriptGuiWindowStyleFlag::TextBottom, C4ScriptGuiWindowStyleFlag::TextHCenter, C4Draw::TextOut(), C4ScriptGuiWindowStyleFlag::TextRight, C4ScriptGuiWindowStyleFlag::TextVCenter, UpdateLayout(), C4Rect::Wdt, C4Facet::X, C4Rect::x, C4Facet::Y, and C4Rect::y.

Here is the call graph for this function:

◆ Draw3DFrame()

void C4GUI::Element::Draw3DFrame	(	C4TargetFacet &	cgo,
		bool	fUp = `false`,
		int32_t	iIndent = `1`,
		BYTE	byAlpha = `C4GUI_BorderAlpha`,
		bool	fDrawTop = `true`,
		int32_t	iTopOff = `0`,
		bool	fDrawLeft = `true`,
		int32_t	iLeftOff = `0`
	)

protectedinherited

Definition at line 291 of file C4Gui.cpp.

     {
         DWORD dwAlpha = byAlpha<<24;
         int32_t x0 = cgo.TargetX + rcBounds.x + iLeftOff,
                      y0 = cgo.TargetY + rcBounds.y + iTopOff,
                           x1 = cgo.TargetX + rcBounds.x + rcBounds.Wdt - 1,
                                y1 = cgo.TargetY + rcBounds.y + rcBounds.Hgt - 1;
         if (fDrawTop) pDraw->DrawLineDw(cgo.Surface, (float)x0,(float)y0,(float)x1,(float)y0, C4GUI_BorderColor1 | dwAlpha);
         if (fDrawLeft) pDraw->DrawLineDw(cgo.Surface, (float)x0,(float)y0,(float)x0,(float)y1, C4GUI_BorderColor1 | dwAlpha);
         if (fDrawTop) pDraw->DrawLineDw(cgo.Surface, (float)(x0+1),(float)(y0+1),(float)(x1-1),(float)(y0+1), C4GUI_BorderColor2 | dwAlpha);
         if (fDrawLeft) pDraw->DrawLineDw(cgo.Surface, (float)(x0+1),(float)(y0+1),(float)(x0+1),(float)(y1-1), C4GUI_BorderColor2 | dwAlpha);
         pDraw->DrawLineDw(cgo.Surface, (float)x0,(float)y1,(float)x1,(float)y1, C4GUI_BorderColor3 | dwAlpha);
         pDraw->DrawLineDw(cgo.Surface, (float)x1,(float)y0,(float)x1,(float)y1, C4GUI_BorderColor3 | dwAlpha);
         pDraw->DrawLineDw(cgo.Surface, (float)(x0+1),(float)(y1-1),(float)(x1-1),(float)(y1-1), C4GUI_BorderColor1 | dwAlpha);
         pDraw->DrawLineDw(cgo.Surface, (float)(x1-1),(float)(y0+1),(float)(x1-1),(float)(y1-1), C4GUI_BorderColor1 | dwAlpha);
     }

References C4GUI_BorderColor1, C4GUI_BorderColor2, C4GUI_BorderColor3, C4Draw::DrawLineDw(), C4Rect::Hgt, pDraw, C4GUI::Element::rcBounds, C4Facet::Surface, C4TargetFacet::TargetX, C4TargetFacet::TargetY, C4Rect::Wdt, C4Rect::x, and C4Rect::y.

Referenced by C4GUI::ProgressBar::DrawElement(), C4GUI::GroupBox::DrawElement(), C4GUI::Edit::DrawElement(), C4GUI::ListBox::DrawElement(), C4GUI::Tabular::DrawElement(), C4GUI::TextWindow::DrawElement(), C4GUI::ContextMenu::DrawElement(), C4GUI::ComboBox::DrawElement(), and C4GUI::Dialog::DrawElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DrawAll()

bool C4ScriptGuiWindow::DrawAll	(	C4TargetFacet &	cgo,
		int32_t	player
	)

Definition at line 1882 of file C4ScriptGuiWindow.cpp.

 {
     assert(IsRoot()); // we are root
     if (!IsVisible()) return false;
     // if the viewport shows an upper-board, apply an offset to everything
     const int oldTargetX = cgo.TargetX;
     const int oldTargetY = cgo.TargetY;
     cgo.TargetX += cgo.X;
     cgo.TargetY += cgo.Y;
     // this will check whether the viewport resized and we need an update
     UpdateLayout(cgo);
     // step one: draw all multiple-tagged windows
     DrawChildren(cgo, player, 1);
     // TODO: adjust rectangle for main menu if multiple windows exist
     // step two: draw one "main" menu
     DrawChildren(cgo, player, 0);
     // ..and restore the offset
     cgo.TargetX = oldTargetX;
     cgo.TargetY = oldTargetY;
     return true;
 }

References DrawChildren(), C4GUI::Element::IsVisible(), C4ScriptGuiWindowPropertyName::player, C4TargetFacet::TargetX, C4TargetFacet::TargetY, UpdateLayout(), C4Facet::X, and C4Facet::Y.

Here is the call graph for this function:

◆ DrawBar()

void C4GUI::Element::DrawBar	(	C4TargetFacet &	cgo,
		DynBarFacet &	rFacets
	)

protectedinherited

Definition at line 308 of file C4Gui.cpp.

     {
         if (rcBounds.Hgt == rFacets.fctMiddle.Hgt)
         {
             // exact bar
             int32_t x0=cgo.TargetX+rcBounds.x, y0=cgo.TargetY+rcBounds.y;
             int32_t iX = rFacets.fctBegin.Wdt, w=rFacets.fctMiddle.Wdt, wLeft=rFacets.fctBegin.Wdt, wRight=rFacets.fctEnd.Wdt;
             int32_t iRightShowLength = wRight/3;
             bool fOverflow = (wLeft > rcBounds.Wdt);
             if (fOverflow) rFacets.fctBegin.Wdt = rcBounds.Wdt;
             rFacets.fctBegin.Draw(cgo.Surface, x0,y0);
             if (fOverflow) rFacets.fctBegin.Wdt = wLeft;
             while (iX < rcBounds.Wdt-iRightShowLength)
             {
                 int32_t w2=std::min(w, rcBounds.Wdt-iRightShowLength-iX); rFacets.fctMiddle.Wdt=w2;
                 rFacets.fctMiddle.Draw(cgo.Surface, x0+iX, y0);
                 iX += w;
             }
             rFacets.fctMiddle.Wdt=w;
             fOverflow = (wRight > rcBounds.Wdt);
             if (fOverflow)
             {
                 rFacets.fctEnd.X += wRight - rcBounds.Wdt;
                 rFacets.fctEnd.Wdt = rcBounds.Wdt;
             }
             rFacets.fctEnd.Draw(cgo.Surface, x0+rcBounds.Wdt-rFacets.fctEnd.Wdt, y0);
             if (fOverflow)
             {
                 rFacets.fctEnd.X -= wRight - rcBounds.Wdt;
                 rFacets.fctEnd.Wdt = wRight;
             }
         }
         else
         {
             // zoomed bar
             float fZoom = (float) rcBounds.Hgt / rFacets.fctMiddle.Hgt;
             int32_t x0=cgo.TargetX+rcBounds.x, y0=cgo.TargetY+rcBounds.y;
             int32_t iX = int32_t(fZoom*rFacets.fctBegin.Wdt), w=int32_t(fZoom*rFacets.fctMiddle.Wdt), wOld=rFacets.fctMiddle.Wdt;
             int32_t iRightShowLength = rFacets.fctEnd.Wdt/3;
             rFacets.fctBegin.DrawX(cgo.Surface, x0,y0,int32_t(fZoom*rFacets.fctBegin.Wdt),rcBounds.Hgt);
             while (iX < rcBounds.Wdt-(fZoom*iRightShowLength))
             {
                 int32_t w2=std::min<int32_t>(w, rcBounds.Wdt-int32_t(fZoom*iRightShowLength)-iX); rFacets.fctMiddle.Wdt=long(float(w2)/fZoom);
                 rFacets.fctMiddle.DrawX(cgo.Surface, x0+iX, y0, w2,rcBounds.Hgt);
                 iX += w;
             }
             rFacets.fctMiddle.Wdt=wOld;
             rFacets.fctEnd.DrawX(cgo.Surface, x0+rcBounds.Wdt-int32_t(fZoom*rFacets.fctEnd.Wdt), y0,int32_t(fZoom*rFacets.fctEnd.Wdt),rcBounds.Hgt);
         }
     }

References C4Facet::Draw(), C4Facet::DrawX(), C4GUI::DynBarFacet::fctBegin, C4GUI::DynBarFacet::fctEnd, C4GUI::DynBarFacet::fctMiddle, C4Facet::Hgt, C4Rect::Hgt, C4GUI::Element::rcBounds, C4Facet::Surface, C4TargetFacet::TargetX, C4TargetFacet::TargetY, C4Facet::Wdt, C4Rect::Wdt, C4Facet::X, C4Rect::x, and C4Rect::y.

Referenced by C4GUI::WoodenLabel::DrawElement(), and C4GUI::Button::DrawElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DrawChildren()

bool C4ScriptGuiWindow::DrawChildren	(	C4TargetFacet &	cgo,
		int32_t	player,
		int32_t	withMultipleFlag = `-1`,
		C4Rect *	currentClippingRect = `nullptr`
	)

Definition at line 1573 of file C4ScriptGuiWindow.cpp.

 {
     // remember old target rectangle and adjust
     float oldTargetX = cgo.TargetX;
     float oldTargetY = cgo.TargetY;
     C4Rect myClippingRect;
     if (IsRoot())
     {
         cgo.TargetX = 0;
         cgo.TargetY = 0;
         pDraw->StorePrimaryClipper();
         // default: full screen clipper
         myClippingRect = C4Rect(0, 0, cgo.Wdt * cgo.Zoom, cgo.Hgt * cgo.Zoom);
         currentClippingRect = &myClippingRect;
     }
  
     // if ANY PARENT has scroll bar, then adjust clipper
     int32_t clipX1(0), clipX2(0), clipY1(0), clipY2(0);
     bool clipping = GetClippingRect(clipX1, clipY1, clipX2, clipY2);
     
     const int32_t targetClipX1 = cgo.X + cgo.TargetX + clipX1;
     const int32_t targetClipY1 = cgo.Y + cgo.TargetY + clipY1;
     const int32_t targetClipX2 = cgo.X + cgo.TargetX + clipX2;
     const int32_t targetClipY2 = cgo.Y + cgo.TargetY + clipY2;
  
     if (clipping)
     {
         // Take either the parent rectangle or restrict it additionally by the child's geometry.
         myClippingRect = C4Rect(
             std::max(currentClippingRect->x, targetClipX1),
             std::max(currentClippingRect->y, targetClipY1),
             std::min(currentClippingRect->Wdt, targetClipX2),
             std::min(currentClippingRect->Hgt, targetClipY2));
         currentClippingRect = &myClippingRect;
     }
  
     if (withMultipleFlag != 1)
     {
         cgo.TargetX += rcBounds.x;
         cgo.TargetY += rcBounds.y - iScrollY;
     }
     else
     {
         assert(IsRoot());
         assert(withMultipleFlag == 1);
     }
  
  
     // note that withMultipleFlag only plays a roll for the root-menu
     bool oneDrawn = false; // was at least one child drawn?
     //for (auto iter = rbegin(); iter != rend(); ++iter)
     for (auto element : *this)
     {
         C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(element);
  
         if (withMultipleFlag != -1)
         {
             const int32_t &style = child->props[C4ScriptGuiWindowPropertyName::style].GetInt();
             if ((withMultipleFlag == 0) && (style & C4ScriptGuiWindowStyleFlag::Multiple)) continue;
             if ((withMultipleFlag == 1) && !(style & C4ScriptGuiWindowStyleFlag::Multiple)) continue;
         }
         
         pDraw->SetPrimaryClipper(currentClippingRect->x, currentClippingRect->y, currentClippingRect->Wdt, currentClippingRect->Hgt);
  
         if (child->Draw(cgo, player, currentClippingRect))
             oneDrawn = true;
         // draw only one window when drawing non-Multiple windows
         if (oneDrawn && (withMultipleFlag == 0)) break;
     }
  
     // Scrolling obviously does not affect the scroll bar.
     cgo.TargetY += iScrollY;
     // The scroll bar does not correct for the cgo offset (i.e. the upper board).
     cgo.TargetX += cgo.X;
     cgo.TargetY += cgo.Y;
  
     if (pScrollBar->IsVisible())
         pScrollBar->DrawElement(cgo);
     
     if (IsRoot())
     {
         pDraw->RestorePrimaryClipper();
     }
  
     // restore target rectangle
     cgo.TargetX = oldTargetX;
     cgo.TargetY = oldTargetY;
     return oneDrawn;
 }

References Draw(), C4GUI::ScrollBar::DrawElement(), GetClippingRect(), C4ScriptGuiWindowProperty::GetInt(), C4Facet::Hgt, C4Rect::Hgt, C4GUI::ScrollWindow::iScrollY, C4GUI::Element::IsVisible(), C4ScriptGuiWindowStyleFlag::Multiple, pDraw, C4ScriptGuiWindowPropertyName::player, C4GUI::ScrollWindow::pScrollBar, C4GUI::Element::rcBounds, C4Draw::RestorePrimaryClipper(), C4Draw::SetPrimaryClipper(), C4Draw::StorePrimaryClipper(), C4ScriptGuiWindowPropertyName::style, C4TargetFacet::TargetX, C4TargetFacet::TargetY, C4Facet::Wdt, C4Rect::Wdt, C4Facet::X, C4Rect::x, C4Facet::Y, C4Rect::y, and C4TargetFacet::Zoom.

Referenced by Draw(), and DrawAll().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DrawElement()

virtual void C4GUI::Element::DrawElement ( C4TargetFacet & cgo )

inlineprotectedvirtualinherited

Reimplemented in C4Chart, C4StartupScenSelDlg, C4StartupPlrPropertiesDlg, C4StartupPlrSelDlg, C4StartupNetDlg, C4StartupNetListEntry, C4StartupMainDlg, C4StartupAboutDlg, C4ScoreboardDlg, C4Menu, C4MenuItem, C4GUI::FullscreenDialog, C4GUI::Dialog, C4GUI::ComboBox, C4GUI::ContextButton, C4GUI::ContextMenu, C4GUI::ContextMenu::Entry, C4GUI::TextWindow, C4GUI::Tabular, C4GUI::ListBox, C4GUI::CheckBox, C4GUI::Edit, C4GUI::FacetButton, C4GUI::ArrowButton, C4GUI::IconButton, C4GUI::Button, C4GUI::PaintBox, C4GUI::GroupBox, C4GUI::ScrollBar, C4GUI::OverlayPicture, C4GUI::Picture, C4GUI::HorizontalLine, C4GUI::ProgressBar, C4GUI::MultilineLabel, C4GUI::WoodenLabel, C4GUI::Label, C4StartupModsDlg, C4StartupModsListEntry, and C4StartupLegalDlg.

Definition at line 388 of file C4Gui.h.

388 { }; // draw element itself

Referenced by C4GUI::Element::Draw(), and C4GUI::Window::Draw().

Here is the caller graph for this function:

◆ DrawHBarByVGfx()

void C4GUI::Element::DrawHBarByVGfx	(	C4TargetFacet &	cgo,
		DynBarFacet &	rFacets
	)

protectedinherited

Definition at line 365 of file C4Gui.cpp.

     {
         C4DrawTransform trf;
         float fOffX = cgo.TargetX + rcBounds.x + rcBounds.Hgt/2;
         float fOffY = cgo.TargetY + rcBounds.y + rcBounds.Hgt/2;
         trf.SetRotate(-90.0f, fOffX, fOffY);
  
         DrawHVBar(cgo, rFacets, trf, rcBounds.Wdt);
     }

References C4GUI::Element::DrawHVBar(), C4Rect::Hgt, C4GUI::Element::rcBounds, C4BltTransform::SetRotate(), C4TargetFacet::TargetX, C4TargetFacet::TargetY, C4Rect::Wdt, C4Rect::x, and C4Rect::y.

Referenced by C4GUI::ScrollBar::DrawElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DrawHVBar()

void C4GUI::Element::DrawHVBar	(	C4TargetFacet &	cgo,
		DynBarFacet &	rFacets,
		C4DrawTransform &	trf,
		int32_t	iMiddleLength
	)

protectedinherited

Definition at line 375 of file C4Gui.cpp.

     {
         int32_t y0 = cgo.TargetY + rcBounds.y;
         int32_t x0 = cgo.TargetX + rcBounds.x;
  
         // draw up arrow
         rFacets.fctBegin.DrawT(cgo.Surface, x0, y0, 0, 0, &trf);
  
         // draw middle part
         int32_t h = rFacets.fctMiddle.Hgt;
         int32_t barHeight = iMiddleLength - (rFacets.fctBegin.Hgt + rFacets.fctEnd.Hgt);
  
         for (int32_t iY = 0; iY <= barHeight; iY += h)
         {
             int32_t h2 = std::min(h, barHeight - iY);
             rFacets.fctMiddle.Hgt = h2;
             rFacets.fctMiddle.DrawT(cgo.Surface, x0, y0 + rFacets.fctBegin.Hgt + iY, 0, 0, &trf);
         }
         rFacets.fctMiddle.Hgt = h;
  
         // draw lower arrow
         rFacets.fctEnd.DrawT(cgo.Surface, x0, y0 + iMiddleLength - rFacets.fctEnd.Hgt, 0, 0, &trf);
     }

References C4Facet::DrawT(), C4GUI::DynBarFacet::fctBegin, C4GUI::DynBarFacet::fctEnd, C4GUI::DynBarFacet::fctMiddle, C4Facet::Hgt, C4GUI::Element::rcBounds, C4Facet::Surface, C4TargetFacet::TargetX, C4TargetFacet::TargetY, C4Rect::x, and C4Rect::y.

Referenced by C4GUI::Element::DrawHBarByVGfx(), and C4GUI::Element::DrawVBar().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DrawVBar()

void C4GUI::Element::DrawVBar	(	C4TargetFacet &	cgo,
		DynBarFacet &	rFacets
	)

protectedinherited

Definition at line 359 of file C4Gui.cpp.

     {
         C4DrawTransform trf(1);
         DrawHVBar(cgo, rFacets, trf, rcBounds.Hgt);
     }

References C4GUI::Element::DrawHVBar(), C4Rect::Hgt, and C4GUI::Element::rcBounds.

Referenced by C4GUI::ScrollBar::DrawElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ElementPosChanged()

void C4GUI::ScrollWindow::ElementPosChanged ( Element * pOfElement )

inlineoverrideprotectedvirtualinherited

Reimplemented from C4GUI::Container.

Definition at line 954 of file C4Gui.h.

         {
             Window::ElementPosChanged(pOfElement);
             if (pParent) pParent->ElementPosChanged(pOfElement);
         }

References C4GUI::Container::ElementPosChanged(), and C4GUI::Element::pParent.

Here is the call graph for this function:

◆ ElementSizeChanged()

void C4GUI::ScrollWindow::ElementSizeChanged ( Element * pOfElement )

inlineoverrideprotectedvirtualinherited

Reimplemented from C4GUI::Container.

Definition at line 949 of file C4Gui.h.

         {
             Window::ElementSizeChanged(pOfElement);
             if (pParent) pParent->ElementSizeChanged(pOfElement);
         }

References C4GUI::Container::ElementSizeChanged(), and C4GUI::Element::pParent.

Here is the call graph for this function:

◆ end()

Iterator C4GUI::Container::end ( )

inlineinherited

Definition at line 825 of file C4Gui.h.

825 { return Iterator(nullptr); }

Referenced by ClearPointers().

Here is the caller graph for this function:

◆ ExecuteCommand()

bool C4ScriptGuiWindow::ExecuteCommand	(	int32_t	actionID,
		int32_t	player,
		int32_t	subwindowID,
		int32_t	actionType,
		C4Object *	target
	)

Definition at line 2295 of file C4ScriptGuiWindow.cpp.

 {
     if (isMainWindow && subwindowID) // we are a main window! try a shortcut through the ID?
     {
         MenuDebugLogF("passing command... instance:%d, plr:%d, subwin:%d, type:%d [I am %d, MW]", actionID, player, subwindowID, actionType, id);
         MenuDebugLogF("stats:");
         MenuDebugLogF("active menus:\t%d", GetElementCount());
         MenuDebugLogF("children ID map:\t%d", childrenIDMap.size());
         // the reasoning for that shortcut is that I assume that usually windows with actions will also have an ID assigned
         // this obviously doesn't have to be the case, but I believe it's worth the try
         std::pair<std::multimap<int32_t, C4ScriptGuiWindow*>::iterator, std::multimap<int32_t, C4ScriptGuiWindow*>::iterator> range;
         range = childrenIDMap.equal_range(subwindowID);
  
         for (std::multimap<int32_t, C4ScriptGuiWindow*>::iterator iter = range.first; iter != range.second; ++iter)
         {
             if (iter->second->ExecuteCommand(actionID, player, subwindowID, actionType, target))
             {
                 MenuDebugLogF("shortcutting command sucessful!");
                 return true;
             }
         }
         // it is not possible that another window would match the criteria. Abort later after self-check
         MenuDebugLogF("shortcutting command failed.. no appropriate window");
     }
  
     // are we elligible?
     if ((id == subwindowID) && (this->target == target))
     {
         MenuDebugLogF("stats: (I am %d)", id);
         MenuDebugLogF("children:\t%d", GetElementCount());
         MenuDebugLogF("all actions:\t%d", props[actionType].GetAllActions().size());
         std::list<C4ScriptGuiWindowAction*> allActions = props[actionType].GetAllActions();
         for (auto action : allActions)
         {
             assert(action && "C4ScriptGuiWindowProperty::GetAllActions returned list with null-pointer");
  
             if (action->ExecuteCommand(actionID, this, player))
             {
                 MenuDebugLogF("executing command sucessful!");
                 return true;
             }
         }
  
         // note that we should not simply return false here
         // there is no guarantee that only one window with that target&ID exists
     }
  
     // not caught, forward to children!
     // abort if main window, though. See above
     if (isMainWindow && subwindowID)
     {
         MenuDebugLogF("executing command failed!");
         return false;
     }
  
     // otherwise, just pass to children..
     for (C4GUI::Element *element : *this)
     {
         C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(element);
         if (child->ExecuteCommand(actionID, player, subwindowID, actionType, target))
         {
             MenuDebugLogF("passing command sucessful! (I am %d - &p)", id, this->target);
             return true;
         }
     }
     return false;
 }

References ExecuteCommand(), C4ScriptGuiWindowProperty::GetAllActions(), C4GUI::Container::GetElementCount(), MenuDebugLogF, and C4ScriptGuiWindowPropertyName::player.

Referenced by ExecuteCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Freeze()

void C4GUI::ScrollWindow::Freeze ( )

inlineinherited

Definition at line 969 of file C4Gui.h.

969 { ++iFrozen; }

C4GUI::ScrollWindow::iFrozen

int32_t iFrozen

Definition: C4Gui.h:946

References C4GUI::ScrollWindow::iFrozen.

Referenced by C4GUI::ListBox::FreezeScrolling(), and C4Menu::RefillInternal().

Here is the caller graph for this function:

◆ GetBounds()

C4Rect& C4GUI::Element::GetBounds ( )

inlineinherited

Definition at line 445 of file C4Gui.h.

445 { return rcBounds; }

References C4GUI::Element::rcBounds.

Referenced by C4GUI::ListBox::AddElement(), C4Menu::AdjustPosition(), C4GameOverDlg::C4GameOverDlg(), C4StartupModsDlg::C4StartupModsDlg(), C4StartupModsListEntry::C4StartupModsListEntry(), C4StartupNetDlg::C4StartupNetDlg(), C4StartupNetListEntry::C4StartupNetListEntry(), C4StartupScenSelDlg::C4StartupScenSelDlg(), C4GUI::ContextMenu::CheckOpenSubmenu(), C4GUI::ListBox::ContractToElementHeight(), C4MapFolderData::CreateGUIElements(), C4GUI::Screen::DoContext(), C4GUI::Window::Draw(), C4GUI::ListBox::DrawElement(), C4GUI::ContextMenu::DrawElement(), C4GUI::TextWindow::ElementPosChanged(), C4GUI::TextWindow::ElementSizeChanged(), C4GUI::Dialog::GetMarginTop(), C4GUI::ScrollBar::GetMaxScroll(), C4GUI::GetScreenHgt(), C4GUI::GetScreenWdt(), C4Menu::InitSize(), C4GUI::ListBox::InsertElement(), C4GUI::ScrollWindow::IsRangeInView(), C4StartupPlrSelDlg::PlayerListItem::Load(), C4GUI::Window::MouseInput(), C4GUI::ScrollBar::MouseInput(), C4GUI::ListBox::MouseInput(), C4GUI::Screen::MouseInput(), C4StartupPlrSelDlg::OnNewBtn(), C4GUI::ScrollBar::OnPosChanged(), C4StartupPlrSelDlg::OnPropertyBtn(), C4StartupScenSelDlg::ScenListItem::ScenListItem(), C4GUI::ScrollWindow::ScrollBy(), C4GUI::ListBox::ScrollItemInView(), C4GUI::ScrollWindow::ScrollPages(), C4GUI::ScrollWindow::ScrollRangeInView(), C4GUI::ScrollWindow::ScrollToBottom(), C4GUI::Tabular::SetGfx(), C4GoalDisplay::SetGoals(), C4GUI::TextWindow::SetPicture(), C4GUI::Dialog::SetTitle(), C4GUI::ScrollBar::Update(), C4GUI::ScrollWindow::Update(), C4StartupPlrSelDlg::PlayerListItem::UpdateCore(), C4GUI::ListBox::UpdateElementPosition(), C4GUI::ListBox::UpdateElementPositions(), C4Menu::UpdateElementPositions(), C4GUI::ScrollWindow::UpdateOwnPos(), C4Menu::UpdateScrollBar(), and C4GUI::TextWindow::UpdateSize().

Here is the caller graph for this function:

◆ GetChildByID()

C4ScriptGuiWindow * C4ScriptGuiWindow::GetChildByID ( int32_t child )

Definition at line 1249 of file C4ScriptGuiWindow.cpp.

 {
     for (Element * element : *this)
     {
         C4ScriptGuiWindow * child = static_cast<C4ScriptGuiWindow*>(element);
         if (child->id != childID) continue;
         return child;
     }
     return nullptr;
 }

References C4GUI::Container::Element.

◆ GetChildByName()

C4ScriptGuiWindow * C4ScriptGuiWindow::GetChildByName ( C4String * childName )

Definition at line 1260 of file C4ScriptGuiWindow.cpp.

 {
     // invalid child names never match
     if (childName == nullptr) return nullptr;
  
     for (Element * element : *this)
     {
         C4ScriptGuiWindow * child = static_cast<C4ScriptGuiWindow*>(element);
         // every C4String is unique, so we can compare pointers here
         if (child->name != childName) continue;
         return child;
     }
     return nullptr;
 }

References C4GUI::Container::Element.

Referenced by CreateFromPropList().

Here is the caller graph for this function:

◆ GetClientRect()

C4Rect& C4GUI::Window::GetClientRect ( )

inlineoverridevirtualinherited

Reimplemented from C4GUI::Element.

Definition at line 864 of file C4Gui.h.

864 { return rcClientRect; }

References C4GUI::Window::rcClientRect.

Referenced by C4GameOverDlg::C4GameOverDlg(), C4LeagueSignupDialog::C4LeagueSignupDialog(), C4StartupMainDlg::C4StartupMainDlg(), C4StartupModsDlg::C4StartupModsDlg(), C4StartupNetDlg::C4StartupNetDlg(), C4StartupOptionsDlg::C4StartupOptionsDlg(), C4StartupPlrColorPickerDlg::C4StartupPlrColorPickerDlg(), C4StartupPlrPropertiesDlg::C4StartupPlrPropertiesDlg(), C4StartupPlrSelDlg::C4StartupPlrSelDlg(), C4StartupScenSelDlg::C4StartupScenSelDlg(), C4GUI::ContextMenu::CheckOpenSubmenu(), C4GUI::ListBox::ContractToElementHeight(), C4MapFolderData::CreateGUIElements(), C4GUI::InfoDialog::CreateSubComponents(), C4GUI::Window::Draw(), C4GUI::ListBox::DrawElement(), C4GUI::ContextMenu::DrawElement(), C4GUI::FullscreenDialog::FullscreenDialog(), C4GUI::ListBox::GetItemWidth(), C4FileSelDlg::InitElements(), C4GUI::InputDialog::InputDialog(), C4GUI::LabeledEdit::LabeledEdit(), C4GameLobby::MainDlg::MainDlg(), C4GUI::MessageDialog::MessageDialog(), C4GUI::Window::MouseInput(), C4GUI::ContextMenu::MouseInput(), C4GUI::Screen::MouseInput(), C4GUI::ScrollBar::OnPosChanged(), C4GUI::ProgressDialog::ProgressDialog(), C4GameLobby::ScenDesc::ScenDesc(), C4StartupScenSelDlg::ScenListItem::ScenListItem(), C4GUI::ScrollWindow::ScrollBy(), C4GUI::ScrollWindow::ScrollRangeInView(), C4GUI::ScrollWindow::ScrollToBottom(), C4GUI::ScrollWindow::ScrollWindow(), C4GoalDisplay::SetGoals(), C4GUI::FullscreenDialog::SetTitle(), C4GUI::TextWindow::TextWindow(), C4GUI::ScrollBar::Update(), C4GUI::ListBox::UpdateColumnCount(), and C4GUI::TextWindow::UpdateSize().

Here is the caller graph for this function:

◆ GetClippingRect()

bool C4ScriptGuiWindow::GetClippingRect	(	int32_t &	left,
		int32_t &	top,
		int32_t &	right,
		int32_t &	bottom
	)

Definition at line 2023 of file C4ScriptGuiWindow.cpp.

 {
     const int32_t &style = props[C4ScriptGuiWindowPropertyName::style].GetInt();
     if (IsRoot() || (style & C4ScriptGuiWindowStyleFlag::NoCrop))
         return false;
  
     // Other windows always clip their children.
     // This implicitly clips childrens' text to the parent size, too.
     left = rcBounds.x;
     top = rcBounds.y;
     right = rcBounds.Wdt + left;
     bottom = rcBounds.Hgt + top;
     return true;
 }

References C4ScriptGuiWindowPropertyName::bottom, C4ScriptGuiWindowProperty::GetInt(), C4Rect::Hgt, C4ScriptGuiWindowPropertyName::left, C4ScriptGuiWindowStyleFlag::NoCrop, C4GUI::Element::rcBounds, C4ScriptGuiWindowPropertyName::right, C4ScriptGuiWindowPropertyName::style, C4ScriptGuiWindowPropertyName::top, C4Rect::Wdt, C4Rect::x, and C4Rect::y.

Referenced by DrawChildren().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetContainedClientRect()

C4Rect C4GUI::Element::GetContainedClientRect ( )

inlineinherited

Definition at line 448 of file C4Gui.h.

448 { C4Rect rc=GetClientRect(); rc.x=rc.y=0; return rc; }

C4GUI::Element::GetClientRect

virtual C4Rect & GetClientRect()

Definition: C4Gui.h:447

References C4GUI::Element::GetClientRect(), C4Rect::x, and C4Rect::y.

Referenced by C4GUI::Tabular::AddSheet(), C4ChartDialog::C4ChartDialog(), C4Network2ClientListDlg::C4Network2ClientListDlg(), C4Network2StartWaitDlg::C4Network2StartWaitDlg(), C4StartupAboutDlg::C4StartupAboutDlg(), C4StartupLegalDlg::C4StartupLegalDlg(), C4StartupModsDlg::C4StartupModsDlg(), C4StartupModsListEntry::C4StartupModsListEntry(), C4StartupNetDlg::C4StartupNetDlg(), C4StartupNetListEntry::C4StartupNetListEntry(), C4FileSelDlg::DefaultListItem::DefaultListItem(), C4ChatDlg::DoPlacement(), C4GUI::Element::GetToprightCornerRect(), C4GUI::InputDialog::InputDialog(), C4GameLobby::MainDlg::MainDlg(), C4GUI::TextWindow::TextWindow(), C4Menu::UpdateElementPositions(), C4ChatControl::ChatSheet::NickItem::UpdateOwnPos(), C4FileSelDlg::DefaultListItem::UpdateOwnPos(), C4GUI::ScrollWindow::UpdateOwnPos(), C4StartupScenSelDlg::ScenListItem::UpdateOwnPos(), C4ChatControl::UpdateSize(), C4ChatDlg::UpdateSize(), C4GUI::Tabular::UpdateSize(), and C4GUI::TextWindow::UpdateSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetContainer()

Container* C4GUI::Container::GetContainer ( )

inlineoverridevirtualinherited

Reimplemented from C4GUI::Element.

Definition at line 831 of file C4Gui.h.

831 { return this; } // returns parent for elements; this for containers

◆ GetContextHandler()

ContextHandler * C4GUI::Element::GetContextHandler ( )

virtualinherited

Reimplemented in C4GUI::Dialog.

Definition at line 429 of file C4Gui.cpp.

     {
         // fallback to parent context, if own is not assigned
         return (!pParent || pContextHandler) ? pContextHandler : pParent->GetContextHandler();
     }

References C4GUI::Element::GetContextHandler(), C4GUI::Element::pContextHandler, and C4GUI::Element::pParent.

Referenced by C4GUI::ContextButton::ContextButton(), C4GUI::Element::GetContextHandler(), and C4GUI::Element::MouseInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDialogWindow()

virtual class DialogWindow* C4GUI::Element::GetDialogWindow ( )

inlineprotectedvirtualinherited

Reimplemented in C4GUI::Dialog.

Definition at line 404 of file C4Gui.h.

404 { return nullptr; } // return DialogWindow if this element is a dialog

◆ GetDlg()

Dialog * C4GUI::Element::GetDlg ( )

virtualinherited

Reimplemented in C4GUI::Dialog.

Definition at line 288 of file C4Gui.cpp.

288 { if (pParent) return pParent->GetDlg (); return nullptr; }

C4GUI::Element::GetDlg

virtual class Dialog * GetDlg()

Definition: C4Gui.cpp:288

References C4GUI::Element::GetDlg(), and C4GUI::Element::pParent.

Referenced by C4GUI::Control::DisableFocus(), C4ChatControl::DlgEnter(), C4ChatControl::GetDefaultControl(), C4GUI::Element::GetDlg(), C4GUI::ContextMenu::GetTargetDialog(), C4GUI::Control::HasDrawFocus(), C4GUI::Element::IsInActiveDlg(), C4GUI::Label::MouseInput(), C4GUI::Control::MouseInput(), C4GUI::Screen::MouseInput(), C4ChatControl::OnConnectBtn(), C4GUI::RenameEdit::OnFinishInput(), C4GUI::Label::OnHotkey(), C4ChatControl::OnLoginDataEnter(), C4GUI::CloseButton::OnPress(), C4GUI::CloseIconButton::OnPress(), C4GUI::RenameEdit::RenameEdit(), C4GUI::Container::SetVisibility(), and C4GUI::Screen::ShowDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetElementByIndex()

Element * C4GUI::Container::GetElementByIndex ( int32_t i )

inherited

Definition at line 223 of file C4GuiContainers.cpp.

     {
         // get next until end of list or queried index is reached
         // if i is negative or equal or larger than childcount, the loop will never break and nullptr returned
         Element *pEl;
         for (pEl = pFirst; i-- && pEl; pEl=pEl->pNext) {}
         return pEl;
     }

References C4GUI::Container::pFirst, and C4GUI::Element::pNext.

Referenced by C4GUI::ContextMenu::GetIndexedEntry(), C4Menu::GetItem(), C4GUI::Tabular::GetSheet(), and C4GUI::ContextMenu::SelectItem().

Here is the caller graph for this function:

◆ GetElementCount()

int32_t C4GUI::Container::GetElementCount ( )

inherited

Definition at line 232 of file C4GuiContainers.cpp.

     {
         int32_t cnt=0;
         for (Element *pEl = pFirst; pEl; pEl=pEl->pNext) ++cnt;
         return cnt;
     }

References C4GUI::Container::pFirst, and C4GUI::Element::pNext.

Referenced by ExecuteCommand(), C4GUI::Tabular::GetSheetCount(), and C4GUI::ListBox::SortElements().

Here is the caller graph for this function:

◆ GetFirst()

Element* C4GUI::Container::GetFirst ( )

inlineinherited

Definition at line 829 of file C4Gui.h.

829 { return pFirst; }

References C4GUI::Container::pFirst.

Referenced by C4MapFolderData::CreateGUIElements(), C4GUI::ListBox::DrawElement(), C4GUI::Tabular::DrawElement(), C4GUI::ListBox::GetFirst(), C4GUI::Screen::GetFullscreenDialog(), C4GUI::Screen::GetMouseControlledDialogCount(), C4GUI::ListBox::MouseInput(), C4GUI::Tabular::MouseInput(), C4GUI::ContextMenu::MouseInput(), C4GUI::Tabular::MouseLeaveCaptionArea(), C4GUI::Tabular::RemoveElement(), C4GUI::Screen::ShowDialog(), C4GUI::ListBox::SortElements(), C4GameOptionsList::Update(), C4Network2ResDlg::Update(), C4Network2ClientListBox::Update(), C4GUI::ListBox::UpdateElementPositions(), C4Menu::UpdateElementPositions(), and C4GUI::Tabular::UpdateSize().

Here is the caller graph for this function:

◆ GetFirstContained()

Element* C4GUI::Container::GetFirstContained ( )

inlineoverridevirtualinherited

Reimplemented from C4GUI::Element.

Definition at line 773 of file C4Gui.h.

773 { return pFirst; }

References C4GUI::Container::pFirst.

Referenced by C4GUI::ListBox::OnGetFocus().

Here is the caller graph for this function:

◆ GetFirstNestedElement()

Element * C4GUI::Container::GetFirstNestedElement ( bool fBackwards )

overridevirtualinherited

Reimplemented from C4GUI::Element.

Definition at line 204 of file C4GuiContainers.cpp.

     {
         // get first/last in own list
         if (pFirst) return (fBackwards ? pLast : pFirst)->GetFirstNestedElement(fBackwards);
         // no own list: return this one
         return this;
     }

References C4GUI::Element::GetFirstNestedElement(), C4GUI::Container::pFirst, and C4GUI::Container::pLast.

Referenced by C4GUI::Container::GetNextNestedElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHeight()

int32_t C4GUI::Element::GetHeight ( )

inlineinherited

Definition at line 444 of file C4Gui.h.

444 { return rcBounds.Hgt; }

References C4Rect::Hgt, and C4GUI::Element::rcBounds.

Referenced by C4GUI::Screen::ShowDialog().

Here is the caller graph for this function:

◆ GetID()

int32_t C4ScriptGuiWindow::GetID ( )

inline

Definition at line 262 of file C4ScriptGuiWindow.h.

262 { return id; }

Referenced by C4ScriptGuiWindowAction::Execute(), C4ScriptGuiWindowAction::ExecuteCommand(), and RemoveChild().

Here is the caller graph for this function:

◆ GetLast()

Element* C4GUI::Container::GetLast ( )

inlineinherited

Definition at line 830 of file C4Gui.h.

830 { return pLast; }

References C4GUI::Container::pLast.

Referenced by C4GUI::ListBox::GetLast(), C4Menu::InitSize(), and C4Menu::UpdateScrollBar().

Here is the caller graph for this function:

◆ GetLastContained()

virtual Element* C4GUI::Container::GetLastContained ( )

inlinevirtualinherited

Definition at line 774 of file C4Gui.h.

774 { return pLast; }

References C4GUI::Container::pLast.

◆ GetListItemTopSpacing()

virtual int32_t C4GUI::Element::GetListItemTopSpacing ( )

inlinevirtualinherited

Reimplemented in C4StartupNetListEntry, and C4StartupModsListEntry.

Definition at line 461 of file C4Gui.h.

461 { return C4GUI_DefaultListSpacing; }

C4GUI_DefaultListSpacing

#define C4GUI_DefaultListSpacing

Definition: C4Gui.h:123

References C4GUI_DefaultListSpacing.

Referenced by C4GUI::ListBox::AddElement(), C4GUI::ListBox::DrawElement(), and C4GUI::ListBox::UpdateElementPositions().

Here is the caller graph for this function:

◆ GetListItemTopSpacingBar()

virtual bool C4GUI::Element::GetListItemTopSpacingBar ( )

inlinevirtualinherited

Definition at line 462 of file C4Gui.h.

462 { return false; }

Referenced by C4GUI::ListBox::DrawElement().

Here is the caller graph for this function:

◆ GetMarginBottom()

virtual int32_t C4GUI::Window::GetMarginBottom ( )

inlinevirtualinherited

Reimplemented in C4StartupPlrPropertiesDlg, C4Menu, C4GUI::FullscreenDialog, C4GUI::Dialog, C4GUI::ContextMenu, C4GUI::TextWindow, C4GUI::Tabular, C4GUI::ListBox, C4GUI::Edit, and C4GUI::GroupBox.

Definition at line 876 of file C4Gui.h.

876 { return 0; }

Referenced by C4GUI::Dialog::GetMarginBottom(), C4Menu::InitSize(), C4GoalDisplay::SetGoals(), and C4GUI::Window::UpdateOwnPos().

Here is the caller graph for this function:

◆ GetMarginLeft()

virtual int32_t C4GUI::Window::GetMarginLeft ( )

inlinevirtualinherited

Reimplemented in C4StartupPlrPropertiesDlg, C4Menu, C4GUI::FullscreenDialog, C4GUI::Dialog, C4GUI::ContextMenu, C4GUI::TextWindow, C4GUI::Tabular, C4GUI::ListBox, C4GUI::Edit, and C4GUI::GroupBox.

Definition at line 874 of file C4Gui.h.

874 { return 0; }

Referenced by C4GUI::Dialog::GetMarginLeft(), C4Menu::InitSize(), and C4GUI::Window::UpdateOwnPos().

Here is the caller graph for this function:

◆ GetMarginRight()

virtual int32_t C4GUI::Window::GetMarginRight ( )

inlinevirtualinherited

Reimplemented in C4StartupPlrPropertiesDlg, C4Menu, C4GUI::FullscreenDialog, C4GUI::Dialog, C4GUI::ContextMenu, C4GUI::TextWindow, C4GUI::Tabular, C4GUI::ListBox, C4GUI::Edit, and C4GUI::GroupBox.

Definition at line 875 of file C4Gui.h.

875 { return 0; }

Referenced by C4GUI::Dialog::GetMarginRight(), C4Menu::InitSize(), and C4GUI::Window::UpdateOwnPos().

Here is the caller graph for this function:

◆ GetMarginTop()

virtual int32_t C4GUI::Window::GetMarginTop ( )

inlinevirtualinherited

Reimplemented in C4StartupScenSelDlg, C4StartupPlrPropertiesDlg, C4StartupPlrSelDlg, C4GUI::FullscreenDialog, C4GUI::Dialog, C4GUI::ContextMenu, C4GUI::TextWindow, C4GUI::Tabular, C4GUI::ListBox, C4GUI::Edit, and C4GUI::GroupBox.

Definition at line 873 of file C4Gui.h.

873 { return 0; }

Referenced by C4GUI::Dialog::GetMarginTop(), C4Menu::InitSize(), C4GoalDisplay::SetGoals(), and C4GUI::Window::UpdateOwnPos().

Here is the caller graph for this function:

◆ GetNext()

Element* C4GUI::Element::GetNext ( ) const

inlineinherited

Definition at line 449 of file C4Gui.h.

449 { return pNext; }

References C4GUI::Element::pNext.

Referenced by C4GUI::Screen::ActivateDialog(), C4GUI::ListBox::CharIn(), C4GUI::ListBox::DrawElement(), C4GUI::Tabular::DrawElement(), C4GUI::Screen::GetFullscreenDialog(), C4GUI::Screen::GetMouseControlledDialogCount(), C4StartupScenSelDlg::ScenListItem::GetNext(), C4StartupNetListEntry::GetNextLower(), C4GUI::ListBox::MouseInput(), C4GUI::Tabular::MouseInput(), C4GUI::ContextMenu::MouseInput(), C4GUI::Tabular::MouseLeaveCaptionArea(), C4StartupPlrSelDlg::OnItemCheckChange(), C4GUI::Container::Iterator::operator++(), C4GUI::Screen::ShowDialog(), C4GUI::ListBox::SortElements(), C4GUI::ListBox::UpdateElementPositions(), and C4Menu::UpdateElementPositions().

Here is the caller graph for this function:

◆ GetNextNestedElement()

Element * C4GUI::Container::GetNextNestedElement	(	Element *	pPrevElement,
		bool	fBackwards
	)

inherited

Definition at line 171 of file C4GuiContainers.cpp.

     {
         if (fBackwards)
         {
             // this is last
             if (pPrevElement == this) return nullptr;
             // no previous given?
             if (!pPrevElement)
                 // then use last nested for backwards search
                 return GetFirstNestedElement(true);
             // get nested, previous element if present
             if (pPrevElement->pPrev) return pPrevElement->pPrev->GetFirstNestedElement(true);
             // if not, return parent (could be this)
             return pPrevElement->pParent;
         }
         else
         {
             // forward search: first element is this
             if (!pPrevElement) return this;
             // check next nested
             Element *pEl;
             if ((pEl = pPrevElement->GetFirstContained())) return pEl;
             // check next in list, going upwards until this container is reached
             while (pPrevElement && pPrevElement != this)
             {
                 if ((pEl = pPrevElement->pNext)) return pEl;
                 pPrevElement = pPrevElement->pParent;
             }
             // nothing found
         }
         return nullptr;
     }

References C4GUI::Element::GetFirstContained(), C4GUI::Element::GetFirstNestedElement(), C4GUI::Container::GetFirstNestedElement(), C4GUI::Element::pNext, C4GUI::Element::pParent, and C4GUI::Element::pPrev.

Referenced by C4GUI::Dialog::AdvanceFocus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetOwnToolTip()

const char* C4GUI::Element::GetOwnToolTip ( )

inlineinherited

Definition at line 440 of file C4Gui.h.

440 { return ToolTip.getData(); } // return tooltip const char*, without fallback to parent

References StdStrBuf::getData().

Here is the call graph for this function:

◆ GetParent()

Container* C4GUI::Element::GetParent ( )

inlineinherited

Definition at line 429 of file C4Gui.h.

429 { return pParent; } // get owning container

References C4GUI::Element::pParent.

Referenced by C4GUI::Dialog::AdvanceFocus(), C4GUI::Element::ClientPos2ScreenPos(), Close(), CreateFromPropList(), Draw(), C4GUI::ListBox::ElementPosChanged(), C4GUI::TextWindow::ElementPosChanged(), C4GUI::ListBox::ElementSizeChanged(), C4GUI::TextWindow::ElementSizeChanged(), C4ScriptGuiWindowAction::Execute(), C4ScriptGuiWindowAction::ExecuteCommand(), C4GUI::Tabular::Sheet::IsActiveSheet(), C4GUI::Container::IsParentOf(), C4GUI::ContextMenu::Entry::MouseLeave(), C4StartupPlrSelDlg::OnItemCheckChange(), C4GUI::RenameEdit::RenameEdit(), RequestLayoutUpdate(), C4GUI::Element::ScreenPos2ClientPos(), C4GUI::ListBox::SelectEntry(), C4GUI::Tabular::Sheet::SetTitle(), C4GUI::ScrollWindow::UpdateOwnPos(), and C4ChatControl::UpdateSize().

Here is the caller graph for this function:

◆ GetPrev()

Element* C4GUI::Element::GetPrev ( ) const

inlineinherited

Definition at line 450 of file C4Gui.h.

450 { return pPrev; }

References C4GUI::Element::pPrev.

Referenced by C4GUI::ListBox::AddElement(), C4GUI::Screen::GetDialog(), C4GUI::Screen::GetTopDialog(), C4GUI::Window::MouseInput(), C4GUI::Screen::MouseInput(), and C4GUI::Container::ReverseIterator::operator++().

Here is the caller graph for this function:

◆ GetScreen()

Screen * C4GUI::Element::GetScreen ( )

virtualinherited

Reimplemented in C4GUI::Screen, and C4GUI::ContextMenu.

Definition at line 289 of file C4Gui.cpp.

289 { if (pParent) return pParent->GetScreen(); return nullptr; }

C4GUI::Element::GetScreen

virtual Screen * GetScreen()

Definition: C4Gui.cpp:289

References C4GUI::Element::GetScreen(), and C4GUI::Element::pParent.

Referenced by C4GUI::Dialog::Close(), C4StartupScenSelDlg::DoOK(), C4GUI::Dialog::Draw(), C4GUI::ContextButton::DrawElement(), C4GUI::ComboBox::DrawElement(), C4GUI::Dialog::FadeOut(), C4GUI::Element::GetScreen(), C4GUI::Control::HasDrawFocus(), C4GUI::Dialog::IsActive(), C4StartupScenSelDlg::KeyDelete(), C4GUI::ComboBox::MouseInput(), C4GameOptionButtons::OnBtnComment(), C4GameOptionButtons::OnBtnPassword(), C4StartupPlrPropertiesDlg::OnClosed(), C4StartupPlrPropertiesDlg::OnClrChangeCustom(), C4ChatControl::OnConnectBtn(), C4GUI::CBContextHandler< CBClass >::OnContext(), C4StartupPlrSelDlg::OnDelBtn(), C4StartupPlrSelDlg::OnDelBtnConfirm(), C4StartupPlrSelDlg::OnNewBtn(), C4StartupPlrPropertiesDlg::OnPictureBtn(), C4StartupPlrSelDlg::OnPropertyBtn(), C4StartupMainDlg::OnShown(), C4StartupMainDlg::OnTODO(), C4StartupOptionsDlg::SaveConfig(), C4GUI::Element::SetVisibility(), C4GameLobby::MainDlg::Start(), C4StartupScenSelDlg::StartScenario(), C4ScoreboardDlg::Update(), C4StartupPlrSelDlg::PlayerListItem::UpdateCore(), C4FileSelDlg::UserClose(), C4StartupPlrPropertiesDlg::UserClose(), and C4ChatControl::UserQueryQuit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetScrollY()

int32_t C4GUI::ScrollWindow::GetScrollY ( )

inlineinherited

Definition at line 987 of file C4Gui.h.

987 { return iScrollY; }

References C4GUI::ScrollWindow::iScrollY.

Referenced by Draw(), C4GUI::TextWindow::GetScrollPos(), and C4GUI::ListBox::MouseInput().

Here is the caller graph for this function:

◆ GetSubWindow()

C4ScriptGuiWindow * C4ScriptGuiWindow::GetSubWindow	(	int32_t	childID,
		C4Object *	childTarget
	)

Definition at line 1275 of file C4ScriptGuiWindow.cpp.

 {
     std::pair<std::multimap<int32_t, C4ScriptGuiWindow*>::iterator, std::multimap<int32_t, C4ScriptGuiWindow*>::iterator> range;
     range = childrenIDMap.equal_range(childID);
  
     for (std::multimap<int32_t, C4ScriptGuiWindow*>::iterator iter = range.first; iter != range.second; ++iter)
     {
         C4ScriptGuiWindow *subwindow = iter->second;
         if (subwindow->GetTarget() != childTarget) continue;
         return subwindow;
     }
     return nullptr;
 }

◆ GetToolTip()

const char * C4GUI::Element::GetToolTip ( )

inherited

Definition at line 423 of file C4Gui.cpp.

     {
         // fallback to parent tooltip, if own is not assigned
         return (!pParent || !ToolTip.isNull()) ? ToolTip.getData() : pParent->GetToolTip();
     }

References StdStrBuf::getData(), C4GUI::Element::GetToolTip(), StdStrBuf::isNull(), and C4GUI::Element::pParent.

Referenced by C4GUI::CMouse::Draw(), C4GUI::Element::GetToolTip(), C4GameLobby::MainDlg::OnRightTabContext(), and C4GameLobby::MainDlg::UpdateRightTab().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetToprightCornerRect()

C4Rect C4GUI::Element::GetToprightCornerRect	(	int32_t	iWidth = `16`,
		int32_t	iHeight = `16`,
		int32_t	iHIndent = `4`,
		int32_t	iVIndent = `4`,
		int32_t	iIndexX = `0`
	)

inherited

Definition at line 399 of file C4Gui.cpp.

     {
         // bounds by topright corner of element
         C4Rect rtBounds = (GetContainer() != this) ? GetClientRect() : GetContainedClientRect();
         rtBounds.x += rtBounds.Wdt - (iWidth + iHIndent) * (iIndexX + 1);
         rtBounds.y += iVIndent;
         rtBounds.Wdt = rtBounds.Hgt = iHeight;
         return rtBounds;
     }

References C4GUI::Element::GetClientRect(), C4GUI::Element::GetContainedClientRect(), C4GUI::Element::GetContainer(), C4Rect::Hgt, C4Rect::Wdt, C4Rect::x, and C4Rect::y.

Referenced by C4GUI::ContextButton::ContextButton(), C4GameLobby::MainDlg::MainDlg(), C4GUI::Dialog::SetTitle(), and C4GUI::Dialog::UpdateSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetWidth()

int32_t C4GUI::Element::GetWidth ( )

inlineinherited

Definition at line 443 of file C4Gui.h.

443 { return rcBounds.Wdt; }

References C4GUI::Element::rcBounds, and C4Rect::Wdt.

Referenced by C4GUI::Screen::ShowDialog().

Here is the caller graph for this function:

◆ HasMouseFocus()

bool C4ScriptGuiWindow::HasMouseFocus ( )

inline

Definition at line 351 of file C4ScriptGuiWindow.h.

351 { return currentMouseState & MouseState::Focus; }

References currentMouseState.

Referenced by MouseInput(), OnMouseIn(), OnMouseOut(), and ProcessMouseInput().

Here is the caller graph for this function:

◆ InsertElement()

void C4GUI::Container::InsertElement	(	Element *	pChild,
		Element *	pInsertBefore
	)

inherited

Definition at line 150 of file C4GuiContainers.cpp.

     {
         // add?
         if (!pInsertBefore) { AddElement(pChild); return; }
         // safety
         if (!pChild || pInsertBefore->pParent != this) return;
         // remove from any previous container
         if (pChild->pParent) pChild->pParent->RemoveElement(pChild);
         // add before given element
         if ((pChild->pPrev = pInsertBefore->pPrev))
             pInsertBefore->pPrev->pNext = pChild;
         else
             pFirst = pChild;
         pChild->pNext = pInsertBefore; pInsertBefore->pPrev = pChild;
         pChild->pParent = this;
  
         assert(pChild->pNext != pChild);
         assert(pChild->pPrev != pChild);
         assert(pChild->pParent != pChild);
     }

References C4GUI::Container::AddElement(), C4GUI::Container::pFirst, C4GUI::Element::pNext, C4GUI::Element::pParent, C4GUI::Element::pPrev, and C4GUI::Container::RemoveElement().

Referenced by C4GUI::ListBox::InsertElement(), and C4GUI::Screen::ShowDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsComponentOutsideClientArea()

bool C4GUI::ScrollWindow::IsComponentOutsideClientArea ( )

inlineoverridevirtualinherited

Reimplemented from C4GUI::Window.

Definition at line 966 of file C4Gui.h.

966 { return true; } // always clip drawing routine of subcomponents to Bounds

◆ IsExternalDrawDialog()

virtual bool C4GUI::Element::IsExternalDrawDialog ( )

inlineprotectedvirtualinherited

Reimplemented in C4Menu, and C4GUI::Dialog.

Definition at line 402 of file C4Gui.h.

402 { return false; }

◆ IsFocused()

virtual bool C4GUI::Container::IsFocused ( Control * pCtrl )

inlinevirtualinherited

Reimplemented in C4GUI::Dialog, and C4GUI::ListBox.

Definition at line 836 of file C4Gui.h.

836 { return pParent ? pParent->IsFocused(pCtrl) : false; }

C4GUI::Container::IsFocused

virtual bool IsFocused(Control *pCtrl)

Definition: C4Gui.h:836

References C4GUI::Container::IsFocused(), and C4GUI::Element::pParent.

Referenced by C4GUI::Control::HasFocus(), C4GUI::Container::IsFocused(), and C4GUI::ListBox::IsFocused().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsFocusElement()

virtual Control* C4GUI::Element::IsFocusElement ( )

inlinevirtualinherited

Reimplemented in C4GUI::ComboBox, C4GUI::TextWindow, C4GUI::Tabular, C4GUI::ListBox, C4GUI::CheckBox, and C4GUI::Control.

Definition at line 432 of file C4Gui.h.

432 { return nullptr; }; // return control to gain focus in search-cycle

Referenced by C4GUI::Dialog::AdvanceFocus().

Here is the caller graph for this function:

◆ IsFrozen()

bool C4GUI::ScrollWindow::IsFrozen ( ) const

inlineinherited

Definition at line 971 of file C4Gui.h.

971 { return !!iFrozen; }

References C4GUI::ScrollWindow::iFrozen.

◆ IsImmediateToolTip()

bool C4GUI::Element::IsImmediateToolTip ( ) const

inlineinherited

Definition at line 441 of file C4Gui.h.

441 { return is_immediate_tooltip; }

Referenced by C4GUI::CMouse::Draw().

Here is the caller graph for this function:

◆ IsInActiveDlg()

bool C4GUI::Element::IsInActiveDlg ( bool fForKeyboard )

inherited

Definition at line 435 of file C4Gui.cpp.

     {
         // get dlg
         Dialog *pDlg=GetDlg();
         if (!pDlg) return false;
         // check if dlg is active
         return pDlg->IsActive(fForKeyboard);
     }

References C4GUI::Element::GetDlg(), and C4GUI::Dialog::IsActive().

Referenced by C4GUI::ControlKeyDlgCB< TargetClass >::CheckCondition(), C4GUI::Button::DrawElement(), C4GUI::IconButton::DrawElement(), C4GUI::ArrowButton::DrawElement(), C4GUI::FacetButton::DrawElement(), C4GUI::CheckBox::DrawElement(), and C4GUI::ContextButton::DrawElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsMenu()

virtual bool C4GUI::Element::IsMenu ( )

inlineprotectedvirtualinherited

Reimplemented in C4GUI::ContextMenu, and C4GUI::ContextMenu::Entry.

Definition at line 403 of file C4Gui.h.

403 { return false; }

Referenced by C4GUI::Element::RemoveElement().

Here is the caller graph for this function:

◆ IsOwnPtrElement()

virtual bool C4GUI::Element::IsOwnPtrElement ( )

inlineprotectedvirtualinherited

Reimplemented in C4Menu.

Definition at line 401 of file C4Gui.h.

401 { return false; } // if true is returned, item will not be deleted when container is cleared

Referenced by C4GUI::Container::ClearChildren().

Here is the caller graph for this function:

◆ IsParentOf()

bool C4GUI::Container::IsParentOf ( Element * pEl )

overridevirtualinherited

Reimplemented from C4GUI::Element.

Definition at line 239 of file C4GuiContainers.cpp.

     {
         // return whether this is the parent container (directly or recursively) of the passed element
         for (Container *pC = pEl->GetParent(); pC; pC = pC->GetParent())
             if (pC == this) return true;
         return false;
     }

References C4GUI::Element::GetParent().

Referenced by C4GUI::Control::MouseInput(), and C4GUI::Container::SetVisibility().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsRangeInView()

bool C4GUI::ScrollWindow::IsRangeInView	(	int32_t	iY,
		int32_t	iHgt
	)

inherited

Definition at line 605 of file C4GuiContainers.cpp.

     {
         // returns whether scrolling range is in view
         // check top
         if (iScrollY > iY) return false;
         // check height
         return iScrollY + GetBounds().Hgt >= iY+iHgt;
     }

References C4GUI::Element::GetBounds(), C4Rect::Hgt, and C4GUI::ScrollWindow::iScrollY.

Here is the call graph for this function:

◆ IsScrollBarEnabled()

bool C4GUI::ScrollWindow::IsScrollBarEnabled ( )

inlineinherited

Definition at line 990 of file C4Gui.h.

990 { return fHasBar; }

C4GUI::ScrollWindow::fHasBar

bool fHasBar

Definition: C4Gui.h:945

References C4GUI::ScrollWindow::fHasBar.

Referenced by C4Menu::UpdateScrollBar().

Here is the caller graph for this function:

◆ IsScrollingActive()

bool C4GUI::ScrollWindow::IsScrollingActive ( )

inlineinherited

Definition at line 992 of file C4Gui.h.

992 { return fHasBar && pScrollBar && pScrollBar->IsScrolling(); }

C4GUI::ScrollBar::IsScrolling

bool IsScrolling()

Definition: C4Gui.h:916

References C4GUI::ScrollWindow::fHasBar, C4GUI::ScrollBar::IsScrolling(), and C4GUI::ScrollWindow::pScrollBar.

Referenced by C4GUI::ListBox::IsScrollingActive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsScrollingNecessary()

bool C4GUI::ScrollWindow::IsScrollingNecessary ( )

inlineinherited

Definition at line 993 of file C4Gui.h.

993 { return iClientHeight > rcBounds.Hgt; }

C4GUI::ScrollWindow::iClientHeight

int32_t iClientHeight

Definition: C4Gui.h:944

References C4Rect::Hgt, C4GUI::ScrollWindow::iClientHeight, and C4GUI::Element::rcBounds.

Referenced by C4GUI::ListBox::IsScrollingNecessary(), and UpdateLayout().

Here is the caller graph for this function:

◆ IsSelectedChild()

virtual bool C4GUI::Container::IsSelectedChild ( Element * pChild )

inlinevirtualinherited

Reimplemented in C4GUI::Tabular, and C4GUI::ListBox.

Definition at line 837 of file C4Gui.h.

837 { return pParent ? pParent->IsSelectedChild(pChild) : true; } // whether the child element is selected - only false for list-box-containers which can have unselected children

C4GUI::Container::IsSelectedChild

virtual bool IsSelectedChild(Element *pChild)

Definition: C4Gui.h:837

References C4GUI::Container::IsSelectedChild(), and C4GUI::Element::pParent.

Referenced by C4GUI::Dialog::AdvanceFocus(), C4StartupNetListEntry::DrawElement(), and C4GUI::Container::IsSelectedChild().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsVisible()

bool C4GUI::Element::IsVisible ( )

inherited

Definition at line 201 of file C4Gui.cpp.

     {
         // self and parent must be visible
         return fVisible && (!pParent || pParent->IsVisible());
     }

References C4GUI::Element::fVisible, C4GUI::Element::IsVisible(), and C4GUI::Element::pParent.

Referenced by C4GUI::Dialog::AdvanceFocus(), C4GUI::Screen::CharIn(), C4GUI::ControlKeyDlgCB< TargetClass >::CheckCondition(), C4GUI::Container::Draw(), C4GUI::Window::Draw(), C4GUI::Screen::Draw(), Draw(), DrawAll(), DrawChildren(), C4ChatControl::GetDefaultControl(), C4GUI::Screen::GetFullscreenDialog(), C4GUI::Element::IsVisible(), IsVisibleTo(), C4GUI::Window::MouseInput(), C4GUI::Control::MouseInput(), C4GUI::Screen::MouseInput(), C4GUI::Container::OnHotkey(), ProcessMouseInput(), C4Menu::SetPosition(), C4Menu::UpdateElementPositions(), and C4GUI::TextWindow::UpdateSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsVisibleTo()

bool C4ScriptGuiWindow::IsVisibleTo ( int32_t player )

Definition at line 2368 of file C4ScriptGuiWindow.cpp.

 {
     // Not visible at all?
     if (!IsVisible()) return false;
     // We have a player assigned and it's a different one?
     const int32_t &myPlayer = props[C4ScriptGuiWindowPropertyName::player].GetInt();
     if (myPlayer != ANY_OWNER && player != myPlayer) return false;
     // We have a target object which is invisible to the player?
     if (target && !target->IsVisible(player, false)) return false;
     // Default to visible!
     return true;
 }

References ANY_OWNER, C4ScriptGuiWindowProperty::GetInt(), C4GUI::Element::IsVisible(), C4Object::IsVisible(), and C4ScriptGuiWindowPropertyName::player.

Referenced by Draw(), MouseInput(), and ProcessMouseInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeLastElement()

void C4GUI::Container::MakeLastElement ( Element * pChild )

inherited

Definition at line 106 of file C4GuiContainers.cpp.

     {
         // must be from same container
         if (pChild->pParent != this) return;
         // unlink from list
         if (pChild->pPrev) pChild->pPrev->pNext = pChild->pNext; else pFirst = pChild->pNext;
         if (pChild->pNext) pChild->pNext->pPrev = pChild->pPrev; else pLast = pChild->pPrev;
         // readd to front of list
         if (pLast) pLast->pNext = pChild; else pFirst = pChild;
         pChild->pPrev = pLast; pChild->pNext = nullptr; pLast = pChild;
     }

References C4GUI::Container::pFirst, C4GUI::Container::pLast, C4GUI::Element::pNext, C4GUI::Element::pParent, and C4GUI::Element::pPrev.

Referenced by C4GUI::Screen::ActivateDialog().

Here is the caller graph for this function:

◆ MouseEnter()

void C4ScriptGuiWindow::MouseEnter ( C4GUI::CMouse & rMouse )

overridevirtual

Reimplemented from C4GUI::Element.

Definition at line 2054 of file C4ScriptGuiWindow.cpp.

 {
     assert(::MouseControl.GetPlayer() != NO_OWNER);
 }

References C4MouseControl::GetPlayer(), MouseControl, and NO_OWNER.

Here is the call graph for this function:

◆ MouseInput() [1/2]

void C4GUI::ScrollWindow::MouseInput	(	CMouse &	rMouse,
		int32_t	iButton,
		int32_t	iX,
		int32_t	iY,
		DWORD	dwKeyParam
	)

overridevirtualinherited

Reimplemented from C4GUI::Window.

Definition at line 644 of file C4GuiContainers.cpp.

     {
         // process wheel: Scroll
         if (iButton == C4MC_Button_Wheel)
         {
             short iDelta = (short)(dwKeyParam >> 16);
             ScrollBy(-iDelta);
             return;
         }
         // other mouse input: inherited (forward to children)
         Window::MouseInput(rMouse, iButton, iX, iY, dwKeyParam);
     }

References C4MC_Button_Wheel, C4GUI::Window::MouseInput(), and C4GUI::ScrollWindow::ScrollBy().

Here is the call graph for this function:

◆ MouseInput() [2/2]

bool C4ScriptGuiWindow::MouseInput	(	int32_t	iButton,
		int32_t	iX,
		int32_t	iY,
		DWORD	dwKeyParam
	)

virtual

Definition at line 2114 of file C4ScriptGuiWindow.cpp.

 {
     // only called on root
     assert(IsRoot());
     // This is only called during a mouse move event, where the MouseControl's player is available.
     const int32_t &player = ::MouseControl.GetPlayer();
     assert(player != NO_OWNER);
     // Only allow one window to catch the mouse input.
     // Do not simply return, however, since other windows might need OnMouseOut().
     bool oneActionAlreadyExecuted = false;
     // non-multiple-windows have a higher priority
     // this is important since they are also drawn on top
     for (int withMultipleFlag = 0; withMultipleFlag <= 1; ++withMultipleFlag)
     {
         for (auto iter = rbegin(); iter != rend(); ++iter)
         {
             C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(*iter);
  
             const int32_t &style = child->props[C4ScriptGuiWindowPropertyName::style].GetInt();
             if ((withMultipleFlag == 0) && (style & C4ScriptGuiWindowStyleFlag::Multiple)) continue;
             if ((withMultipleFlag == 1) && !(style & C4ScriptGuiWindowStyleFlag::Multiple)) continue;
             
             // Do the visibility check first. The child itself won't do it, because we are handling mouse in/out here, too.
             if (!child->IsVisibleTo(player)) continue;
  
             // we are root, we have to adjust the position for the "main" windows that are centered
             int32_t adjustedMouseX = 0, adjustedMouseY = mouseY;
             int32_t offsetX = 0, offsetY = 0;
             if (withMultipleFlag == 0)
             {
                 offsetX = -rcBounds.x;
                 offsetY = -rcBounds.y;
             }
  
             adjustedMouseX = mouseX + offsetX;
             adjustedMouseY = mouseY + offsetY;
  
             int32_t childLeft = child->rcBounds.x;
             int32_t childRight = child->rcBounds.x + child->rcBounds.Wdt;
             int32_t childTop = child->rcBounds.y;
             int32_t childBottom = child->rcBounds.y + child->rcBounds.Hgt;
             
             bool inArea = true;
             if ((adjustedMouseX < childLeft) || (adjustedMouseX > childRight)) inArea = false;
             else if ((adjustedMouseY < childTop) || (adjustedMouseY > childBottom)) inArea = false;
  
             if (!inArea) // notify child if it had mouse focus before
             {
                 if (child->HasMouseFocus())
                     child->OnMouseOut(player);
                 continue;
             }
             // Don't break since some more OnMouseOut might be necessary
             if (oneActionAlreadyExecuted) continue;
  
             
             // keep the mouse coordinates relative to the child's bounds
             if (child->ProcessMouseInput(button, adjustedMouseX - childLeft, adjustedMouseY - childTop - iScrollY, dwKeyParam, childLeft - offsetX, childTop + iScrollY - offsetY))
             {
                 oneActionAlreadyExecuted = true;
             }
         }
     }
  
     return oneActionAlreadyExecuted;
 }

References C4ScriptGuiWindowProperty::GetInt(), C4MouseControl::GetPlayer(), HasMouseFocus(), C4Rect::Hgt, C4GUI::ScrollWindow::iScrollY, IsVisibleTo(), MouseControl, C4ScriptGuiWindowStyleFlag::Multiple, NO_OWNER, OnMouseOut(), C4ScriptGuiWindowPropertyName::player, ProcessMouseInput(), C4GUI::Container::rbegin(), C4GUI::Element::rcBounds, C4GUI::Container::rend(), C4ScriptGuiWindowPropertyName::style, C4Rect::Wdt, C4Rect::x, and C4Rect::y.

Here is the call graph for this function:

◆ MouseLeave()

void C4ScriptGuiWindow::MouseLeave ( C4GUI::CMouse & rMouse )

overridevirtual

Reimplemented from C4GUI::Element.

Definition at line 2089 of file C4ScriptGuiWindow.cpp.

 {
     assert(::MouseControl.GetPlayer() != NO_OWNER);
  
 }

References C4MouseControl::GetPlayer(), MouseControl, and NO_OWNER.

Here is the call graph for this function:

◆ OnHotkey()

bool C4GUI::Container::OnHotkey ( uint32_t cHotkey )

overrideprotectedvirtualinherited

Reimplemented from C4GUI::Element.

Reimplemented in C4GUI::CheckBox, and C4GUI::Button.

Definition at line 212 of file C4GuiContainers.cpp.

     {
         if (!IsVisible()) return false;
         // check all nested elements
         for (Element *pEl = pFirst; pEl; pEl=pEl->pNext)
             if (pEl->fVisible)
                 if (pEl->OnHotkey(cHotkey)) return true;
         // no match found
         return false;
     }

References C4GUI::Element::IsVisible(), C4GUI::Container::pFirst, and C4GUI::Element::pNext.

Here is the call graph for this function:

◆ OnMouseIn()

void C4ScriptGuiWindow::OnMouseIn	(	int32_t	player,
		int32_t	parentOffsetX,
		int32_t	parentOffsetY
	)

Definition at line 2059 of file C4ScriptGuiWindow.cpp.

 {
     assert(!HasMouseFocus() && "custom menu window properly loaded incorrectly!");
     currentMouseState = MouseState::Focus;
  
     // no need to notify children, this is done in MouseInput
  
     // update tooltip info if applicable
     StdCopyStrBuf *strBuf = props[C4ScriptGuiWindowPropertyName::tooltip].GetStrBuf();
     if (strBuf)
     {
         C4Viewport * viewport = ::Viewports.GetViewport(player);
         if (viewport)
         {
             const float guiZoom = viewport->GetGUIZoom();
             const int32_t x = int32_t((parentOffsetX + rcBounds.x) / guiZoom);
             const int32_t y = int32_t((parentOffsetY + rcBounds.y) / guiZoom);
             const int32_t wdt = int32_t(rcBounds.Wdt / guiZoom);
             const int32_t hgt = int32_t(rcBounds.Hgt / guiZoom);
             ::MouseControl.SetTooltipRectangle(C4Rect(x, y, wdt, hgt));
             ::MouseControl.SetTooltipText(*strBuf);
         }
     }
     // execute action
     int32_t actionType = C4ScriptGuiWindowPropertyName::onMouseInAction;
     C4ScriptGuiWindowAction *action = props[actionType].GetAction();
     if (!action) return;
     action->Execute(this, player, actionType);
 }

References currentMouseState, C4ScriptGuiWindowAction::Execute(), C4ScriptGuiWindowProperty::GetAction(), C4Viewport::GetGUIZoom(), C4ScriptGuiWindowProperty::GetStrBuf(), C4ViewportList::GetViewport(), HasMouseFocus(), C4Rect::Hgt, MouseControl, C4ScriptGuiWindowPropertyName::onMouseInAction, C4ScriptGuiWindowPropertyName::player, C4GUI::Element::rcBounds, C4MouseControl::SetTooltipRectangle(), C4MouseControl::SetTooltipText(), C4ScriptGuiWindowPropertyName::tooltip, Viewports, C4Rect::Wdt, C4Rect::x, and C4Rect::y.

Referenced by ProcessMouseInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnMouseOut()

void C4ScriptGuiWindow::OnMouseOut ( int32_t player )

Definition at line 2094 of file C4ScriptGuiWindow.cpp.

 {
     assert(HasMouseFocus() && "custom menu window probably loaded incorrectly!");
     currentMouseState = MouseState::None;
  
     // needs to notify children
     for (C4GUI::Element *iter : *this)
     {
         C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(iter);
         if (child->HasMouseFocus())
             child->OnMouseOut(player);
     }
  
     // execute action
     int32_t actionType = C4ScriptGuiWindowPropertyName::onMouseOutAction;
     C4ScriptGuiWindowAction *action = props[actionType].GetAction();
     if (!action) return;
     action->Execute(this, player, actionType);
 }

References currentMouseState, C4ScriptGuiWindowAction::Execute(), C4ScriptGuiWindowProperty::GetAction(), HasMouseFocus(), C4ScriptGuiWindowStyleFlag::None, OnMouseOut(), C4ScriptGuiWindowPropertyName::onMouseOutAction, and C4ScriptGuiWindowPropertyName::player.

Referenced by MouseInput(), OnMouseOut(), and ProcessMouseInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessMouseInput()

bool C4ScriptGuiWindow::ProcessMouseInput	(	int32_t	iButton,
		int32_t	iX,
		int32_t	iY,
		DWORD	dwKeyParam,
		int32_t	parentOffsetX,
		int32_t	parentOffsetY
	)

virtual

Definition at line 2181 of file C4ScriptGuiWindow.cpp.

 {
     const int32_t &player = ::MouseControl.GetPlayer();
     assert(player != NO_OWNER);
  
     // completely ignore mouse if the appropriate flag is set
     const int32_t &style = props[C4ScriptGuiWindowPropertyName::style].GetInt();
     if (style & C4ScriptGuiWindowStyleFlag::IgnoreMouse)
         return false;
     
     // we have mouse focus! Is this new?
     if (!HasMouseFocus())
         OnMouseIn(player, parentOffsetX, parentOffsetY);
  
     // Make sure the UI does not catch release events without matching key-down events.
     // Otherwise, you could e.g. open a menu on left-down and then the menu would block the left-up event, leading to issues.
     if (button == C4MC_Button_LeftUp)
     {
         // Do not catch up-events without prior down-events!
         if (!(currentMouseState & MouseState::MouseDown)) return false;
     }
  
     // do not simply break the loop since some OnMouseOut might go missing
     bool oneActionAlreadyExecuted = false;
  
     const int32_t scrollAdjustedMouseY = mouseY + iScrollY;
  
     // children actually have a higher priority
     bool overChild = false; // remember for later, catch all actions that are in theory over children, even if not reaction (if main window)
     // use reverse iterator since children with higher Priority appear later in the list
     for (auto iter = rbegin(); iter != rend(); ++iter)
     {
         C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(*iter);
  
         // Do the visibility check first. The child itself won't do it, because we are handling mouse in/out here, too.
         if (!child->IsVisibleTo(player)) continue;
  
         const int32_t childLeft = child->rcBounds.x;
         const int32_t childRight = child->rcBounds.x + child->rcBounds.Wdt;
         const int32_t childTop = child->rcBounds.y;
         const int32_t childBottom = child->rcBounds.y + child->rcBounds.Hgt;
  
         bool inArea = true;
         if ((mouseX <= childLeft) || (mouseX > childRight)) inArea = false;
         else if ((scrollAdjustedMouseY <= childTop) || (scrollAdjustedMouseY > childBottom)) inArea = false;
  
         if (!inArea) // notify child if it had mouse focus before
         {
             if (child->HasMouseFocus())
                 child->OnMouseOut(player);
             continue;
         }
  
         if (oneActionAlreadyExecuted) continue;
  
         overChild = true;
         // keep coordinates relative to children
         if (child->ProcessMouseInput(button, mouseX - childLeft, scrollAdjustedMouseY - childTop, dwKeyParam, parentOffsetX + rcBounds.x, parentOffsetY + rcBounds.y - iScrollY))
         {
             oneActionAlreadyExecuted = true;
         }
     }
  
     if (oneActionAlreadyExecuted) return true;
  
     //C4GUI::Element::MouseInput(rMouse, button, mouseX, mouseY, dwKeyParam);
  
     // remember button-down events. The action will only be executed on button-up
     // The sequence for double-clicks is LeftDown-LeftUp-LeftDouble-LeftUp, so treat double as down
     if (button == C4MC_Button_LeftDown || button == C4MC_Button_LeftDouble)
         currentMouseState |= MouseState::MouseDown;
     // trigger!
     if (button == C4MC_Button_LeftUp)
     {
         currentMouseState = currentMouseState & ~MouseState::MouseDown;
         C4ScriptGuiWindowAction *action = props[C4ScriptGuiWindowPropertyName::onClickAction].GetAction();
         if (action)
         {
             action->Execute(this, player, C4ScriptGuiWindowPropertyName::onClickAction);
             return true;
         }
     }
  
     // for scroll-enabled windows, scroll contents with wheel
     if (pScrollBar->IsVisible() && (button == C4MC_Button_Wheel))
     {
         short delta = (short)(dwKeyParam >> 16);
         ScrollBy(-delta);
         //float fac = (lastDrawPosition.bottomMostChild - lastDrawPosition.topMostChild);
         //if (fac == 0.0f) fac = 1.0f;
         //scrollBar->ScrollBy(-float(delta) / fac);
         return true;
     }
  
     // forward to scroll-bar if in area
     if (pScrollBar->IsVisible())
     {
         if ((mouseX > pScrollBar->rcBounds.x && mouseX < pScrollBar->rcBounds.x + pScrollBar->rcBounds.Wdt)
             && (mouseY > pScrollBar->rcBounds.y && mouseY < pScrollBar->rcBounds.y + pScrollBar->rcBounds.Hgt))
         {
             C4GUI::CMouse mouse(mouseX, mouseY);
             if (::MouseControl.IsLeftDown()) mouse.LDown = true;
             pScrollBar->MouseInput(mouse, button, mouseX - pScrollBar->rcBounds.x, mouseY - pScrollBar->rcBounds.y, dwKeyParam);
         }
     }
  
  
     // if the user still clicked on a menu - even if it didn't do anything, catch it
     // but do that only on the top-level to not stop traversing other branches
     if (isMainWindow)
         return overChild;
     return false;
 }

References C4MC_Button_LeftDouble, C4MC_Button_LeftDown, C4MC_Button_LeftUp, C4MC_Button_Wheel, currentMouseState, C4ScriptGuiWindowAction::Execute(), C4ScriptGuiWindowProperty::GetAction(), C4ScriptGuiWindowProperty::GetInt(), C4MouseControl::GetPlayer(), HasMouseFocus(), C4Rect::Hgt, C4ScriptGuiWindowStyleFlag::IgnoreMouse, C4GUI::ScrollWindow::iScrollY, C4MouseControl::IsLeftDown(), C4GUI::Element::IsVisible(), IsVisibleTo(), C4GUI::CMouse::LDown, MouseControl, MouseDown, C4GUI::ScrollBar::MouseInput(), NO_OWNER, C4ScriptGuiWindowPropertyName::onClickAction, OnMouseIn(), OnMouseOut(), C4ScriptGuiWindowPropertyName::player, ProcessMouseInput(), C4GUI::ScrollWindow::pScrollBar, C4GUI::Container::rbegin(), C4GUI::Element::rcBounds, C4GUI::Container::rend(), C4GUI::ScrollWindow::ScrollBy(), C4ScriptGuiWindowPropertyName::style, C4Rect::Wdt, C4Rect::x, and C4Rect::y.

Referenced by MouseInput(), and ProcessMouseInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rbegin()

ReverseIterator C4GUI::Container::rbegin ( )

inlineinherited

Definition at line 826 of file C4Gui.h.

826 { return ReverseIterator(pLast); }

References C4GUI::Container::pLast.

Referenced by MouseInput(), and ProcessMouseInput().

Here is the caller graph for this function:

◆ ReaddElement()

void C4GUI::Container::ReaddElement ( Element * pChild )

inherited

Definition at line 134 of file C4GuiContainers.cpp.

     {
         // safety
         if (!pChild || pChild->pParent != this) return;
         // remove from any previous container
         if (pChild->pPrev) pChild->pPrev->pNext = pChild->pNext; else pFirst = pChild->pNext;
         if (pChild->pNext) pChild->pNext->pPrev = pChild->pPrev; else pLast = pChild->pPrev;
         // add to end of list
         if (pLast) pLast->pNext = pChild; else pFirst = pChild;
         pChild->pPrev = pLast; pChild->pNext = nullptr; pLast = pChild;
  
         assert(pChild->pNext != pChild);
         assert(pChild->pPrev != pChild);
         assert(pChild->pParent != pChild);
     }

References C4GUI::Container::pFirst, C4GUI::Container::pLast, C4GUI::Element::pNext, C4GUI::Element::pParent, and C4GUI::Element::pPrev.

Referenced by C4GUI::ListBox::SortElements().

Here is the caller graph for this function:

◆ RemoveChild()

void C4ScriptGuiWindow::RemoveChild	(	C4ScriptGuiWindow *	child,
		bool	close = `true`,
		bool	all = `false`
	)

Definition at line 1289 of file C4ScriptGuiWindow.cpp.

 {
     if (isRemovalLockedForClosingCallback())
     {
         // We are in potentially dangerous fields here (removing a window while another window is being removed).
         // This has a decent chance to lead to accessing dead memory.
         // It might still leave the GUI tree in an incorrect state (with dead target objects). But still better than a direct crash.
         throw C4AulExecError("Trying to remove script GUI window (or window target) from within window closing callback.");
     }
  
     // do a layout update asap
     if (!all && !IsRoot())
         RequestLayoutUpdate();
  
     if (child)
     {
         child->wasRemovedFromParent = true;
         if (close) child->Close();
         if (child->GetID() != 0)
             ChildWithIDRemoved(child);
         RemoveElement(static_cast<C4GUI::Element*>(child));
         MenuDebugLogF("Deleting child (%d, %s, @%p, target: %p) from parent (%d, %s, @%p, target: %p).",
             child->id, child->name, child, child->target,
             id, name, this, target);
         // RemoveElement does NOT delete the child itself.
         delete child;
     }
     else if (close) // close all children
     {
         assert(all);
         for (Element * element : *this)
         {
             C4ScriptGuiWindow * child = static_cast<C4ScriptGuiWindow*>(element);
             assert(child != nullptr);
             MenuDebugLogF("Closing child (%d, %s, @%p, target: %p) due to parent (%d, %s, @%p, target: %p) removal.",
                 child->id, child->name, child, child->target,
                 id, name, this, target);
             child->wasRemovedFromParent = true;
             child->Close();
             if (child->GetID() != 0)
                 ChildWithIDRemoved(child);
         }
     }
  
     if (all)
         C4GUI::ScrollWindow::ClearChildren();
 }

References C4GUI::Container::ClearChildren(), Close(), C4GUI::Container::Element, GetID(), MenuDebugLogF, C4GUI::Container::RemoveElement(), and RequestLayoutUpdate().

Referenced by ClearChildren(), Close(), and CreateFromPropList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveElement()

void C4GUI::Container::RemoveElement ( Element * pChild )

overridevirtualinherited

Reimplemented from C4GUI::Element.

Reimplemented in C4GUI::Screen, C4GUI::Dialog, C4GUI::ContextMenu, C4GUI::Tabular, and C4GUI::ListBox.

Definition at line 89 of file C4GuiContainers.cpp.

     {
         // safety
         if (!pChild) return;
         // inherited
         Element::RemoveElement(pChild);
         // must be from same container
         if (pChild->pParent != this) return;
         // unlink from list
         if (pChild->pPrev) pChild->pPrev->pNext = pChild->pNext; else pFirst = pChild->pNext;
         if (pChild->pNext) pChild->pNext->pPrev = pChild->pPrev; else pLast = pChild->pPrev;
         // unset parent; invalidates pPrev/pNext
         pChild->pParent = nullptr;
         // element has been removed
         AfterElementRemoval();
     }

References C4GUI::Container::AfterElementRemoval(), C4GUI::Container::pFirst, C4GUI::Container::pLast, C4GUI::Element::pNext, C4GUI::Element::pParent, C4GUI::Element::pPrev, and C4GUI::Element::RemoveElement().

Referenced by C4GUI::Container::AddElement(), C4GUI::Container::InsertElement(), RemoveChild(), C4GUI::Element::RemoveElement(), C4GUI::ListBox::RemoveElement(), C4GUI::Tabular::RemoveElement(), C4GUI::ContextMenu::RemoveElement(), C4GUI::Dialog::RemoveElement(), C4GUI::Screen::RemoveElement(), and C4GUI::Element::~Element().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rend()

ReverseIterator C4GUI::Container::rend ( )

inlineinherited

Definition at line 827 of file C4Gui.h.

827 { return ReverseIterator(nullptr); }

Referenced by MouseInput(), and ProcessMouseInput().

Here is the caller graph for this function:

◆ RequestLayoutUpdate()

void C4ScriptGuiWindow::RequestLayoutUpdate ( )

Definition at line 1663 of file C4ScriptGuiWindow.cpp.

 {
     // directly requested on the root window?
     // That usually comes from another part of the engine (f.e. C4Viewport::RecalculateViewports) or from a multiple-window child
     if (!GetParent())
     {
         mainWindowNeedsLayoutUpdate = true;
         return;
     }
  
     // are we a direct child of the root?
     if (isMainWindow)
     {
         const int32_t &style = props[C4ScriptGuiWindowPropertyName::style].GetInt();
         
         if (!(style & C4ScriptGuiWindowStyleFlag::Multiple)) // are we a simple centered window?
         {
             mainWindowNeedsLayoutUpdate = true;
             return;
         }
         else // we are one of the multiple windows.. the root better do a full refresh
         {}
     }
     // propagate to parent window
     static_cast<C4ScriptGuiWindow*>(GetParent())->RequestLayoutUpdate();
 }

References C4ScriptGuiWindowProperty::GetInt(), C4GUI::Element::GetParent(), C4ScriptGuiWindowStyleFlag::Multiple, and C4ScriptGuiWindowPropertyName::style.

Referenced by CreateFromPropList(), Denumerate(), RemoveChild(), and SetTag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScreenPos2ClientPos()

void C4GUI::Element::ScreenPos2ClientPos	(	int32_t &	riX,
		int32_t &	riY
	)

inherited

Definition at line 218 of file C4Gui.cpp.

     {
         // apply all parent offsets
         Container *pCont = pParent;
         while (pCont)
         {
             pCont->ApplyElementOffset(riX, riY);
             pCont = pCont->GetParent();
         }
         // apply own offset
         riX -= rcBounds.x; riY -= rcBounds.y;
     }

References C4GUI::Container::ApplyElementOffset(), C4GUI::Element::GetParent(), C4GUI::Element::pParent, C4GUI::Element::rcBounds, C4Rect::x, and C4Rect::y.

Referenced by C4GUI::Screen::MouseInput(), and C4GUI::CMouse::ReleaseElements().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScrollBy()

void C4GUI::ScrollWindow::ScrollBy ( int iAmount )

inherited

Definition at line 564 of file C4GuiContainers.cpp.

     {
         int32_t iVisHgt = GetBounds().Hgt;
         int32_t iClientHgt = GetClientRect().Hgt;
         int32_t iMaxScroll = iClientHgt - iVisHgt;
         int iNewScrollY = Clamp<int>(iScrollY + iAmount, 0, iMaxScroll);
         if (iScrollY != iNewScrollY)
         {
             // scrolling possible: do it
             iScrollY = iNewScrollY;
             // update (self + bar)
             Update();
         }
     }

References C4GUI::Element::GetBounds(), C4GUI::Window::GetClientRect(), C4Rect::Hgt, C4GUI::ScrollWindow::iScrollY, and C4GUI::ScrollWindow::Update().

Referenced by C4GUI::ScrollWindow::MouseInput(), ProcessMouseInput(), and C4GUI::ScrollWindow::ScrollPages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScrollPages()

void C4GUI::ScrollWindow::ScrollPages ( int iPageCount )

inherited

Definition at line 558 of file C4GuiContainers.cpp.

     {
         int32_t iVisHgt = GetBounds().Hgt;
         ScrollBy(iPageCount * iVisHgt);
     }

References C4GUI::Element::GetBounds(), C4Rect::Hgt, and C4GUI::ScrollWindow::ScrollBy().

Here is the call graph for this function:

◆ ScrollRangeInView()

void C4GUI::ScrollWindow::ScrollRangeInView	(	int32_t	iY,
		int32_t	iHgt
	)

inherited

Definition at line 579 of file C4GuiContainers.cpp.

     {
         // safety bounds
         if (iY<0) iY=0;
         int32_t iClientHgt = GetClientRect().Hgt;
         if (iY+iHgt > iClientHgt) { ScrollToBottom(); return; }
         // check top
         if (iScrollY > iY)
         {
             iScrollY = iY;
             Update(); // update (self+bar)
         }
         else
         {
             // check bottom
             int32_t iVisHgt = GetBounds().Hgt;
             // if no height is given, scroll given Y-pos to top
             if (!iHgt) iHgt = iVisHgt;
             if (iScrollY + iVisHgt < iY + iHgt)
             {
                 iScrollY = iY + iHgt - iVisHgt;
                 Update(); // update (self+bar)
             }
         }
     }

References C4GUI::Element::GetBounds(), C4GUI::Window::GetClientRect(), C4Rect::Hgt, C4GUI::ScrollWindow::iScrollY, C4GUI::ScrollWindow::ScrollToBottom(), and C4GUI::ScrollWindow::Update().

Referenced by C4Menu::AdjustPosition(), C4GUI::ListBox::ScrollItemInView(), and C4GUI::TextWindow::SetScrollPos().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScrollToBottom()

void C4GUI::ScrollWindow::ScrollToBottom ( )

inherited

Definition at line 544 of file C4GuiContainers.cpp.

     {
         int32_t iVisHgt = GetBounds().Hgt;
         int32_t iClientHgt = GetClientRect().Hgt;
         int32_t iMaxScroll = iClientHgt - iVisHgt;
         if (iScrollY < iMaxScroll)
         {
             // scrolling possible: do it
             iScrollY = iMaxScroll;
             // update (self + bar)
             Update();
         }
     }

References C4GUI::Element::GetBounds(), C4GUI::Window::GetClientRect(), C4Rect::Hgt, C4GUI::ScrollWindow::iScrollY, and C4GUI::ScrollWindow::Update().

Referenced by C4GUI::ScrollWindow::ScrollRangeInView(), C4GUI::ListBox::ScrollToBottom(), and C4GUI::TextWindow::ScrollToBottom().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBounds()

void C4GUI::Element::SetBounds ( const C4Rect & rcNewBound )

inlineinherited

Definition at line 446 of file C4Gui.h.

446 { rcBounds=rcNewBound; UpdatePos(); UpdateSize(); }

C4GUI::Element::UpdateSize

virtual void UpdateSize()

Definition: C4Gui.cpp:185

References C4GUI::Element::rcBounds, C4GUI::Element::UpdatePos(), and C4GUI::Element::UpdateSize().

Referenced by C4GameOptionButtons::C4GameOptionButtons(), C4GoalDisplay::C4GoalDisplay(), C4StartupModsListEntry::C4StartupModsListEntry(), C4StartupNetDlg::C4StartupNetDlg(), C4StartupNetListEntry::C4StartupNetListEntry(), C4GUI::ContextButton::ContextButton(), C4GUI::ListBox::ContractToElementHeight(), C4GUI::Control::Control(), C4GUI::Dialog::Dialog(), C4ChatDlg::DoPlacement(), C4StartupNetListEntry::Execute(), C4GUI::FullscreenDialog::FullscreenDialog(), C4GUI::GroupBox::GroupBox(), C4GUI::HorizontalLine::HorizontalLine(), C4GUI::Screen::Init(), C4Menu::InitSize(), C4GUI::LabeledEdit::LabeledEdit(), C4StartupModsListEntry::MakeInfoEntry(), C4Game::OnResolutionChanged(), C4GameLobby::ScenDesc::ScenDesc(), C4StartupScenSelDlg::ScenListItem::ScenListItem(), C4GUI::ScrollWindow::ScrollWindow(), C4GUI::InputDialog::SetCustomEdit(), C4GUI::Tabular::SetGfx(), C4GoalDisplay::SetGoals(), C4StartupNetListEntry::SetReference(), C4StartupNetListEntry::SetRefQuery(), C4GUI::Tabular::Sheet::Sheet(), C4GUI::TextWindow::TextWindow(), C4ScoreboardDlg::Update(), C4GUI::ListBox::UpdateElementPositions(), C4Menu::UpdateElementPositions(), C4GUI::ScrollWindow::UpdateOwnPos(), C4ChatControl::UpdateSize(), C4ChatDlg::UpdateSize(), C4GUI::TextWindow::UpdateSize(), and C4GUI::Dialog::UpdateSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetClientHeight()

void C4GUI::ScrollWindow::SetClientHeight ( int32_t iToHgt )

inlineinherited

Definition at line 973 of file C4Gui.h.

974 { iClientHeight=iToHgt; Update(); }

References C4GUI::ScrollWindow::iClientHeight, and C4GUI::ScrollWindow::Update().

Referenced by C4GUI::ListBox::AddElement(), C4GUI::TextWindow::ElementPosChanged(), C4GUI::TextWindow::ElementSizeChanged(), C4GUI::TextWindow::TextWindow(), C4GUI::ListBox::UpdateElementPositions(), and C4Menu::UpdateElementPositions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetContextHandler()

void C4GUI::Element::SetContextHandler ( ContextHandler * pNewHd )

inlineinherited

Definition at line 465 of file C4Gui.h.

         {
             if (pContextHandler) pContextHandler->DeRef();
             if ((pContextHandler = pNewHd)) pNewHd->Ref();
         }

References C4GUI::ContextHandler::DeRef(), C4GUI::Element::pContextHandler, and C4GUI::ContextHandler::Ref().

Referenced by C4StartupMainDlg::C4StartupMainDlg(), C4GUI::ContextButton::ContextButton(), C4GUI::Edit::Edit(), and C4GameLobby::MainDlg::MainDlg().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDecoration()

void C4GUI::ScrollWindow::SetDecoration	(	ScrollBarFacets *	pToGfx,
		bool	fAutoScroll
	)

inlineinherited

Definition at line 977 of file C4Gui.h.

978 { if (pScrollBar) pScrollBar->SetDecoration(pToGfx, fAutoScroll); }

C4GUI::ScrollBar::SetDecoration

void SetDecoration(ScrollBarFacets *pToGfx, bool fAutoHide)

Definition: C4Gui.h:929

References C4GUI::ScrollWindow::pScrollBar, and C4GUI::ScrollBar::SetDecoration().

Referenced by C4GUI::TextWindow::SetDecoration(), and C4GUI::ListBox::SetDecoration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDragTarget()

void C4GUI::Element::SetDragTarget ( Window * pToWindow )

inlineinherited

Definition at line 464 of file C4Gui.h.

464 { pDragTarget = pToWindow; }

References C4GUI::Element::pDragTarget.

Referenced by C4GUI::Dialog::SetTitle().

Here is the caller graph for this function:

◆ SetEnumeratedID()

void C4ScriptGuiWindow::SetEnumeratedID ( int enumID )

inline

Definition at line 282 of file C4ScriptGuiWindow.h.

282 { id = enumID; }

◆ SetPos()

void C4GUI::Window::SetPos	(	int32_t	iXPos,
		int32_t	iYPos
	)

inlineinherited

Definition at line 860 of file C4Gui.h.

861 { rcBounds.x=iXPos; rcBounds.y=iYPos; UpdatePos(); }

References C4GUI::Element::rcBounds, C4GUI::Element::UpdatePos(), C4Rect::x, and C4Rect::y.

Referenced by C4ScoreboardDlg::DoPlacement(), C4Menu::InitLocation(), C4StartupPlrSelDlg::OnNewBtn(), C4StartupPlrSelDlg::OnPropertyBtn(), C4Menu::SetLocation(), and C4GUI::Screen::ShowDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetScroll()

void C4GUI::ScrollWindow::SetScroll ( int32_t iToScroll )

inherited

Definition at line 538 of file C4GuiContainers.cpp.

     {
         // set values
         rcClientRect.y = -(iScrollY = iToScroll);
     }

References C4GUI::ScrollWindow::iScrollY, C4GUI::Window::rcClientRect, and C4Rect::y.

Referenced by C4GUI::ScrollBar::OnPosChanged(), and C4Menu::SetPosition().

Here is the caller graph for this function:

◆ SetScrollBarEnabled()

void C4GUI::ScrollWindow::SetScrollBarEnabled	(	bool	fToVal,
		bool	noAutomaticPositioning = `false`
	)

inherited

Definition at line 635 of file C4GuiContainers.cpp.

     {
         if (fHasBar == fToVal) return;
         pScrollBar->SetVisibility(fHasBar = fToVal);
         // in some cases the windows will already care for the correct positioning themselves (see C4ScriptGuiWindow)
         if (!noAutomaticPositioning)
             UpdateOwnPos();
     }

References C4GUI::ScrollWindow::fHasBar, C4GUI::ScrollWindow::pScrollBar, C4GUI::Element::SetVisibility(), and C4GUI::ScrollWindow::UpdateOwnPos().

Referenced by C4Menu::InitSize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTag()

void C4ScriptGuiWindow::SetTag ( C4String * tag )

Definition at line 2038 of file C4ScriptGuiWindow.cpp.

 {
     // set tag on all properties
     for (uint32_t i = 0; i < C4ScriptGuiWindowPropertyName::_lastProp; ++i)
         if (props[i].SwitchTag(tag))
         {
             // only if tag could have changed position etc.
             if (i <= C4ScriptGuiWindowPropertyName::relBottom || i == C4ScriptGuiWindowPropertyName::text || i == C4ScriptGuiWindowPropertyName::style || i == C4ScriptGuiWindowPropertyName::priority)
                 RequestLayoutUpdate();
         }
  
     // .. and children
     for (C4GUI::Element * element : *this)
         (static_cast<C4ScriptGuiWindow*>(element))->SetTag(tag);
 }

References C4ScriptGuiWindowPropertyName::_lastProp, C4ScriptGuiWindowPropertyName::priority, C4ScriptGuiWindowPropertyName::relBottom, RequestLayoutUpdate(), C4ScriptGuiWindowPropertyName::style, and C4ScriptGuiWindowPropertyName::text.

Referenced by CreateFromPropList(), and C4ScriptGuiWindowAction::Execute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetToolTip()

void C4GUI::Element::SetToolTip	(	const char *	szNewTooltip,
		bool	is_immediate = `false`
	)

inherited

Definition at line 409 of file C4Gui.cpp.

     {
         // store tooltip
         if (szNewTooltip) ToolTip.Copy(szNewTooltip); else ToolTip.Clear();
         // store immediate flag
         is_immediate_tooltip = is_immediate;
     }

References StdStrBuf::Clear(), and StdStrBuf::Copy().

Referenced by C4GUI::ContextMenu::AddItem(), C4GameOverDlg::C4GameOverDlg(), C4LeagueSignupDialog::C4LeagueSignupDialog(), C4MenuItem::C4MenuItem(), C4StartupAboutDlg::C4StartupAboutDlg(), C4StartupLegalDlg::C4StartupLegalDlg(), C4StartupMainDlg::C4StartupMainDlg(), C4StartupModsDlg::C4StartupModsDlg(), C4StartupNetDlg::C4StartupNetDlg(), C4StartupOptionsDlg::C4StartupOptionsDlg(), C4StartupPlrPropertiesDlg::C4StartupPlrPropertiesDlg(), C4StartupPlrSelDlg::C4StartupPlrSelDlg(), C4StartupScenSelDlg::C4StartupScenSelDlg(), C4MapFolderData::CreateGUIElements(), C4GUI::InfoDialog::CreateSubComponents(), C4GUI::FullscreenDialog::FullscreenDialog(), C4GUI::IconButton::IconButton(), C4GUI::InputDialog::InputDialog(), C4GameLobby::MainDlg::MainDlg(), C4GUI::ProgressDialog::ProgressDialog(), C4StartupScenSelDlg::ScenListItem::ScenListItem(), C4GUI::InputDialog::SetCustomEdit(), C4GUI::FullscreenDialog::SetTitle(), C4GUI::Dialog::SetTitle(), C4ChatControl::ChatSheet::NickItem::Update(), and C4GameLobby::MainDlg::UpdateRightTab().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetVisibility()

void C4GUI::Container::SetVisibility ( bool fToValue )

overridevirtualinherited

Reimplemented from C4GUI::Element.

Reimplemented in C4StartupNetListEntry, and C4StartupModsListEntry.

Definition at line 247 of file C4GuiContainers.cpp.

     {
         // inherited
         Element::SetVisibility(fToValue);
         // remove focus from contained elements
         if (!fToValue)
         {
             Dialog *pDlg = GetDlg();
             if (pDlg)
             {
                 Control *pFocus = pDlg->GetFocus();
                 if (pFocus)
                 {
                     if (IsParentOf(pFocus))
                     {
                         pDlg->SetFocus(nullptr, false);
                     }
                 }
             }
         }
     }

References C4GUI::Element::GetDlg(), C4GUI::Dialog::GetFocus(), C4GUI::Container::IsParentOf(), C4GUI::Dialog::SetFocus(), and C4GUI::Element::SetVisibility().

Referenced by C4GUI::Tabular::AddCustomSheet(), C4LeagueSignupDialog::C4LeagueSignupDialog(), C4Menu::C4Menu(), C4StartupScenSelDlg::C4StartupScenSelDlg(), C4Menu::Draw(), C4Menu::InitLocation(), C4StartupModsDownloader::OnConfirmInstallation(), C4StartupModsListEntry::SetVisibility(), and C4StartupNetListEntry::SetVisibility().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartDragging()

void C4GUI::Element::StartDragging	(	CMouse &	rMouse,
		int32_t	iX,
		int32_t	iY,
		DWORD	dwKeyParam
	)

virtualinherited

Definition at line 259 of file C4Gui.cpp.

     {
         // set flag
         fDragging = true;
         // set drag start pos
         iDragX = iX; iDragY = iY;
         // mark drag in mouse
         rMouse.pDragElement = this;
     }

References C4GUI::Element::fDragging, C4GUI::Element::iDragX, C4GUI::Element::iDragY, and C4GUI::CMouse::pDragElement.

Referenced by C4MenuItem::MouseInput(), and C4GUI::Element::MouseInput().

Here is the caller graph for this function:

◆ StopDragging()

void C4GUI::Element::StopDragging	(	CMouse &	rMouse,
		int32_t	iX,
		int32_t	iY,
		DWORD	dwKeyParam
	)

virtualinherited

Definition at line 282 of file C4Gui.cpp.

     {
         // move element pos
         DoDragging(rMouse, iX, iY, dwKeyParam);
     }

References C4GUI::Element::DoDragging().

Referenced by C4GUI::Screen::MouseInput(), and C4GUI::CMouse::ReleaseElements().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ToC4Value()

const C4Value C4ScriptGuiWindow::ToC4Value ( )

Definition at line 886 of file C4ScriptGuiWindow.cpp.

 {
     C4PropList *proplist = C4PropList::New();
  
     // it is necessary that this list contains all of the properties which can also be set somehow
     // if you add something, don't forget to also add the real serialization to the loop below
     int32_t toSave[] =
     {
         P_Left,
         P_Top,
         P_Right,
         P_Bottom,
         P_Margin,
         P_BackgroundColor,
         P_Decoration,
         P_Symbol,
         P_Target,
         P_Text,
         P_ID,
         P_OnClick,
         P_OnMouseIn,
         P_OnMouseOut,
         P_OnClose,
         P_Style,
         P_Mode,
         P_Priority,
         P_Player,
         P_Tooltip
     };
  
     for (int prop : toSave)
     {
         C4Value val;
  
         switch (prop)
         {
         case P_Left:
         case P_Top:
         case P_Right:
         case P_Bottom:
         {
 #define PROPERTY_TUPLE(p, prop1, prop2) if (prop == p) { val = PositionToC4Value(prop1, prop2); }
             PROPERTY_TUPLE(P_Left, C4ScriptGuiWindowPropertyName::relLeft, C4ScriptGuiWindowPropertyName::left);
             PROPERTY_TUPLE(P_Top, C4ScriptGuiWindowPropertyName::relTop, C4ScriptGuiWindowPropertyName::top);
             PROPERTY_TUPLE(P_Right, C4ScriptGuiWindowPropertyName::relRight, C4ScriptGuiWindowPropertyName::right);
             PROPERTY_TUPLE(P_Bottom, C4ScriptGuiWindowPropertyName::relBottom, C4ScriptGuiWindowPropertyName::bottom);
 #undef PROPERTY_TUPLE
             break;
         }
         case P_Margin: val = MarginsToC4Value(); break;
         case P_BackgroundColor: val = props[C4ScriptGuiWindowPropertyName::backgroundColor].ToC4Value(); break;
         case P_Decoration: val = props[C4ScriptGuiWindowPropertyName::frameDecoration].ToC4Value(); break;
         case P_Symbol:
             // either object or def
             val = props[C4ScriptGuiWindowPropertyName::symbolObject].ToC4Value();
             if (val == C4Value()) // is nil?
                 val = props[C4ScriptGuiWindowPropertyName::symbolDef].ToC4Value();
             break;
         case P_Target: val = C4Value(target); break;
         case P_Text: val = props[C4ScriptGuiWindowPropertyName::text].ToC4Value(); break;
         case P_GraphicsName: val = props[C4ScriptGuiWindowPropertyName::symbolGraphicsName].ToC4Value(); break;
         case P_Tooltip: val = props[C4ScriptGuiWindowPropertyName::tooltip].ToC4Value(); break;
         case P_ID: val = C4Value(id); break;
         case P_OnClick: val = props[C4ScriptGuiWindowPropertyName::onClickAction].ToC4Value(); break;
         case P_OnMouseIn: val = props[C4ScriptGuiWindowPropertyName::onMouseInAction].ToC4Value(); break;
         case P_OnMouseOut: val = props[C4ScriptGuiWindowPropertyName::onMouseOutAction].ToC4Value(); break;
         case P_OnClose: val = props[C4ScriptGuiWindowPropertyName::onCloseAction].ToC4Value(); break;
         case P_Style: val = props[C4ScriptGuiWindowPropertyName::style].ToC4Value(); break;
         case P_Mode: val = C4Value(int32_t(currentMouseState)); break;
         case P_Priority: val = props[C4ScriptGuiWindowPropertyName::priority].ToC4Value(); break;
         case P_Player: val = props[C4ScriptGuiWindowPropertyName::player].ToC4Value(); break;
  
         default:
             assert(false);
             break;
         }
  
         // don't save "nil" values
         if (val == C4Value()) continue;
  
         proplist->SetProperty(C4PropertyName(prop), val);
     }
  
     // save children now, construct new names for them if necessary
     int32_t childIndex = 0;
     for (C4GUI::Element * element : *this)
     {
         C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(element);
         C4Value val = child->ToC4Value();
         C4String *childName = child->name;
         if (!childName)
         {
             StdStrBuf childNameBuf;
             childNameBuf.Format("_child_%03d", ++childIndex);
             childName = Strings.RegString(childNameBuf);
         }
         proplist->SetPropertyByS(childName, val);
     }
  
     return C4Value(proplist);
 }

Referenced by ToC4Value().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UnFreeze()

void C4GUI::ScrollWindow::UnFreeze ( )

inlineinherited

Definition at line 970 of file C4Gui.h.

970 { if (!--iFrozen) Update(); }

References C4GUI::ScrollWindow::iFrozen, and C4GUI::ScrollWindow::Update().

Referenced by C4Menu::RefillInternal(), and C4GUI::ListBox::UnFreezeScrolling().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Update()

void C4GUI::ScrollWindow::Update ( )

inherited

Definition at line 523 of file C4GuiContainers.cpp.

     {
         // not if window is being refilled
         if (iFrozen) return;
         // do not scroll outside range
         iScrollY = Clamp<int32_t>(iScrollY, 0, std::max<int32_t>(iClientHeight - GetBounds().Hgt, 0));
         // update client rect
         rcClientRect.x = 0;
         rcClientRect.y = -iScrollY;
         rcClientRect.Wdt = rcBounds.Wdt;
         rcClientRect.Hgt = iClientHeight;
         // update scroll bar
         if (pScrollBar) pScrollBar->Update();
     }

References C4GUI::Element::GetBounds(), C4Rect::Hgt, C4GUI::ScrollWindow::iClientHeight, C4GUI::ScrollWindow::iFrozen, C4GUI::ScrollWindow::iScrollY, C4GUI::ScrollWindow::pScrollBar, C4GUI::Element::rcBounds, C4GUI::Window::rcClientRect, C4GUI::ScrollBar::Update(), C4Rect::Wdt, C4Rect::x, and C4Rect::y.

Referenced by C4GUI::ScrollWindow::ScrollBy(), C4GUI::ScrollWindow::ScrollRangeInView(), C4GUI::ScrollWindow::ScrollToBottom(), C4GUI::ScrollWindow::SetClientHeight(), C4GUI::ScrollWindow::UnFreeze(), UpdateLayout(), and C4GUI::ScrollWindow::UpdateOwnPos().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateChildLayout()

bool C4ScriptGuiWindow::UpdateChildLayout	(	C4TargetFacet &	cgo,
		float	parentWidth,
		float	parentHeight
	)

Definition at line 1690 of file C4ScriptGuiWindow.cpp.

 {
     for (Element * element : *this)
     {
         C4ScriptGuiWindow *window = static_cast<C4ScriptGuiWindow*>(element);
         window->UpdateLayout(cgo, parentWidth, parentHeight);
     }
     return true;
 }

References C4GUI::Container::Element, and UpdateLayout().

Referenced by UpdateLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateLayout() [1/2]

bool C4ScriptGuiWindow::UpdateLayout ( C4TargetFacet & cgo )

Definition at line 1700 of file C4ScriptGuiWindow.cpp.

 {
     assert(IsRoot()); // we are root
  
     // assume I am the root and use the a special rectangle in the viewport for drawing
     const float fullWidth = cgo.Wdt * cgo.Zoom - cgo.X;
     const float fullHeight = cgo.Hgt * cgo.Zoom - cgo.Y;
  
     // golden ratio defined default size!
     const float &targetWidthEm = C4ScriptGuiWindow::standardWidth;
     const float &targetHeightEm = C4ScriptGuiWindow::standardHeight;
     
     // adjust by viewport size
     const float minMarginPx = 50.0f;
     const float targetWidthPx = std::min(Em2Pix(targetWidthEm), fullWidth - 2.0f * minMarginPx);
     const float targetHeightPx = std::min(Em2Pix(targetHeightEm), fullHeight - 2.0f * minMarginPx);
  
     // calculate margins to center the window
     const float marginLeftRight = (fullWidth - targetWidthPx) / 2.0f;
     const float marginTopBottom = (fullHeight- targetHeightPx) / 2.0f;
  
     // we can only position the window by adjusting left/right/top/bottom
     const float &left = marginLeftRight;
     const float right = -marginLeftRight;
     const float &top = marginTopBottom;
     const float bottom = -marginTopBottom;
  
     // actual size, calculated from borders
     const float wdt = fullWidth - left + right;
     const float hgt = fullHeight - top + bottom;
  
     const bool needUpdate = mainWindowNeedsLayoutUpdate || (rcBounds.Wdt != int32_t(wdt)) || (rcBounds.Hgt != int32_t(hgt));
  
     if (needUpdate)
     {
         mainWindowNeedsLayoutUpdate = false;
  
         // these are the coordinates for the centered non-multiple windows
         rcBounds.x = static_cast<int>(left);
         rcBounds.y = static_cast<int>(top);
         rcBounds.Wdt = wdt;
         rcBounds.Hgt = hgt;
  
         // first update all multiple windows (that can cover the whole screen)
         for (Element * element : *this)
         {
             C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(element);
             const int32_t &style = child->props[C4ScriptGuiWindowPropertyName::style].GetInt();
             if (!(style & C4ScriptGuiWindowStyleFlag::Multiple)) continue;
             child->UpdateLayout(cgo, fullWidth, fullHeight);
         }
         // then update all "main" windows in the center of the screen
         // todo: adjust the size of the main window based on the border-windows drawn before
         for (Element * element : *this)
         {
             C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(element);
             const int32_t &style = child->props[C4ScriptGuiWindowPropertyName::style].GetInt();
             if ((style & C4ScriptGuiWindowStyleFlag::Multiple)) continue;
             child->UpdateLayout(cgo, wdt, hgt);
         }
  
         pScrollBar->SetVisibility(false);
     }
     return true;
 }

References C4ScriptGuiWindowPropertyName::bottom, C4GUI::Container::Element, C4ScriptGuiWindowProperty::GetInt(), C4Facet::Hgt, C4Rect::Hgt, C4ScriptGuiWindowPropertyName::left, C4ScriptGuiWindowStyleFlag::Multiple, C4GUI::ScrollWindow::pScrollBar, C4GUI::Element::rcBounds, C4ScriptGuiWindowPropertyName::right, C4GUI::Element::SetVisibility(), standardHeight, standardWidth, C4ScriptGuiWindowPropertyName::style, C4ScriptGuiWindowPropertyName::top, UpdateLayout(), C4Facet::Wdt, C4Rect::Wdt, C4Facet::X, C4Rect::x, C4Facet::Y, C4Rect::y, and C4TargetFacet::Zoom.

Referenced by Draw(), DrawAll(), UpdateChildLayout(), and UpdateLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateLayout() [2/2]

bool C4ScriptGuiWindow::UpdateLayout	(	C4TargetFacet &	cgo,
		float	parentWidth,
		float	parentHeight
	)

Definition at line 1766 of file C4ScriptGuiWindow.cpp.

 {
     // fetch style
     const int32_t &style = props[C4ScriptGuiWindowPropertyName::style].GetInt();
     // fetch current position as shortcut for overview
     const float &left = props[C4ScriptGuiWindowPropertyName::left].GetFloat();
     const float &right = props[C4ScriptGuiWindowPropertyName::right].GetFloat();
     const float &top = props[C4ScriptGuiWindowPropertyName::top].GetFloat();
     const float &bottom = props[C4ScriptGuiWindowPropertyName::bottom].GetFloat();
  
     const float &relLeft = props[C4ScriptGuiWindowPropertyName::relLeft].GetFloat();
     const float &relRight = props[C4ScriptGuiWindowPropertyName::relRight].GetFloat();
     const float &relTop = props[C4ScriptGuiWindowPropertyName::relTop].GetFloat();
     const float &relBottom = props[C4ScriptGuiWindowPropertyName::relBottom].GetFloat();
  
     // same for margins
     const float &leftMargin = props[C4ScriptGuiWindowPropertyName::leftMargin].GetFloat();
     const float &rightMargin = props[C4ScriptGuiWindowPropertyName::rightMargin].GetFloat();
     const float &topMargin = props[C4ScriptGuiWindowPropertyName::topMargin].GetFloat();
     const float &bottomMargin = props[C4ScriptGuiWindowPropertyName::bottomMargin].GetFloat();
  
     const float &relLeftMargin = props[C4ScriptGuiWindowPropertyName::relLeftMargin].GetFloat();
     const float &relRightMargin = props[C4ScriptGuiWindowPropertyName::relRightMargin].GetFloat();
     const float &relTopMargin = props[C4ScriptGuiWindowPropertyName::relTopMargin].GetFloat();
     const float &relBottomMargin = props[C4ScriptGuiWindowPropertyName::relBottomMargin].GetFloat();
  
     // calculate drawing rectangle
     float leftDrawX = relLeft * parentWidth + Em2Pix(left) + (Em2Pix(leftMargin) + relLeftMargin * parentWidth);
     float rightDrawX = relRight * parentWidth + Em2Pix(right) - (Em2Pix(rightMargin) + relRightMargin * parentWidth);
     float topDrawY = relTop * parentHeight + Em2Pix(top) + (Em2Pix(topMargin) + relTopMargin * parentHeight);
     float bottomDrawY = relBottom * parentHeight + Em2Pix(bottom) - (Em2Pix(bottomMargin) + relBottomMargin * parentHeight);
     float width = rightDrawX - leftDrawX;
     float height = bottomDrawY - topDrawY;
  
     rcBounds.x = leftDrawX;
     rcBounds.y = topDrawY;
     rcBounds.Wdt = width;
     rcBounds.Hgt = height;
  
     // If this window contains text, we auto-fit to the text height;
     // but we only break text when the window /would/ crop it otherwise.
     StdCopyStrBuf *strBuf = props[C4ScriptGuiWindowPropertyName::text].GetStrBuf();
     int minRequiredTextHeight = 0;
     if (strBuf && !(style & C4ScriptGuiWindowStyleFlag::NoCrop))
     {
         StdStrBuf sText;
         const int32_t rawTextHeight = ::GraphicsResource.FontRegular.BreakMessage(strBuf->getData(), rcBounds.Wdt, &sText, true);
         // enable auto scroll
         if (rawTextHeight - 1 > rcBounds.Hgt)
         {
             // If we need to scroll, we will also have to add a scrollbar that takes up some width.
             // Recalculate the actual height, taking into account the scrollbar.
             // This is not done in the calculation earlier, because then e.g. a 2x1em field could not contain two letters
             // but would immediately add a linebreak.
             // In the case that this window auto-resizes (FitChildren), the small additional margin to the bottom should not matter much.
             const int32_t actualTextHeight = ::GraphicsResource.FontRegular.BreakMessage(strBuf->getData(), rcBounds.Wdt - pScrollBar->rcBounds.Wdt, &sText, true);
             minRequiredTextHeight = actualTextHeight;
         }
         else
         {
             // Otherwise, still set the minimum size to the text height (without scrollbar).
             // This is necessary so that e.g. Style::FitChildren works properly with pure text windows.
             minRequiredTextHeight = rawTextHeight;
         }
     }
  
     UpdateChildLayout(cgo, width, height);
     
     // update scroll bar
     // C4GUI::ScrollWindow::UpdateOwnPos();
  
     // special layout selected?
     if (style & C4ScriptGuiWindowStyleFlag::GridLayout)
         UpdateLayoutGrid();
     else if (style & C4ScriptGuiWindowStyleFlag::TightGridLayout)
         UpdateLayoutTightGrid();
     else if (style & C4ScriptGuiWindowStyleFlag::VerticalLayout)
         UpdateLayoutVertical();
  
     // check if we need a scroll-bar
     int32_t topMostChild = 0;
     int32_t bottomMostChild = minRequiredTextHeight;
     for (Element * element : *this)
     {
         C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(element);
         const int32_t &childTop = child->rcBounds.y;
         const int32_t childBottom = childTop + child->rcBounds.Hgt;
         if (childTop < topMostChild) topMostChild = childTop;
         if (childBottom > bottomMostChild) bottomMostChild = childBottom;
     }
     // do we need to adjust our size to fit the child windows?
     if (style & C4ScriptGuiWindowStyleFlag::FitChildren)
     {
         rcBounds.Hgt = bottomMostChild;
     }
     // update scroll rectangle:
     // (subtract one against rounding errors)
     bottomMostChild = std::max(bottomMostChild, rcBounds.Hgt);
     iClientHeight = bottomMostChild - topMostChild - 1;
     C4GUI::ScrollWindow::Update();
  
     pScrollBar->rcBounds.Wdt = C4GUI_ScrollBarWdt;
     pScrollBar->rcBounds.x = rcBounds.Wdt - pScrollBar->rcBounds.Wdt;
     pScrollBar->rcBounds.y = 0;
     pScrollBar->rcBounds.Hgt = rcBounds.Hgt;
     pScrollBar->Update();
  
     // never show scrollbar on non-cropping windows
     if ((style & C4ScriptGuiWindowStyleFlag::NoCrop) || !C4GUI::ScrollWindow::IsScrollingNecessary())
         pScrollBar->SetVisibility(false);
     // The "dirty" flag is unset here. Note that it's only used for non "multiple"-style windows after startup.
     // The "multiple"-style windows are updated together when the root window does a full refresh.
     mainWindowNeedsLayoutUpdate = false;
     return true;
 }

Here is the call graph for this function:

◆ UpdateLayoutGrid()

void C4ScriptGuiWindow::UpdateLayoutGrid ( )

Definition at line 1406 of file C4ScriptGuiWindow.cpp.

 {
     const int32_t &width = rcBounds.Wdt;
     const int32_t &height = rcBounds.Hgt;
  
     const int32_t borderX(0), borderY(0);
     int32_t currentX = borderX;
     int32_t currentY = borderY;
     int32_t lowestChildRelY = 0;
     int32_t maxChildHeight = 0;
  
     for (C4GUI::Element * element : *this)
     {
         C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(element);
         // calculate the space the child needs, correctly respecting the margins
         using namespace C4ScriptGuiWindowPropertyName;
         const float childLeftMargin = child->CalculateRelativeSize(width, leftMargin, relLeftMargin);
         const float childTopMargin = child->CalculateRelativeSize(height, topMargin, relTopMargin);
         const float childRightMargin = child->CalculateRelativeSize(width, rightMargin, relRightMargin);
         const float childBottomMargin = child->CalculateRelativeSize(height, bottomMargin, relBottomMargin);
  
         const float childWdtF = float(child->rcBounds.Wdt) + childLeftMargin + childRightMargin;
         const float childHgtF = float(child->rcBounds.Hgt) + childTopMargin + childBottomMargin;
  
         auto doLineBreak = [&]()
         {
             currentX = borderX;
             currentY += maxChildHeight + borderY;
             maxChildHeight = 0;
         };
  
         // do all the rounding after the calculations
         const auto childWdt = (int32_t)(childWdtF + 0.5f);
         const auto childHgt = (int32_t)(childHgtF + 0.5f);
  
         // Check if the child even fits in the remainder of the row
         const bool fitsInRow = (width - currentX) >= childWdt;
         if (!fitsInRow) doLineBreak();
  
         // remember the highest child to make sure rows don't overlap
         if (!maxChildHeight || (childHgt > maxChildHeight))
         {
             maxChildHeight = childHgt;
             lowestChildRelY = currentY + childHgt;
         }
         child->rcBounds.x = currentX + static_cast<int32_t>(childLeftMargin);
         child->rcBounds.y = currentY + static_cast<int32_t>(childTopMargin);
  
         currentX += childWdt + borderX;
     }
  
     // do we need a scroll bar?
     EnableScrollBar(lowestChildRelY > height, lowestChildRelY);
 }

References C4ScriptGuiWindowPropertyName::bottomMargin, CalculateRelativeSize(), C4Rect::Hgt, C4ScriptGuiWindowPropertyName::leftMargin, C4GUI::Element::rcBounds, C4ScriptGuiWindowPropertyName::relBottomMargin, C4ScriptGuiWindowPropertyName::relLeftMargin, C4ScriptGuiWindowPropertyName::relRightMargin, C4ScriptGuiWindowPropertyName::relTopMargin, C4ScriptGuiWindowPropertyName::rightMargin, C4ScriptGuiWindowPropertyName::topMargin, C4Rect::Wdt, C4Rect::x, and C4Rect::y.

Referenced by UpdateLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateLayoutTightGrid()

void C4ScriptGuiWindow::UpdateLayoutTightGrid ( )

Definition at line 1463 of file C4ScriptGuiWindow.cpp.

 {
     const int32_t &width = rcBounds.Wdt;
     const int32_t &height = rcBounds.Hgt;
     const int32_t borderX(0), borderY(0);
     int32_t lowestChildRelY = 0;
  
     std::list<C4ScriptGuiWindow*> alreadyPlacedChildren;
  
     for (C4GUI::Element * element : *this)
     {
         C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(element);
         // calculate the space the child needs, correctly respecting the margins
         using namespace C4ScriptGuiWindowPropertyName;
         const float childLeftMargin = child->CalculateRelativeSize(width, leftMargin, relLeftMargin);
         const float childTopMargin = child->CalculateRelativeSize(height, topMargin, relTopMargin);
         const float childRightMargin = child->CalculateRelativeSize(width, rightMargin, relRightMargin);
         const float childBottomMargin = child->CalculateRelativeSize(height, bottomMargin, relBottomMargin);
  
         const float childWdtF = float(child->rcBounds.Wdt) + childLeftMargin + childRightMargin;
         const float childHgtF = float(child->rcBounds.Hgt) + childTopMargin + childBottomMargin;
  
         // do all the rounding after the calculations
         const auto childWdt = (int32_t)(childWdtF + 0.5f);
         const auto childHgt = (int32_t)(childHgtF + 0.5f);
  
         // Look for a free spot.
         int32_t currentX = borderX;
         int32_t currentY = borderY;
  
         bool hadOverlap = false;
         int overlapRepeats = 0;
         do
         {
             auto overlapsWithOther = [&currentX, &currentY, &childWdt, &childHgt](C4ScriptGuiWindow *other)
             {
                 if (currentX + childWdt <= other->rcBounds.x) return false;
                 if (currentY + childHgt <= other->rcBounds.y) return false;
                 if (currentX >= other->rcBounds.GetRight()) return false;
                 if (currentY >= other->rcBounds.GetBottom()) return false;
                 return true;
             };
  
             int32_t currentMinY = 0;
             hadOverlap = false;
             for (auto &other : alreadyPlacedChildren)
             {
                 // Check if the other element is not yet above the new child.
                 if ((other->rcBounds.GetBottom() > currentY) && other->rcBounds.Hgt > 0)
                 {
                     if (currentMinY == 0 || (other->rcBounds.GetBottom() < currentMinY))
                         currentMinY = other->rcBounds.GetBottom();
                 }
                 // If overlapping, we must advance.
                 if (overlapsWithOther(other))
                 {
                     hadOverlap = true;
                     currentX = other->rcBounds.GetRight();
                     // Break line if the element doesn't fit anymore.
                     if (currentX + childWdt > width)
                     {
                         currentX = borderX;
                         // Start forcing change once we start repeating the check. Otherwise, there might
                         // be a composition of children that lead to infinite loop. The worst-case number
                         // of sensible checks might O(N^2) be with a really unfortunate children list.
                         const int32_t forcedMinimalChange = (overlapRepeats > alreadyPlacedChildren.size()) ? 1 : 0;
                         currentY = std::max(currentY + forcedMinimalChange, currentMinY);
                     }
                 }
             }
             overlapRepeats += 1;
         } while (hadOverlap);
  
         alreadyPlacedChildren.push_back(child);
  
         lowestChildRelY = std::max(lowestChildRelY, currentY + childHgt);
         child->rcBounds.x = currentX + static_cast<int32_t>(childLeftMargin);
         child->rcBounds.y = currentY + static_cast<int32_t>(childTopMargin);
     }
  
     // do we need a scroll bar?
     EnableScrollBar(lowestChildRelY > height, lowestChildRelY);
 }

References C4ScriptGuiWindowPropertyName::bottomMargin, CalculateRelativeSize(), C4Rect::Hgt, C4ScriptGuiWindowPropertyName::leftMargin, C4GUI::Element::rcBounds, C4ScriptGuiWindowPropertyName::relBottomMargin, C4ScriptGuiWindowPropertyName::relLeftMargin, C4ScriptGuiWindowPropertyName::relRightMargin, C4ScriptGuiWindowPropertyName::relTopMargin, C4ScriptGuiWindowPropertyName::rightMargin, C4ScriptGuiWindowPropertyName::topMargin, C4Rect::Wdt, C4Rect::x, and C4Rect::y.

Referenced by UpdateLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateLayoutVertical()

void C4ScriptGuiWindow::UpdateLayoutVertical ( )

Definition at line 1547 of file C4ScriptGuiWindow.cpp.

 {
     const int32_t borderY(0);
     int32_t currentY = borderY;
  
     for (C4GUI::Element * element : *this)
     {
         C4ScriptGuiWindow *child = static_cast<C4ScriptGuiWindow*>(element);
  
         // Do the calculations in floats first to not lose accuracy.
         // Take the height of the child and then add the margins.
         using namespace C4ScriptGuiWindowPropertyName;
         const float childTopMargin = child->CalculateRelativeSize(rcBounds.Hgt, topMargin, relTopMargin);
         const float childBottomMargin = child->CalculateRelativeSize(rcBounds.Hgt, bottomMargin, relBottomMargin);
  
         const float childHgtF = float(child->rcBounds.Hgt) + childTopMargin + childBottomMargin;
         const int32_t childHgt = (int32_t)(childHgtF + 0.5f);
  
         child->rcBounds.y = currentY + childTopMargin;
         currentY += childHgt + borderY;
     }
  
     // do we need a scroll bar?
     EnableScrollBar(currentY > rcBounds.Hgt, currentY);
 }

References C4ScriptGuiWindowPropertyName::bottomMargin, CalculateRelativeSize(), C4Rect::Hgt, C4GUI::Element::rcBounds, C4ScriptGuiWindowPropertyName::relBottomMargin, C4ScriptGuiWindowPropertyName::relTopMargin, C4ScriptGuiWindowPropertyName::topMargin, and C4Rect::y.

Referenced by UpdateLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateOwnPos()

void C4GUI::ScrollWindow::UpdateOwnPos ( )

overridevirtualinherited

Reimplemented from C4GUI::Window.

Definition at line 614 of file C4GuiContainers.cpp.

     {
         if (!GetParent()) { Update(); return; }
         // place within client rect
         C4Rect rtBounds = GetParent()->GetContainedClientRect();
         rtBounds.x = rtBounds.y = 0;
         if (fHasBar) rtBounds.Wdt -= C4GUI_ScrollBarWdt;
         if (GetBounds() != rtBounds)
         {
             SetBounds(rtBounds);
             // scroll bar
             if (fHasBar)
             {
                 rtBounds.x += rtBounds.Wdt; rtBounds.Wdt = C4GUI_ScrollBarWdt;
                 pScrollBar->SetBounds(rtBounds);
             }
         }
         // standard updates
         Update();
     }

References C4GUI_ScrollBarWdt, C4GUI::ScrollWindow::fHasBar, C4GUI::Element::GetBounds(), C4GUI::Element::GetContainedClientRect(), C4GUI::Element::GetParent(), C4GUI::ScrollWindow::pScrollBar, C4GUI::Element::SetBounds(), C4GUI::ScrollWindow::Update(), C4Rect::Wdt, C4Rect::x, and C4Rect::y.

Referenced by C4GUI::ScrollWindow::SetScrollBarEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdatePos()

void C4GUI::Element::UpdatePos ( )

protectedvirtualinherited

Reimplemented in C4GUI::Dialog.

Definition at line 193 of file C4Gui.cpp.

     {
         // update own fields
         UpdateOwnPos();
         // notify container
         if (pParent) pParent->ElementPosChanged(this);
     }

References C4GUI::Container::ElementPosChanged(), C4GUI::Element::pParent, and C4GUI::Element::UpdateOwnPos().

Referenced by C4GUI::Element::DoDragging(), C4GUI::ContextMenu::Open(), C4GUI::ProgressBar::ProgressBar(), C4GUI::Element::SetBounds(), C4GUI::Window::SetPos(), and C4GUI::Dialog::UpdatePos().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateSize()

void C4GUI::Element::UpdateSize ( )

protectedvirtualinherited

Reimplemented in C4GUI::Dialog, C4GUI::TextWindow, C4GUI::Tabular, C4GUI::ListBox, C4GUI::MultilineLabel, C4ChatDlg, and C4ChatControl.

Definition at line 185 of file C4Gui.cpp.

     {
         // update own fields
         UpdateOwnPos();
         // notify container
         if (pParent) pParent->ElementSizeChanged(this);
     }

References C4GUI::Container::ElementSizeChanged(), C4GUI::Element::pParent, and C4GUI::Element::UpdateOwnPos().

Referenced by C4FileSelDlg::DefaultListItem::DefaultListItem(), C4GUI::Element::SetBounds(), C4GUI::Label::SetX0(), C4GUI::MultilineLabel::UpdateHeight(), C4GUI::ListBox::UpdateSize(), C4GUI::Tabular::UpdateSize(), C4GUI::TextWindow::UpdateSize(), and C4GUI::Dialog::UpdateSize().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ C4ScriptGuiWindowAction

friend class C4ScriptGuiWindowAction

friend

Definition at line 181 of file C4ScriptGuiWindow.h.

◆ C4ScriptGuiWindowScrollBar

friend class C4ScriptGuiWindowScrollBar

friend

Definition at line 182 of file C4ScriptGuiWindow.h.

Member Data Documentation

◆ currentMouseState

int32_t C4ScriptGuiWindow::currentMouseState

Definition at line 345 of file C4ScriptGuiWindow.h.

Referenced by CreateFromPropList(), Draw(), HasMouseFocus(), OnMouseIn(), OnMouseOut(), ProcessMouseInput(), and ToC4Value().

◆ fDragging

bool C4GUI::Element::fDragging {false}

protectedinherited

Definition at line 380 of file C4Gui.h.

Referenced by C4GUI::Element::StartDragging().

◆ fHasBar

bool C4GUI::ScrollWindow::fHasBar

protectedinherited

Definition at line 945 of file C4Gui.h.

Referenced by C4GUI::ScrollWindow::IsScrollBarEnabled(), C4GUI::ScrollWindow::IsScrollingActive(), C4GUI::ScrollWindow::SetScrollBarEnabled(), and C4GUI::ScrollWindow::UpdateOwnPos().

◆ fVisible

bool C4GUI::Element::fVisible {true}

inherited

Definition at line 383 of file C4Gui.h.

Referenced by C4GUI::Dialog::Draw(), C4GUI::Dialog::FadeIn(), C4GUI::Dialog::FadeOut(), C4GUI::Element::IsVisible(), C4GUI::Element::SetVisibility(), C4StartupModsListEntry::SetVisibility(), C4StartupNetListEntry::SetVisibility(), C4GUI::Dialog::Show(), and C4GUI::ListBox::UpdateElementPositions().

◆ iClientHeight

int32_t C4GUI::ScrollWindow::iClientHeight

protectedinherited

Definition at line 944 of file C4Gui.h.

Referenced by C4GUI::ScrollWindow::IsScrollingNecessary(), C4GUI::ScrollWindow::SetClientHeight(), C4GUI::ScrollWindow::Update(), and UpdateLayout().

◆ iDragX

int32_t C4GUI::Element::iDragX

protectedinherited

Definition at line 379 of file C4Gui.h.

Referenced by C4GUI::Element::DoDragging(), and C4GUI::Element::StartDragging().

◆ iDragY

int32_t C4GUI::Element::iDragY

protectedinherited

Definition at line 379 of file C4Gui.h.

Referenced by C4GUI::Element::DoDragging(), and C4GUI::Element::StartDragging().

◆ iFrozen

int32_t C4GUI::ScrollWindow::iFrozen

protectedinherited

Definition at line 946 of file C4Gui.h.

Referenced by C4GUI::ScrollWindow::Freeze(), C4GUI::ScrollWindow::IsFrozen(), C4GUI::ScrollWindow::UnFreeze(), and C4GUI::ScrollWindow::Update().

◆ iScrollY

int32_t C4GUI::ScrollWindow::iScrollY

protectedinherited

Definition at line 943 of file C4Gui.h.

Referenced by DrawChildren(), C4GUI::ScrollWindow::GetScrollY(), C4GUI::ScrollWindow::IsRangeInView(), MouseInput(), C4GUI::ScrollBar::OnPosChanged(), ProcessMouseInput(), C4GUI::ScrollWindow::ScrollBy(), C4GUI::ScrollWindow::ScrollRangeInView(), C4GUI::ScrollWindow::ScrollToBottom(), C4GUI::ScrollWindow::SetScroll(), C4GUI::ScrollBar::Update(), and C4GUI::ScrollWindow::Update().

◆ pContextHandler

ContextHandler* C4GUI::Element::pContextHandler {nullptr}

protectedinherited

Definition at line 381 of file C4Gui.h.

Referenced by C4GUI::Element::DoContext(), C4GUI::Element::GetContextHandler(), C4GUI::Dialog::GetContextHandler(), C4GUI::Element::SetContextHandler(), and C4GUI::Element::~Element().

◆ pDragTarget

Window* C4GUI::Element::pDragTarget {nullptr}

protectedinherited

Definition at line 378 of file C4Gui.h.

Referenced by C4GUI::Element::DoDragging(), C4GUI::Element::MouseInput(), and C4GUI::Element::SetDragTarget().

◆ pFirst

Element* C4GUI::Container::pFirst

protectedinherited

Definition at line 750 of file C4Gui.h.

◆ pLast

Element * C4GUI::Container::pLast

protectedinherited

Definition at line 750 of file C4Gui.h.

Referenced by C4GUI::Container::AddElement(), C4GUI::Container::ClearChildren(), C4GUI::Container::Container(), C4GUI::Screen::GetDialog(), C4GUI::Container::GetFirstNestedElement(), C4GUI::Container::GetLast(), C4GUI::Container::GetLastContained(), C4GUI::Screen::GetTopDialog(), C4Menu::InitSize(), C4GUI::Container::MakeLastElement(), C4GUI::Window::MouseInput(), C4GUI::Screen::MouseInput(), C4GUI::Container::rbegin(), C4GUI::Container::ReaddElement(), C4GUI::Container::RemoveElement(), and C4Menu::UpdateScrollBar().

◆ pNext

Element * C4GUI::Element::pNext

protectedinherited

Definition at line 377 of file C4Gui.h.

◆ pParent

Container* C4GUI::Element::pParent {nullptr}

protectedinherited

Definition at line 376 of file C4Gui.h.

Referenced by C4GUI::Container::AddElement(), C4GUI::Container::AfterElementRemoval(), C4GUI::Container::ClearChildren(), C4GUI::Element::ClientPos2ScreenPos(), C4GUI::ScrollWindow::ElementPosChanged(), C4GUI::ScrollWindow::ElementSizeChanged(), C4GUI::Element::GetContainer(), C4GUI::Element::GetContextHandler(), C4GUI::Element::GetDlg(), C4GUI::Container::GetNextNestedElement(), C4GUI::Element::GetParent(), C4GUI::Element::GetScreen(), C4GUI::Element::GetToolTip(), C4GUI::Control::HasFocus(), C4GUI::Container::InsertElement(), C4GUI::Container::IsFocused(), C4GUI::Container::IsSelectedChild(), C4GUI::Element::IsVisible(), C4GUI::Container::MakeLastElement(), C4GUI::Container::ReaddElement(), C4GUI::Element::RemoveElement(), C4GUI::Container::RemoveElement(), C4GUI::Element::ScreenPos2ClientPos(), C4GUI::Element::UpdatePos(), C4GUI::Element::UpdateSize(), and C4GUI::Element::~Element().

◆ pPrev

Element* C4GUI::Element::pPrev

protectedinherited

Definition at line 377 of file C4Gui.h.

Referenced by C4GUI::Container::AddElement(), C4GUI::Container::ClearChildren(), C4GUI::Container::GetNextNestedElement(), C4GUI::Element::GetPrev(), C4GUI::Container::InsertElement(), C4GUI::Container::MakeLastElement(), C4GUI::Container::ReaddElement(), C4GUI::Container::RemoveElement(), and C4Menu::UpdateElementPositions().

◆ pScrollBar

ScrollBar* C4GUI::ScrollWindow::pScrollBar

protectedinherited

Definition at line 942 of file C4Gui.h.

Referenced by Draw(), DrawChildren(), C4GUI::ScrollWindow::IsScrollingActive(), ProcessMouseInput(), C4GUI::ScrollWindow::ScrollWindow(), C4GUI::ScrollWindow::SetDecoration(), C4GUI::ScrollWindow::SetScrollBarEnabled(), C4GUI::ScrollWindow::Update(), UpdateLayout(), C4GUI::ScrollWindow::UpdateOwnPos(), ~C4ScriptGuiWindow(), C4GUI::ScrollBar::~ScrollBar(), and C4GUI::ScrollWindow::~ScrollWindow().

◆ rcBounds

C4Rect C4GUI::Element::rcBounds

protectedinherited

Definition at line 385 of file C4Gui.h.

◆ rcClientRect

C4Rect C4GUI::Window::rcClientRect

protectedinherited

Definition at line 851 of file C4Gui.h.

Referenced by C4GUI::Window::ApplyElementOffset(), C4GUI::Window::ApplyInvElementOffset(), C4GUI::Window::Draw(), C4GUI::Edit::DrawElement(), C4ScoreboardDlg::DrawElement(), C4GUI::FullscreenDialog::FullscreenDialog(), C4GUI::Window::GetClientRect(), C4GUI::Window::MouseInput(), C4GUI::ScrollWindow::SetScroll(), C4GUI::ScrollWindow::Update(), and C4GUI::Window::UpdateOwnPos().

◆ standardHeight

const float C4ScriptGuiWindow::standardHeight = 31.0f

static

Definition at line 186 of file C4ScriptGuiWindow.h.

Referenced by UpdateLayout().

◆ standardWidth

const float C4ScriptGuiWindow::standardWidth = 50.0f

static

Definition at line 185 of file C4ScriptGuiWindow.h.

Referenced by UpdateLayout().

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

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ MouseState

Constructor & Destructor Documentation

◆ C4ScriptGuiWindow()

◆ ~C4ScriptGuiWindow()

Member Function Documentation

◆ AddChild() [1/2]

◆ AddChild() [2/2]

◆ AddElement()

◆ AfterElementRemoval()

◆ ApplyElementOffset()

◆ ApplyInvElementOffset()

◆ begin()

◆ CalculateRelativeSize()

◆ CheckNameHotkey()

◆ Clear()

◆ ClearChildren() [1/2]

◆ ClearChildren() [2/2]

◆ ClearPointers()

◆ ClientPos2ScreenPos()

◆ Close()

◆ CreateFromPropList()

◆ Denumerate()

◆ DoContext()

◆ DoDragging()

◆ Draw() [1/2]

◆ Draw() [2/2]

◆ Draw3DFrame()

◆ DrawAll()

◆ DrawBar()

◆ DrawChildren()

◆ DrawElement()

◆ DrawHBarByVGfx()

◆ DrawHVBar()

◆ DrawVBar()

◆ ElementPosChanged()

◆ ElementSizeChanged()

◆ end()

◆ ExecuteCommand()

◆ Freeze()

◆ GetBounds()

◆ GetChildByID()

◆ GetChildByName()

◆ GetClientRect()

◆ GetClippingRect()

◆ GetContainedClientRect()

◆ GetContainer()

◆ GetContextHandler()

◆ GetDialogWindow()

◆ GetDlg()

◆ GetElementByIndex()

◆ GetElementCount()

◆ GetFirst()

◆ GetFirstContained()

◆ GetFirstNestedElement()

◆ GetHeight()

◆ GetID()

◆ GetLast()

◆ GetLastContained()

◆ GetListItemTopSpacing()

◆ GetListItemTopSpacingBar()

◆ GetMarginBottom()

◆ GetMarginLeft()

◆ GetMarginRight()

◆ GetMarginTop()

◆ GetNext()

◆ GetNextNestedElement()

◆ GetOwnToolTip()

◆ GetParent()

◆ GetPrev()

◆ GetScreen()

◆ GetScrollY()