---

Gadget.h

Go to the documentation of this file.

/*
 *    gui - [gega user interface] the flexible solution for user interface problems
 *    Copyright (C) 2002  Gergely Gati
 *
 *    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; version 2 of the License.
 *
 *    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
 *
 *    Gergely Gati
 *      email:           g.gati@freemail.hu
 *      AIM screenname:  GatiGergely
 *      ICQ number:      93131690
 *
 */
/*
 *  gadget.h
 */

#ifndef __GADGET_H
#define __GADGET_H

#include "types.h"
#include "Bases.h"
#include "Skin.h"


/*
 *  Defines
 */

#define GADST_COUNT           5

#define GADST_NORMAL          (0)
#define GADST_PRESSED         (1)
#define GADST_DISABLED        (2)
#define GADST_FOCUSED         (3)
#define GADST_DEFAULT         (4)
#define GADST_NONE            GADST_COUNT

#define GADSTF_NORMAL         (1L<<GADST_NORMAL)
#define GADSTF_PRESSED        (1L<<GADST_PRESSED)
#define GADSTF_DISABLED       (1L<<GADST_DISABLED)
#define GADSTF_FOCUSED        (1L<<GADST_FOCUSED)
#define GADSTF_DEFAULT        (1L<<GADST_DEFAULT)

#define GADGET_MAXIMUM_SIZE 0x1000
#define GADGET_TAGBASE      0x1000

#define GADGET_ILLEGAL_ID     0
#define GADGET_SYSBASE        0x6000
#define GADGET_SUBGADGET_BASE 0x7000
#define GADGET_NOID           0x8000

#define GADGET_DEFAULT_FONTNAME       "Arial"
#define GADGET_DEFAULT_FONTSIZE       (16)
#define GADGET_DEFAULT_FONTSTYLE      (0L)
#define GADGET_DEFAULT_FONTWEIGHT     (0L)
#define GADGET_DEFAULT_FONTDECORATION (0L)

#define GADGET_FONTSTYLE_ITALIC            (1)
#define GADGET_FONTWEIGHT_BOLD             (1)
#define GADGET_FONTDECORATION_UNDERLINED   (1)

#define GADGET_DESCRIPTOR_DONE   {-1,NULL,0,0,NULL}

// flags for gadget_RenderCustom()
#define GADGET_CUS_BACKGROUND    (1L<<0)
#define GADGET_CUS_LAYOUT        (1L<<1)
#define GADGET_CUS_REFRESH       (1L<<2)

#define GADGET_METHOD_DONE {NULL,NULL,0L}
#define GADGET_METHOD_MAX_COUNT 512
#define GADGET_METHOD_BASE 16

#define GADGET_METHOD_VOID  (1L<<0)

// values for TAG_GAD_LAYOUT
#define GADGET_LAYOUT_FREE   0
#define GADGET_LAYOUT_FIXED  1
#define GADGET_LAYOUT_SQUARE 2

#define TAG_GAD_HINT            ((TAG_USER+1)|TAGT_STRING)
#define TAG_GAD_FONTNAME        ((TAG_USER+2)|TAGT_STRING)
#define TAG_GAD_FONTSIZE        (TAG_USER+3)
#define TAG_GAD_FONTWEIGHT      (TAG_USER+4)
#define TAG_GAD_FONTSTYLE       (TAG_USER+5)
#define TAG_GAD_FONTDECORATION  (TAG_USER+6)
#define TAG_GAD_SKIN            ((TAG_USER+7)|TAGT_STRING)
#define TAG_GAD_WIDTH           (TAG_USER+8)
#define TAG_GAD_HEIGHT          (TAG_USER+9)
#define TAG_GAD_LAYOUT          (TAG_USER+10)
#define TAG_GAD_EXTMIN          (TAG_USER+11)
#define TAG_GAD_EXTMAX          (TAG_USER+12)
#define TAG_GAD_RECT            (TAG_USER+13)

