ui_node_window.h

Go to the documentation of this file.

/*
Copyright (C) 2002-2010 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.

*/

#ifndef CLIENT_UI_UI_NODE_WINDOW_H
#define CLIENT_UI_UI_NODE_WINDOW_H

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

/* prototype */
struct uiNode_s;
struct uiAction_s;
struct uiBehaviour_s;
struct uiKeyBinding_s;

extern const struct uiBehaviour_s const *ui_windowBehaviour;

#define INDEXEDCHILD_HASH_SIZE 32

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

typedef struct {
    int eventTime;
    vec2_t noticePos;               
    qboolean dragButton;            
    qboolean closeButton;           
    qboolean preventTypingEscape;   
    qboolean modal;                 
    qboolean dropdown;              
    qboolean isFullScreen;          
    qboolean fill;                  
    qboolean starLayout;            
    int timeOut;                    
    int lastTime;                   
    struct uiNode_s *parent;    
    struct uiNode_s *renderNode;

    struct uiKeyBinding_s *keyList; 
    struct uiAction_s *onInit;  
    struct uiAction_s *onClose; 
    struct uiAction_s *onTimeOut;   
    node_index_t *index;
    node_index_t *index_hash[INDEXEDCHILD_HASH_SIZE];

} windowExtraData_t;

void UI_RegisterWindowNode(struct uiBehaviour_s *behaviour);

qboolean UI_WindowIsFullScreen(const struct uiNode_s* const window);
qboolean UI_WindowIsDropDown(const struct uiNode_s* const window);
qboolean UI_WindowIsModal(const struct uiNode_s* const window);
void UI_WindowNodeRegisterKeyBinding(struct uiNode_s* window, struct uiKeyBinding_s *binding);
struct uiKeyBinding_s *UI_WindowNodeGetKeyBinding(const struct uiNode_s* const node, unsigned int key);
void UI_WindowNodeSetRenderNode(struct uiNode_s *node, struct uiNode_s *renderNode);
vec_t *UI_WindowNodeGetNoticePosition(struct uiNode_s *node);
/* child index */
struct uiNode_s* UI_WindowNodeGetIndexedChild(struct uiNode_s* const node, const char* childName);
qboolean UI_WindowNodeAddIndexedNode(struct uiNode_s* const node, struct uiNode_s* const child);
qboolean UI_WindowNodeRemoveIndexedNode(struct uiNode_s* const node, struct uiNode_s* const child);

#endif