ui_nodes.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_NODES_H
#define CLIENT_UI_UI_NODES_H

#include "../../shared/ufotypes.h"
#include "../../common/scripts.h"

/* prototype */
struct uiIcon_s;
struct value_s;
struct nodeKeyBinding_s;
struct uiCallContext_s;
struct uiNode_s;
struct uiModel_s;

/* exclude rect */
#define UI_MAX_EXLUDERECTS  64

typedef struct uiExcludeRect_s {
    vec2_t pos, size;
} uiExcludeRect_t;

typedef void (*uiNodeMethod_t)(struct uiNode_s*node, const struct uiCallContext_s *context);

typedef struct uiNode_s {
    /* common identification */
    char name[MAX_VAR];         
    struct uiBehaviour_s *behaviour;
    struct uiNode_s *super; 
    qboolean dynamic;           
    qboolean indexed;           
    /* common navigation */
    struct uiNode_s *firstChild;    
    struct uiNode_s *lastChild;     
    struct uiNode_s *next;          
    struct uiNode_s *parent;        
    struct uiNode_s *root;          
    /* common pos */
    vec2_t pos;
    vec2_t size;

    /* common attributes */
    const char* tooltip;        
    struct uiKeyBinding_s *key; 
    qboolean invis;             
    qboolean disabled;          
    qboolean invalidated;       
    qboolean ghost;             
    qboolean state;             
    int padding;                
    int align;                  
    int num;                    
    struct uiAction_s* visibilityCondition; 
    uiExcludeRect_t *excludeRect;   
    int excludeRectNum;         
    /* other attributes */
    int textalign;              
    char* text;                 
    const char* font;           
    void* image;
    int border;                 
    vec4_t bgcolor;             
    vec4_t bordercolor;         
    vec4_t color;               
    vec4_t selectedColor;       
    /* common events */
    struct uiAction_s *onClick;
    struct uiAction_s *onRightClick;
    struct uiAction_s *onMiddleClick;
    struct uiAction_s *onWheel;
    struct uiAction_s *onMouseEnter;
    struct uiAction_s *onMouseLeave;
    struct uiAction_s *onWheelUp;
    struct uiAction_s *onWheelDown;
    struct uiAction_s *onChange;    
} uiNode_t;


#define UI_EXTRADATA_POINTER(NODE, TYPE) ((TYPE*)((char*)NODE + sizeof(uiNode_t)))
#define UI_EXTRADATA(NODE, TYPE) (*UI_EXTRADATA_POINTER(NODE, TYPE))
#define UI_EXTRADATACONST_POINTER(NODE, TYPE) ((TYPE*)((const char*)NODE + sizeof(uiNode_t)))
#define UI_EXTRADATACONST(NODE, TYPE) (*UI_EXTRADATACONST_POINTER(NODE, const TYPE))

#define UI_EXTRADATA_OFFSETOF(TYPE, MEMBER) ((size_t) &((TYPE *)(UI_EXTRADATA_POINTER(0, TYPE)))->MEMBER)

typedef struct uiBehaviour_s {
    /* behaviour attributes */
    const char* name;               
    const char* extends;            
    qboolean isVirtual;             
    qboolean isFunction;            
    qboolean isAbstract;            
    qboolean isInitialized;         
    qboolean focusEnabled;          
    qboolean drawItselfChild;       
    const value_t* properties;      
    int propertyCount;              
    intptr_t extraDataSize;         
    struct uiBehaviour_s *super;    
#ifdef DEBUG
    int count;                      
#endif

    /* draw callback */
    void (*draw)(uiNode_t *node);                           
    void (*drawTooltip)(uiNode_t *node, int x, int y);  
    void (*drawOverWindow)(uiNode_t *node);                 
    /* mouse events */
    void (*leftClick)(uiNode_t *node, int x, int y);        
    void (*rightClick)(uiNode_t *node, int x, int y);       
    void (*middleClick)(uiNode_t *node, int x, int y);  
    void (*mouseWheel)(uiNode_t *node, qboolean down, int x, int y);    
    void (*mouseMove)(uiNode_t *node, int x, int y);
    void (*mouseDown)(uiNode_t *node, int x, int y, int button);    
    void (*mouseUp)(uiNode_t *node, int x, int y, int button);  
    void (*capturedMouseMove)(uiNode_t *node, int x, int y);
    void (*capturedMouseLost)(uiNode_t *node);

    /* system allocation */
    void (*loading)(uiNode_t *node);        
    void (*loaded)(uiNode_t *node);     
    void (*clone)(const uiNode_t *source, uiNode_t *clone);         
    void (*new)(uiNode_t *node);            
    void (*delete)(uiNode_t *node);     
    /* system callback */
    void (*init)(uiNode_t *node);           
    void (*close)(uiNode_t *node);      
    void (*doLayout)(uiNode_t *node);       
    void (*activate)(uiNode_t *node);       
    void (*propertyChanged)(uiNode_t *node, const value_t *property);       
    void (*sizeChanged)(uiNode_t *node);        
    void (*getClientPosition)(uiNode_t *node, vec2_t position); 
    /* drag and drop callback */
    qboolean (*dndEnter)(uiNode_t *node);                           
    qboolean (*dndMove)(uiNode_t *node, int x, int y);          
    void (*dndLeave)(uiNode_t *node);                               
    qboolean (*dndDrop)(uiNode_t *node, int x, int y);          
    qboolean (*dndFinished)(uiNode_t *node, qboolean isDroped); 
    /* focus and keyboard events */
    void (*focusGained)(uiNode_t *node);
    void (*focusLost)(uiNode_t *node);
    qboolean (*keyPressed)(uiNode_t *node, unsigned int key, unsigned short unicode);

    /* Planned */
#if 0
    /* mouse move event */
    void (*mouseEnter)(uiNode_t *node);
    void (*mouseLeave)(uiNode_t *node);
#endif
} uiBehaviour_t;

/* module initialization */
void UI_InitNodes(void);

/* nodes */
uiNode_t* UI_AllocNode(const char* name, const char* type, qboolean isDynamic);
uiNode_t* UI_GetNodeByPath(const char* path) __attribute__ ((warn_unused_result));
void UI_ReadNodePath(const char* path, const uiNode_t *relativeNode, uiNode_t** resultNode, const value_t **resultProperty);
struct uiNode_s *UI_GetNodeAtPosition(int x, int y) __attribute__ ((warn_unused_result));
const char* UI_GetPath(const uiNode_t* node) __attribute__ ((warn_unused_result));
struct uiNode_s *UI_CloneNode(const struct uiNode_s * node, struct uiNode_s *newWindow, qboolean recursive, const char *newName, qboolean isDynamic) __attribute__ ((warn_unused_result));
qboolean UI_CheckVisibility(uiNode_t *node);
void UI_DeleteAllChild(uiNode_t* node);
void UI_DeleteNode(uiNode_t* node);

/* behaviours */
uiBehaviour_t* UI_GetNodeBehaviour(const char* name) __attribute__ ((warn_unused_result));
uiBehaviour_t* UI_GetNodeBehaviourByIndex(int index) __attribute__ ((warn_unused_result));
int UI_GetNodeBehaviourCount(void) __attribute__ ((warn_unused_result));
const struct value_s *UI_GetPropertyFromBehaviour(const uiBehaviour_t *behaviour, const char* name) __attribute__ ((warn_unused_result));

#endif