//newly defined tags BEGIN
#define TAG_GADGET_STATE_NAME           ((TAG_USER+100)|TAGT_STRING)
#define TAG_GADGET_CLASS_ID             (TAG_USER+101)
#define TAG_GADGET_NAME                 ((TAG_USER+102)|TAGT_STRING)
#define TAG_GADGET_CLASS_DATA           (TAG_USER+103)
#define TAG_GADGET_GADGET_SIZE          (TAG_USER+104)
#define TAG_GADGET_METHODS              (TAG_USER+105)
#define TAG_GADGET_BINDING              (TAG_USER+106)
#define TAG_GADGET_COLOR_NAMES          (TAG_USER+107)
#define TAG_GADGET_CUSTOM_NAMES         (TAG_USER+108)
#define TAG_GADGET_STATE_MASK           (TAG_USER+109)
#define TAG_GADGET_CLASS_NAME           ((TAG_USER+110)|TAGT_STRING)
#define TAG_GADGET_OBJECT               (TAG_USER+111)
#define TAG_GADGET_INDEX                (TAG_USER+112)
#define TAG_GADGET_ROOT                 (TAG_USER+113)
#define TAG_GADGET_NEW_PARENT           (TAG_USER+114)
#define TAG_GADGET_NEW_CHILD            (TAG_USER+115)
#define TAG_GADGET_STATE                (TAG_USER+116)
#define TAG_GADGET_VISUAL               (TAG_USER+117)
#define TAG_GADGET_EVENT                (TAG_USER+118)
#define TAG_GADGET_SIZE                 (TAG_USER+119)
#define TAG_GADGET_COLOR                (TAG_USER+120)
#define TAG_GADGET_DESCRIPTOR           (TAG_USER+121)
#define TAG_GADGET_WINDOW               (TAG_USER+122)
#define TAG_GADGET_PARENT               (TAG_USER+123)
#define TAG_GADGET_GADGET_ID            (TAG_USER+124)
#define TAG_GADGET_RECT                 (TAG_USER+125)
#define TAG_GADGET_CUSTOM               (TAG_USER+126)
#define TAG_GADGET_FLAGS                (TAG_USER+127)
#define TAG_GADGET_HIDDEN               (TAG_USER+128)
#define TAG_GADGET_MIN                  (TAG_USER+129)
#define TAG_GADGET_MAX                  (TAG_USER+130)
#define TAG_GADGET_TAGLIST              (TAG_USER+131)
#define TAG_GADGET_EVENT_DATA           (TAG_USER+132)
#define TAG_GADGET_METHOD               (TAG_USER+133)
#define TAG_GADGET_MODULE               (TAG_USER+134)
#define TAG_GADGET_INPUT_EVENT_HANDLER  (TAG_USER+135)
#define TAG_GADGET_EVENT_HANDLER        (TAG_USER+136)
#define TAG_GADGET_GADGET_EVENT_HANDLER (TAG_USER+137)
#define TAG_GADGET_MEM                  (TAG_USER+138)
#define TAG_GADGET_LOCALE               (TAG_USER+139)
#define TAG_GADGET_VALUE                ((TAG_USER+140)|TAGT_STRING)
#define TAG_GADGET_TAGNAME              (TAG_USER+141)
#define TAG_GADGET_TAGVALUE             (TAG_USER+142)
//newly defined tags END


#define MET_GAD_SET_FONT    (0)
#define MET_GAD_SET_HINT    (1)
#define GADGET_METHOD_COUNT (2)

/*
 *  Flags for gadget_ClassData_t.
 */

#define GAD_INVISIBLE (1L<<0)

#define GADGET_ILLEGAL_CLASS 0L

/*
 *  Flags for gadget.
 */

#define GAD_HIDDEN   (1L<<0)
#define GAD_LOCALIZE (1L<<1)
#define GAD_ONSCREEN (1L<<2)


