---

/home/micah/picogui/pg1/client/c/include/picogui/client_c.h

Go to the documentation of this file.

/* $Id: client_c.h 3806 2003-05-04 06:11:21Z micah $
 *
 * picogui/client_c.h - The PicoGUI API provided by the C client lib
 *
 * PicoGUI small and efficient client/server GUI
 * Copyright (C) 2000-2003 Micah Dowty <micahjd@users.sourceforge.net>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 * 
 * Contributors: 
 * 
 *  Philippe Ney <philippe.ney@smartdata.ch>
 * 
 * 
 */

#ifndef _H_PG_CLI_C
#define _H_PG_CLI_C

#include <stdio.h>   /* For NULL and FILE */
#ifdef __NetBSD__  
#include <sys/types.h>
#include <sys/time.h>
#include <unistd.h>
#endif

#ifdef __linux__
#include <sys/types.h>
#include <sys/time.h>
#include <unistd.h>
#endif

/******************** Client-specific constants and data types */

struct pgEvent {
   s16 type;      
   pghandle from;   
   void *extra;     
   
   union {
      
      u32 param;
      
      struct {
         s16 w;
         s16 h;
      } size;

      struct {
         s16 mods;  

         s16 key;
      } kbd;
      
      struct {
         s16 x,y;
         s16 btn;    
         s16 chbtn;  
      } pntr;
      
      struct {
         u32 size;
         char *pointer; 

         union pg_client_trigger *trigger;
      } data;
      
   } e;
};

#define PGBIND_ANY      -1

#define PGFONT_ANY      0

typedef u32 pgcolor;

#define PGDEFAULT       0

#define pgFraction(n,d) (((n)<<8)|(d))

typedef int (*pgevthandler)(struct pgEvent *evt);
typedef void (*pgidlehandler)(void);
#ifdef FD_SET

typedef int (*pgselecthandler)(int n, fd_set *readfds, fd_set *writefds,
                               fd_set *exceptfds, struct timeval *timeout);
typedef void (*pgselectbh)(int result, fd_set *readfds, fd_set *writefds,
                           fd_set *exceptfds);
#endif

typedef int (*pgfilter)(const char *string,const char *pattern);

#define PG_FILE_SAVEBTN    (1<<0)  
#define PG_FILE_MUSTEXIST  (1<<1)  
#define PG_FILE_MUSTWRITE  (1<<2)  
#define PG_FILE_MUSTREAD   (1<<3)  
#define PG_FILE_SHOWDOT    (1<<4)  
#define PG_FILE_SHOWHIDDEN (1<<5)  
#define PG_FILE_SHOWBAK    (1<<6)  
#define PG_FILE_SHOWDEV    (1<<7)  
#define PG_FILE_FIELD      (1<<8)  


#define PG_FILEOPEN     PG_FILE_MUSTREAD

#define PG_FILESAVE    (PG_FILE_SAVEBTN | PG_FILE_FIELD)

/* Constants for the message dialog box flags */
#define PG_MSGBTN_OK        0x0001
#define PG_MSGBTN_CANCEL    0x0002
#define PG_MSGBTN_YES       0x0004
#define PG_MSGBTN_NO        0x0008
#define PG_MSGICON_ERROR    0x0010
#define PG_MSGICON_MESSAGE  0x0020
#define PG_MSGICON_QUESTION 0x0040
#define PG_MSGICON_WARNING  0x0080

#define PG_MSGBTNMASK       (PG_MSGBTN_OK|PG_MSGBTN_CANCEL|\
                             PG_MSGBTN_YES|PG_MSGBTN_NO)
#define PG_MSGICONMASK      (PG_MSGICON_ERROR|PG_MSGICON_MESSAGE|\
                             PG_MSGICON_QUESTION|PG_MSGICON_WARNING)

struct pgmemdata {
  void *pointer;       
  u32 size;  
  int flags;           
};
#define PGMEMDAT_NEED_FREE    0x0001   
#define PGMEMDAT_NEED_UNMAP   0x0002   



/******************** Administration */

void pgInit(int argc, char **argv);

void pgSetErrorHandler(void (*handler)(u16 errortype,
                                       const char *msg));

pghandle pgLoadDriver(const char *name);

const char *pgErrortypeString(u16 errortype);

pgidlehandler pgSetIdle(s32 t, pgidlehandler handler); 

void pgFlushRequests(void);

void pgUpdate(void);

void pgSubUpdate(pghandle widget);

