ui_node_window.h

Go to the documentation of this file.

/*
Copyright (C) 2002-2020 UFO: Alien Invasion.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#pragma once

#include "../../../shared/mathlib.h"
#include "ui_node_abstractnode.h"

/* prototype */
struct uiNode_t;
struct uiAction_s;
struct uiBehaviour_t;
struct uiKeyBinding_s;

class uiWindowNode : public uiLocatedNode {
    void draw(uiNode_t* node) override;
    void initNode(uiNode_t* node) override;
    void deleteNode(uiNode_t* node) override;
    void doLayout(uiNode_t* node) override;
    void onLoading(uiNode_t* node) override;
    void onLoaded(uiNode_t* node) override;
    void onWindowOpened(uiNode_t* node, linkedList_t* params) override;
    void onWindowClosed(uiNode_t* node) override;
    void onWindowActivate(uiNode_t* node) override;
    void onSizeChanged(uiNode_t* node) override;
    void clone(uiNode_t const* source, uiNode_t* clone) override;
public:
    void setFill(uiNode_t* node, bool value);
};

#define INDEXEDCHILD_HASH_SIZE 32

typedef struct node_index_s {
    uiNode_t* node;
    struct node_index_s* hash_next;
    struct node_index_s* next;
} node_index_t;

typedef struct {
    vec2_t noticePos;           
    bool dragButton;            
    bool closeButton;           
    bool preventTypingEscape;   
    bool modal;                 
    bool dropdown;              
    bool isFullScreen;          
    bool fill;                  
    bool starLayout;            
    uiNode_t* parent;           
    struct uiKeyBinding_s* keyList;     
    struct uiAction_s* onWindowOpened;  
    struct uiAction_s* onWindowClosed;  
    struct uiAction_s* onWindowActivate;
    struct uiAction_s* onScriptLoaded;  
    LUA_EVENT lua_onWindowOpened;
    LUA_EVENT lua_onWindowClosed;
    LUA_EVENT lua_onWindowActivate;
    LUA_EVENT lua_onScriptLoaded;

    node_index_t* index;
    node_index_t* index_hash[INDEXEDCHILD_HASH_SIZE];

    uiSprite_t* background;
} windowExtraData_t;

void UI_RegisterWindowNode(uiBehaviour_t* behaviour);
bool UI_WindowIsFullScreen(uiNode_t const* window);
bool UI_WindowIsDropDown(uiNode_t const* window);
bool UI_WindowIsModal(uiNode_t const* window);
void UI_WindowNodeRegisterKeyBinding(uiNode_t* window, struct uiKeyBinding_s* binding);
struct uiKeyBinding_s* UI_WindowNodeGetKeyBinding(uiNode_t const* node, unsigned int key);
vec_t* UI_WindowNodeGetNoticePosition(uiNode_t* node);
/* child index */
uiNode_t* UI_WindowNodeGetIndexedChild(uiNode_t* node, const char* childName);
bool UI_WindowNodeAddIndexedNode(uiNode_t* node, uiNode_t* child);
bool UI_WindowNodeRemoveIndexedNode(uiNode_t* node, uiNode_t* child);

void UI_Window_SetBackgroundByName(uiNode_t* node, const char* name);
void UI_Window_SetCloseButton(uiNode_t* node, bool value);
void UI_Window_SetDragButton(uiNode_t* node, bool value);
void UI_Window_FlagFullscreen(uiNode_t* node);

void UI_WindowNode_SetFill(uiNode_t* node, bool value);