//Enum for calling BEGIN
enum gadget_functions
{
  GADGET_GET_STATE_NAME=GADGET_FUNCBASE,
  GADGET_REGISTER_CLASS,
  GADGET_FIND_CLASS,
  GADGET_FIND_CLASS_BY_NAME,
  GADGET_FATHER,
  GADGET_FIRST_CHILD,
  GADGET_LAST_CHILD,
  GADGET_NTH_CHILD,
  GADGET_LEFT_BROTHER,
  GADGET_RIGHT_BROTHER,
  GADGET_FIRST_BROTHER,
  GADGET_LAST_BROTHER,
  GADGET_LEFT_BROTHER_CIRCULAR,
  GADGET_RIGHT_BROTHER_CIRCULAR,
  GADGET_FIRST_NODE,
  GADGET_NEXT_NODE,
  GADGET_ATTACH_FIRST,
  GADGET_ATTACH,
  GADGET_DETACH,
  GADGET_SET_STATE,
  GADGET_POST_MESSAGE,
  GADGET_GET_FONT,
  GADGET_GET_COLOR,
  GADGET_GET_STATE,
  GADGET_NEW,
  GADGET_DELETE_SUBTREE,
  GADGET_SEARCH,
  GADGET_SEARCH_IN_WINDOW,
  GADGET_RENDER_CUSTOM,
  GADGET_REFRESH,
  GADGET_FIND_PARENT,
  GADGET_HIDE_ALL,
  GADGET_FIND_RIGHT_MOST,
  GADGET_GET_HINT,
  GADGET_GET_EXTENT,
  GADGET_GET_RECT,
  GADGET_SUGGEST_EXTENT,
  GADGET_DELETE_GADGET,
  GADGET_INIT_GADGET,
  GADGET_INPUT_EVENT_HANDLER,
  GADGET_LAYOUT,
  GADGET_DAMAGE,
  GADGET_CALLBACK,
  GADGET_GET_UNIQUE_ID,
  GADGET_METHODCALL,
  GADGET_SAVE,
  GADGET_RESTORE,
  GADGET_BIND,
  GADGET_FUNC_DONE
};
//Enum for calling END


/*
 *  Gadget callback message types.
 */

#define CBK_GADGET_DOWN               (1L<<0)
#define CBK_GADGET_UP                 (1L<<1)
#define CBK_GADGET_MOVE               (1L<<2)
#define CBK_GADGET_HINT               (1L<<3)
#define CBK_GADGET_CLICKED            (1L<<4)
#define CBK_WINDOW_OPENED             (1L<<5)
#define CBK_WINDOW_CLOSE              (1L<<6)
#define CBK_WINDOW_SIZE               (1L<<7)
#define CBK_WINDOW_OUTPUT             (1L<<8)
#define CBK_CHILD_WINDOW_OPENED       (1L<<9)
#define CBK_CHILD_WINDOW_CLOSED       (1L<<10)
#define CBK_WINDOW_CLOSED             (1L<<11)
#define CBK_WINDOW_ACTIVATED          (1L<<12)
#define CBK_WINDOW_INACTIVATED        (1L<<13)

enum gadget_events
{
  GADEV_INIT_GADGET,
  GADEV_DELETE_GADGET,
  GADEV_GET_EXTENT,
  GADEV_SUGGEST_EXTENT,
  GADEV_LAYOUT,
  GADEV_DAMAGE,
  GADEV_SAVE,
  GADEV_RESTORE,
  GADEV_COUNT
};

#define GADGET_BINDING_DONE {NULL,0L,0,NULL}

#define GADGET_INVALID  0
#define GADGET_INT      1
#define GADGET_STRING   2
#define GADGET_SELECT   3
#define GADGET_BOOL     4

// gxml_Check flags
#define GADGET_REQUIRED  (1<<1)

#define GADGET_CHECK_DONE { GADGET_ILLEGAL_ID, GADGET_ILLEGAL_CLASS, 0L }


/*
 *  Typedefs
 */


typedef struct
{
  char *name;
  u32 tagname;
  int datatype;       // GDT_INT, GDT_STRING, GDT_SELECT, GDT_BOOL
  char *value_mask;   // szabvanyos kifejezes stringnel
} gadget_Binding_t;

typedef struct
{
  u32 gadget_id;
  char *class_name;
  int flags;
} gadget_Check_t;