void pgBind(pghandle widgetkey,s16 eventkey,
            pgevthandler handler,void *extra);

#ifdef FD_SET

void pgCustomizeSelect(pgselecthandler handler, pgselectbh bottomhalf);
#endif

void pgRegisterOwner(int resource);

void pgUnregisterOwner(int resource);

void pgSetVideoMode(u16 xres,u16 yres,
                    u16 bpp,u16 flagmode,
                    u32 flags);

struct pgmodeinfo *pgGetVideoMode(void);

void pgDriverMessage(u32 message, u32 param);

void pgAppMessage(pghandle dest, struct pgmemdata data);

void * pgSyncAppMessage (pghandle dest, struct pgmemdata data);

pghandle pgEvalRequest(s16 reqtype, void *data, u32 datasize);

void pgSetInactivity(u32 time);

u32 pgGetInactivity(void);

pghandle pgGetServerRes(u32 id);


/******************** Objects */

void pgDelete(pghandle object);

pghandle pgDup(pghandle object);

void pgChangeContext(pghandle object, s16 delta);

void pgFocus(pghandle widget);

pghandle pgRegisterApp(s16 type,const char *name, ...);

pghandle pgNewWidget(s16 type,s16 rship,
                     pghandle parent);

pghandle pgCreateWidget(s16 type);

void pgAttachWidget(pghandle parent, s16 rship, pghandle widget);

pghandle pgTraverseWidget(pghandle widget, int direction, int count);

pghandle pgNewPopup(int width,int height);

pghandle pgNewCursor(void);

pghandle pgNewInFilter(pghandle insert_after, u32 accept_trigs, u32 absorb_trigs);

void pgInFilterSend(union pg_client_trigger *trig);

pghandle pgNewPopupAt(int x,int y,int width,int height);

void pgSetWidget(pghandle widget, ...);

s32 pgGetWidget(pghandle widget,s16 property);

pghandle pgNewBitmap(struct pgmemdata obj);

pghandle pgCreateBitmap(s16 width, s16 height);

struct pgshmbitmap *pgMakeSHMBitmap(pghandle bitmap);

pghandle pgNewString(const char *str);

pghandle pgNewArray(const s32* dat, u16 size);  
 
char *pgGetString(pghandle string);

void pgReplaceText(pghandle widget,const char *str);

void pgReplaceTextFmt(pghandle widget,const char *fmt, ...);

pghandle pgNewFont(const char *name,s16 size,u32 style);

int pgGetFontStyle(s16 index, char *name, u16 *size,
                   u16 *fontrep, u32 *flags);

void pgSizeText(int *w,int *h,pghandle font,pghandle text);

void pgSizeBitmap(int *w, int *h, pghandle bitmap);

pghandle pgLoadTheme(struct pgmemdata obj);

pghandle pgLoadWidgetTemplate(struct pgmemdata obj);

int pgFindThemeObject(const char *key);

pghandle pgDataString(struct pgmemdata obj);

u32 pgThemeLookup(s16 object, s16 property);

void pgSetPayload(pghandle object,u32 payload);

u32 pgGetPayload(pghandle object);

void pgWriteData(pghandle widget,struct pgmemdata data);

void pgWriteCmd(pghandle widget,s32 command,s16 numparams, ...);

void pgRender(pghandle bitmap,s16 groptype, ...);

pghandle pgFindWidget(const char *key);


/******************** Data loading */

struct pgmemdata pgFromMemory(void *data,u32 length);

struct pgmemdata pgFromTempMemory(void *data,u32 length);


struct pgmemdata pgFromFile(const char *file);

struct pgmemdata pgFromStream(FILE *f, u32 length);

/* TODO: Load from resource. Allow apps to package necessary bitmaps
   and things in a file, named after their binary but with a '.res'
   extension.
   The server will also be able to request reloading data from these
   resource files, for example to reload bitmaps when the bit depth
   changes.

   This is just an idea, and I'll implement it later...
   This whole pgmemdata business is just my attempt to leave enough
   hooks to make this work.
*/


/******************** Program flow */

void pgEventLoop(void);

void pgExitEventLoop(void);

struct pgEvent *pgGetEvent(void);

int pgCheckEvent(void);

void pgDispatchEvent(struct pgEvent *evt);

void pgEventPoll(void);

int pgEnterContext(void);

void pgLeaveContext(void);

void pgDeleteHandleContext(int id);

void pgSetContext(int id);


int pgGetContext(void);



#endif /* __H_PG_CLI_C */
/* The End */

---