struct gadget_Descriptor_s
{
  int level;
  char *class_name;
  u32 gadget_id;
  int weight;
  tag *taglist;
};


typedef struct
{
  char *name;
  u32 (*function)(Gadget_t *this, tag *taglist);
  int flags;
} gadget_Method_t;


typedef struct
{
  u32 class_id;
  u32 module;
  char *class_name;
  int gadget_counter;
  int gadget_size;
  int (*input_event_handler)(Gadget_t *this, struct glw_Event *event);
  int (*event_handler)(Gadget_t *this, Gadget_t *sender, int event, u32 event_data);
  int (*gadget_event_handler)(Gadget_t *this, int event, tag *taglist);
  int flags;
  int method_count;
  gadget_Method_t *methods;
  gadget_Binding_t *xmlbinding;
  u32 state_mask;
  int color_count;
  char **color_names;
  int custom_count;
  char **custom_names;
} gadget_ClassData_t;



struct Gadget_s
{
  Window_t *window;
  Gadget_t *parent;
  Gadget_t *next;
  Gadget_t *prev;
  Gadget_t *firstchild;
  Gadget_t *lastchild;
  u32 gadget_id;
  gadget_ClassData_t *class_data;
  Rect_t rect;
  int weight;
  char *hint;
  u32 font;
  int layout;                 // GADGET_LAYOUT_FREE|GADGET_LAYOUT_FIXED|GADGET_LAYOUT_SQUARE
  int layout_width;
  int layout_height;
  int flags;
  int state;
  u32 callback_discard_mask;
  u32 *color_table[GADST_COUNT];
  void *skin;
  u32 skincrc;
};


/*
 *  Prototypes
 */

//system only
int gadget_Init(void);
void gadget_CleanUp(void);
gadget_Binding_t *gadget_GetCommonBind(void);
void gadget_SetDiscardMask(Gadget_t *this, u32 add_event, u32 remove_event);
int gadget_LoadClass(gui_App_t *app, char *class, Skin_t *skin);
int gadget_ChangeSkin(Gadget_t *this, Skin_t *skin);

//TAGLIST->

u32 gadget_Call(int function, u32 firsttag, ...);
u32 gadget_CallTL(int function, tag *taglist);

//Prototypes BEGIN
u32 gadget_GetStateName(u32 firsttag, ...);
u32 gadget_GetStateNameTL(tag *taglist);
u32 gadget_RegisterClass(u32 firsttag, ...);
u32 gadget_RegisterClassTL(tag *taglist);
u32 gadget_FindClass(u32 firsttag, ...);
u32 gadget_FindClassTL(tag *taglist);
u32 gadget_FindClassByName(u32 firsttag, ...);
u32 gadget_FindClassByNameTL(tag *taglist);
u32 gadget_Father(u32 firsttag, ...);
u32 gadget_FatherTL(tag *taglist);
u32 gadget_FirstChild(u32 firsttag, ...);
u32 gadget_FirstChildTL(tag *taglist);
u32 gadget_LastChild(u32 firsttag, ...);
u32 gadget_LastChildTL(tag *taglist);
u32 gadget_NthChild(u32 firsttag, ...);
u32 gadget_NthChildTL(tag *taglist);
u32 gadget_LeftBrother(u32 firsttag, ...);
u32 gadget_LeftBrotherTL(tag *taglist);
u32 gadget_RightBrother(u32 firsttag, ...);
u32 gadget_RightBrotherTL(tag *taglist);
u32 gadget_FirstBrother(u32 firsttag, ...);
u32 gadget_FirstBrotherTL(tag *taglist);
u32 gadget_LastBrother(u32 firsttag, ...);
u32 gadget_LastBrotherTL(tag *taglist);
u32 gadget_LeftBrotherCircular(u32 firsttag, ...);
u32 gadget_LeftBrotherCircularTL(tag *taglist);
u32 gadget_RightBrotherCircular(u32 firsttag, ...);
u32 gadget_RightBrotherCircularTL(tag *taglist);
u32 gadget_FirstNode(u32 firsttag, ...);
u32 gadget_FirstNodeTL(tag *taglist);
u32 gadget_NextNode(u32 firsttag, ...);
u32 gadget_NextNodeTL(tag *taglist);
u32 gadget_AttachFirst(u32 firsttag, ...);
u32 gadget_AttachFirstTL(tag *taglist);
u32 gadget_Attach(u32 firsttag, ...);
u32 gadget_AttachTL(tag *taglist);
u32 gadget_Detach(u32 firsttag, ...);
u32 gadget_DetachTL(tag *taglist);
u32 gadget_SetState(u32 firsttag, ...);
u32 gadget_SetStateTL(tag *taglist);
u32 gadget_PostMessage(u32 firsttag, ...);
u32 gadget_PostMessageTL(tag *taglist);
u32 gadget_GetFont(u32 firsttag, ...);
u32 gadget_GetFontTL(tag *taglist);
u32 gadget_GetColor(u32 firsttag, ...);
u32 gadget_GetColorTL(tag *taglist);
u32 gadget_GetState(u32 firsttag, ...);
u32 gadget_GetStateTL(tag *taglist);
u32 gadget_New(u32 firsttag, ...);
u32 gadget_NewTL(tag *taglist);
u32 gadget_DeleteSubtree(u32 firsttag, ...);
u32 gadget_DeleteSubtreeTL(tag *taglist);
u32 gadget_Search(u32 firsttag, ...);
u32 gadget_SearchTL(tag *taglist);
u32 gadget_SearchInWindow(u32 firsttag, ...);
u32 gadget_SearchInWindowTL(tag *taglist);
u32 gadget_RenderCustom(u32 firsttag, ...);
u32 gadget_RenderCustomTL(tag *taglist);
u32 gadget_Refresh(u32 firsttag, ...);
u32 gadget_RefreshTL(tag *taglist);
u32 gadget_FindParent(u32 firsttag, ...);
u32 gadget_FindParentTL(tag *taglist);
u32 gadget_HideAll(u32 firsttag, ...);
u32 gadget_HideAllTL(tag *taglist);
u32 gadget_FindRightMost(u32 firsttag, ...);
u32 gadget_FindRightMostTL(tag *taglist);
u32 gadget_GetHint(u32 firsttag, ...);
u32 gadget_GetHintTL(tag *taglist);
u32 gadget_GetExtent(u32 firsttag, ...);
u32 gadget_GetExtentTL(tag *taglist);
u32 gadget_GetRect(u32 firsttag, ...);
u32 gadget_GetRectTL(tag *taglist);
u32 gadget_SuggestExtent(u32 firsttag, ...);
u32 gadget_SuggestExtentTL(tag *taglist);
u32 gadget_DeleteGadget(u32 firsttag, ...);
u32 gadget_DeleteGadgetTL(tag *taglist);
u32 gadget_InitGadget(u32 firsttag, ...);
u32 gadget_InitGadgetTL(tag *taglist);
u32 gadget_InputEventHandler(u32 firsttag, ...);
u32 gadget_InputEventHandlerTL(tag *taglist);
u32 gadget_Layout(u32 firsttag, ...);
u32 gadget_LayoutTL(tag *taglist);
u32 gadget_Damage(u32 firsttag, ...);
u32 gadget_DamageTL(tag *taglist);
u32 gadget_CallBack(u32 firsttag, ...);
u32 gadget_CallBackTL(tag *taglist);
u32 gadget_GetUniqueId(void);
u32 gadget_GetUniqueIdTL(tag *taglist);
u32 gadget_Save(u32 firsttag, ...);
u32 gadget_SaveTL(tag *taglist);
u32 gadget_Restore(u32 firsttag, ...);
u32 gadget_RestoreTL(tag *taglist);
u32 gadget_MethodCall(u32 firsttag, ...);
u32 gadget_MethodCallTL(tag *taglist);
u32 gadget_Bind(u32 firsttag, ...);
u32 gadget_BindTL(tag *taglist);
//Prototypes END

#endif

---