WINGs/WINGs/WINGsP.h

   1 #ifndef _WINGSP_H_
   2 #define _WINGSP_H_
   3
   4
   5 #include <X11/Xlib.h>
   6 #include <X11/Xutil.h>
   7
   8
   9 #include <WINGs/WINGs.h>
  10
  11 #if WINGS_H_VERSION < 20041030
  12 #error There_is_an_old_WINGs.h_file_somewhere_in_your_system._Please_remove_it.
  13 #endif
  14
  15 #include <assert.h>
  16
  17 #include <stdlib.h>
  18 #include <string.h>
  19 #include <strings.h>
  20 #include <stdio.h>
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif /* __cplusplus */
  25
  26 /* ---[ global settigns ]------------------------------------------------- */
  27
  28 #define DOUBLE_BUFFER   1
  29
  30 #define SCROLLER_WIDTH  20
  31
  32 typedef struct _WINGsConfiguration {
  33     char *systemFont;
  34     char *boldSystemFont;
  35     int  defaultFontSize;
  36     Bool antialiasedText;
  37     char *floppyPath;
  38     unsigned doubleClickDelay;
  39     unsigned mouseWheelUp;
  40     unsigned mouseWheelDown;
  41 } _WINGsConfiguration;
  42
  43 extern char *_WINGS_progname;
  44 extern _WINGsConfiguration WINGsConfiguration;
  45 extern struct W_Application WMApplication;
  46
  47
  48 /* ---[ drag*.c ]--------------------------------------------------------- */
  49
  50 /*
  51  * We need to define these structure first because they are used in W_Screen
  52  * below. The rest of drag-related stuff if after because it needs W_Screen
  53  */
  54 #define XDND_VERSION    3
  55
  56 typedef struct W_DraggingInfo {
  57     unsigned char protocolVersion; /* version supported on the other side */
  58     Time timestamp;
  59
  60     Atom sourceAction;
  61     Atom destinationAction;
  62
  63     struct W_DragSourceInfo* sourceInfo;    /* infos needed by source */
  64     struct W_DragDestinationInfo* destInfo; /* infos needed by destination */
  65 } W_DraggingInfo;
  66
  67 /* ---[ Structures from WINGs.h ]----------------------------------------- */
  68
  69 /* Pre-definition of internal structs */
  70 typedef struct W_Color W_Color;
  71 typedef struct W_Pixmap W_Pixmap;
  72 typedef struct W_View W_View;
  73
  74 typedef struct W_FocusInfo {
  75     W_View *toplevel;
  76     W_View *focused;    /* view that has the focus in this toplevel */
  77     struct W_FocusInfo *next;
  78 } W_FocusInfo;
  79
  80 typedef struct W_Screen {
  81     Display *display;
  82     int screen;
  83     int depth;
  84
  85     Colormap colormap;
  86
  87     Visual *visual;
  88
  89     Time lastEventTime;
  90
  91     Window rootWin;
  92
  93     W_View *rootView;
  94
  95     RContext *rcontext;
  96
  97     struct W_IMContext *imctx;
  98
  99     struct _XftDraw *xftdraw;          /* shared XftDraw */
 100
 101     /* application related */
 102
 103     W_FocusInfo *focusInfo;
 104
 105     RImage *applicationIconImage;      /* image (can have alpha channel) */
 106     W_Pixmap *applicationIconPixmap; /* pixmap - no alpha channel */
 107     Window applicationIconWindow;
 108
 109     struct W_Window *windowList;       /* list of windows in the app */
 110
 111     Window groupLeader;                /* the leader of the application */
 112                                        /* also used for other things */
 113
 114     struct W_SelectionHandlers *selectionHandlerList;
 115
 116     struct {
 117         unsigned int hasAppIcon:1;
 118         unsigned int simpleApplication:1;
 119     } aflags;
 120
 121     WMOpenPanel *sharedOpenPanel;
 122     WMSavePanel *sharedSavePanel;
 123
 124     struct W_FontPanel *sharedFontPanel;
 125
 126     struct W_ColorPanel *sharedColorPanel;
 127
 128     Pixmap stipple;
 129
 130     W_View *dragSourceView;
 131     W_DraggingInfo dragInfo;
 132
 133     /* colors */
 134     W_Color *white;
 135     W_Color *black;
 136     W_Color *gray;
 137     W_Color *darkGray;
 138
 139     GC stippleGC;
 140
 141     GC copyGC;
 142     GC clipGC;
 143
 144     GC monoGC;                         /* GC for 1bpp visuals */
 145
 146     GC xorGC;
 147
 148     GC ixorGC;                         /* IncludeInferiors XOR */
 149
 150     GC drawStringGC;                   /* for WMDrawString() */
 151
 152     GC drawImStringGC;                 /* for WMDrawImageString() */
 153
 154     struct W_Font *normalFont;
 155
 156     struct W_Font *boldFont;
 157
 158     WMHashTable *fontCache;
 159
 160     Bool antialiasedText;
 161
 162     unsigned int ignoredModifierMask; /* modifiers to ignore when typing txt */
 163
 164     struct W_Balloon *balloon;
 165
 166
 167     W_Pixmap *checkButtonImageOn;
 168     W_Pixmap *checkButtonImageOff;
 169
 170     W_Pixmap *radioButtonImageOn;
 171     W_Pixmap *radioButtonImageOff;
 172
 173     W_Pixmap *buttonArrow;
 174     W_Pixmap *pushedButtonArrow;
 175
 176     W_Pixmap *scrollerDimple;
 177
 178     W_Pixmap *upArrow;
 179     W_Pixmap *downArrow;
 180     W_Pixmap *leftArrow;
 181     W_Pixmap *rightArrow;
 182
 183     W_Pixmap *hiUpArrow;
 184     W_Pixmap *hiDownArrow;
 185     W_Pixmap *hiLeftArrow;
 186     W_Pixmap *hiRightArrow;
 187
 188     W_Pixmap *pullDownIndicator;
 189     W_Pixmap *popUpIndicator;
 190
 191     W_Pixmap *checkMark;
 192
 193     W_Pixmap *homeIcon;
 194     W_Pixmap *altHomeIcon;
 195
 196     W_Pixmap *trashcanIcon;
 197     W_Pixmap *altTrashcanIcon;
 198
 199     W_Pixmap *createDirIcon;
 200     W_Pixmap *altCreateDirIcon;
 201
 202     W_Pixmap *disketteIcon;
 203     W_Pixmap *altDisketteIcon;
 204     W_Pixmap *unmountIcon;
 205     W_Pixmap *altUnmountIcon;
 206
 207     W_Pixmap *magnifyIcon;
 208     /*W_Pixmap *altMagnifyIcon;*/
 209     W_Pixmap *wheelIcon;
 210     W_Pixmap *grayIcon;
 211     W_Pixmap *rgbIcon;
 212     W_Pixmap *cmykIcon;
 213     W_Pixmap *hsbIcon;
 214     W_Pixmap *customPaletteIcon;
 215     W_Pixmap *colorListIcon;
 216
 217     W_Pixmap *defaultObjectIcon;
 218
 219     Cursor defaultCursor;
 220
 221     Cursor textCursor;
 222
 223     Cursor invisibleCursor;
 224
 225     Atom attribsAtom;              /* GNUstepWindowAttributes */
 226
 227     Atom deleteWindowAtom;         /* WM_DELETE_WINDOW */
 228
 229     Atom protocolsAtom;            /* _XA_WM_PROTOCOLS */
 230
 231     Atom clipboardAtom;            /* CLIPBOARD */
 232
 233     Atom xdndAwareAtom;            /* XdndAware */
 234     Atom xdndSelectionAtom;
 235     Atom xdndEnterAtom;
 236     Atom xdndLeaveAtom;
 237     Atom xdndPositionAtom;
 238     Atom xdndDropAtom;
 239     Atom xdndFinishedAtom;
 240     Atom xdndTypeListAtom;
 241     Atom xdndActionListAtom;
 242     Atom xdndActionDescriptionAtom;
 243     Atom xdndStatusAtom;
 244
 245     Atom xdndActionCopy;
 246     Atom xdndActionMove;
 247     Atom xdndActionLink;
 248     Atom xdndActionAsk;
 249     Atom xdndActionPrivate;
 250
 251     Atom wmIconDragOffsetAtom;
 252
 253     Atom wmStateAtom;              /* WM_STATE */
 254
 255     Atom utf8String;
 256
 257     Atom netwmName;
 258     Atom netwmIconName;
 259     Atom netwmIcon;
 260
 261     /* stuff for detecting double-clicks */
 262     Time lastClickTime;            /* time of last mousedown event */
 263     Window lastClickWindow;        /* window of the last mousedown */
 264
 265     struct W_View *modalView;
 266     unsigned modalLoop:1;
 267     unsigned ignoreNextDoubleClick:1;
 268 } W_Screen;
 269
 270 #define W_DRAWABLE(scr)         (scr)->rcontext->drawable
 271
 272
 273 /* ---[ configuration.c ]------------------------------------------------- */
 274
 275 void W_ReadConfigurations(void);
 276
 277
 278 /* ---[ drag*.c ]--------------------------------------------------------- */
 279
 280 typedef struct W_DragOperationItem {
 281     WMDragOperationType type;
 282     char* text;
 283 } W_DragOperationItem;
 284
 285 typedef void* W_DndState(WMView *destView, XClientMessageEvent *event,
 286                          WMDraggingInfo *info);
 287
 288 typedef struct W_DragSourceInfo {
 289     WMView *sourceView;
 290     Window destinationWindow;
 291     W_DndState *state;
 292     WMSelectionProcs *selectionProcs;
 293     Window icon;
 294     WMPoint imageLocation;
 295     WMPoint mouseOffset; /* mouse pos in icon */
 296     Cursor dragCursor;
 297     WMRect noPositionMessageZone;
 298     Atom firstThreeTypes[3];
 299 } W_DragSourceInfo;
 300
 301 typedef struct W_DragDestinationInfo {
 302     WMView *destView;
 303     WMView *xdndAwareView;
 304     Window sourceWindow;
 305     W_DndState *state;
 306     Bool sourceActionChanged;
 307     WMArray *sourceTypes;
 308     WMArray *requiredTypes;
 309     Bool typeListAvailable;
 310     WMArray *dropDatas;
 311 } W_DragDestinationInfo;
 312
 313 /* -- Functions -- */
 314
 315 void W_HandleDNDClientMessage(WMView *toplevel, XClientMessageEvent *event);
 316
 317 Atom W_OperationToAction(WMScreen *scr, WMDragOperationType operation);
 318
 319 WMDragOperationType W_ActionToOperation(WMScreen *scr, Atom action);
 320
 321 void W_FreeDragOperationItem(void* item);
 322
 323 Bool W_SendDnDClientMessage(Display *dpy, Window win, Atom message,
 324                             unsigned long data1, unsigned long data2,
 325                             unsigned long data3, unsigned long data4,
 326                             unsigned long data5);
 327
 328 void W_DragSourceStartTimer(WMDraggingInfo *info);
 329
 330 void W_DragSourceStopTimer(void);
 331
 332 void W_DragSourceStateHandler(WMDraggingInfo *info, XClientMessageEvent *event);
 333
 334 void W_DragDestinationStartTimer(WMDraggingInfo *info);
 335
 336 void W_DragDestinationStopTimer(void);
 337
 338 void W_DragDestinationStoreEnterMsgInfo(WMDraggingInfo *info, WMView *toplevel,
 339                                         XClientMessageEvent *event);
 340
 341 void W_DragDestinationStorePositionMsgInfo(WMDraggingInfo *info,
 342                                            WMView *toplevel,
 343                                            XClientMessageEvent *event);
 344
 345 void W_DragDestinationCancelDropOnEnter(WMView *toplevel, WMDraggingInfo *info);
 346
 347 void W_DragDestinationStateHandler(WMDraggingInfo *info,
 348                                    XClientMessageEvent *event);
 349
 350 void W_DragDestinationInfoClear(WMDraggingInfo *info);
 351
 352 void W_FreeViewXdndPart(WMView *view);
 353
 354
 355 /* ---[ handlers.c ]------------------------------------------------------ */
 356
 357 Bool W_CheckIdleHandlers(void);
 358
 359 void W_CheckTimerHandlers(void);
 360
 361 Bool W_HandleInputEvents(Bool waitForInput, int inputfd);
 362
 363
 364 /* ---[ notification.c ]-------------------------------------------------- */
 365
 366 void W_InitNotificationCenter(void);
 367
 368 void W_ReleaseNotificationCenter(void);
 369
 370 void W_FlushASAPNotificationQueue(void);
 371
 372 void W_FlushIdleNotificationQueue(void);
 373
 374
 375 /* ---[ selection.c ]----------------------------------------------------- */
 376
 377 void W_HandleSelectionEvent(XEvent *event);
 378
 379
 380 /* ---[ wapplication.c ]-------------------------------------------------- */
 381
 382 typedef struct W_Application {
 383     char *applicationName;
 384     int argc;
 385     char **argv;
 386     char *resourcePath;
 387 } W_Application;
 388
 389 /* -- Functions -- */
 390
 391 void W_InitApplication(WMScreen *scr);
 392
 393 Bool W_ApplicationInitialized(void);
 394
 395
 396 /* ---[ wballoon.c ]------------------------------------------------------ */
 397
 398 struct W_Balloon *W_CreateBalloon(WMScreen *scr);
 399
 400 void W_BalloonHandleEnterView(WMView *view);
 401
 402 void W_BalloonHandleLeaveView(WMView *view);
 403
 404
 405 /* ---[ wcolor.c ]-------------------------------------------------------- */
 406
 407 struct W_Color {
 408     struct W_Screen *screen;
 409
 410     XColor color;
 411     unsigned short alpha;
 412     short refCount;
 413     GC gc;
 414     struct {
 415         unsigned int exact:1;
 416     } flags;
 417 };
 418
 419 #define W_PIXEL(c)              (c)->color.pixel
 420
 421
 422 /* ---[ wevent.c ]-------------------------------------------------------- */
 423
 424 typedef struct W_EventHandler {
 425     unsigned long eventMask;
 426
 427     WMEventProc *proc;
 428
 429     void *clientData;
 430 } W_EventHandler;
 431
 432 /* -- Functions -- */
 433
 434 void W_CallDestroyHandlers(W_View *view);
 435
 436
 437 /* ---[ wfont.c ]--------------------------------------------------------- */
 438
 439 typedef struct W_Font {
 440     struct W_Screen *screen;
 441
 442     struct _XftFont *font;
 443
 444     short height;
 445     short y;
 446     short refCount;
 447     char *name;
 448 } W_Font;
 449
 450 #define W_FONTID(f)             (f)->font->fid
 451
 452
 453 /* ---[ widgets.c ]------------------------------------------------------- */
 454
 455 #define WC_UserWidget   128
 456
 457 #define CHECK_CLASS(widget, class) assert(W_CLASS(widget)==(class))
 458
 459 #define W_CLASS(widget)         (((W_WidgetType*)(widget))->widgetClass)
 460 #define W_VIEW(widget)          (((W_WidgetType*)(widget))->view)
 461
 462 /* -- Functions -- */
 463
 464 W_Class W_RegisterUserWidget(void);
 465
 466
 467 /* ---[ winputmethod.c ]-------------------------------------------------- */
 468
 469 void W_InitIM(WMScreen *scr);
 470
 471 void W_CreateIC(WMView *view);
 472
 473 void W_DestroyIC(WMView *view);
 474
 475 void W_FocusIC(WMView *view);
 476
 477 void W_UnFocusIC(WMView *view);
 478
 479 void W_SetPreeditPositon(W_View *view, int x, int y);
 480
 481 int W_LookupString(W_View *view, XKeyPressedEvent *event, char *buffer,
 482                    int buflen, KeySym *keysym, Status *status);
 483
 484
 485 /* ---[ wmisc.c ]--------------------------------------------------------- */
 486
 487 void W_DrawRelief(W_Screen *scr, Drawable d, int x, int y, unsigned int width,
 488                   unsigned int height, WMReliefType relief);
 489
 490 void W_DrawReliefWithGC(W_Screen *scr, Drawable d, int x, int y,
 491                         unsigned int width, unsigned int height,
 492                         WMReliefType relief,
 493                         GC black, GC dark, GC light, GC white);
 494
 495 void W_PaintTextAndImage(W_View *view, int wrap, WMColor *textColor,
 496                          W_Font *font, WMReliefType relief, const char *text,
 497                          WMAlignment alignment, W_Pixmap *image,
 498                          WMImagePosition position, WMColor *backColor, int ofs);
 499
 500 void W_PaintText(W_View *view, Drawable d, WMFont *font,  int x, int y,
 501                  int width, WMAlignment alignment, WMColor *color,
 502                  int wrap, const char *text, int length);
 503
 504 int W_GetTextHeight(WMFont *font, const char *text, int width, int wrap);
 505
 506
 507 /* ---[ wpixmap.c ]------------------------------------------------------- */
 508
 509 struct W_Pixmap {
 510     struct W_Screen *screen;
 511     Pixmap pixmap;
 512     Pixmap mask;
 513     unsigned short width;
 514     unsigned short height;
 515     short depth;
 516     short refCount;
 517 };
 518
 519
 520 /* ---[ wview.c ]--------------------------------------------------------- */
 521
 522 typedef struct W_ViewDelegate {
 523     void *data;
 524     void (*didMove)(struct W_ViewDelegate*, WMView*);
 525     void (*didResize)(struct W_ViewDelegate*, WMView*);
 526     void (*willMove)(struct W_ViewDelegate*, WMView*, int*, int*);
 527     void (*willResize)(struct W_ViewDelegate*, WMView*,
 528                        unsigned int*, unsigned int*);
 529 } W_ViewDelegate;
 530
 531 struct W_View {
 532     struct W_Screen *screen;
 533
 534     WMWidget *self;     /* must point to the widget the view belongs to */
 535
 536     W_ViewDelegate *delegate;
 537
 538     Window window;
 539
 540     WMSize size;
 541
 542     short topOffs;
 543     short leftOffs;
 544     short bottomOffs;
 545     short rightOffs;
 546
 547     WMPoint pos;
 548
 549     struct W_View *nextFocusChain;     /* next/prev in focus chain */
 550     struct W_View *prevFocusChain;
 551
 552     struct W_View *nextResponder;      /* next to receive keyboard events */
 553
 554     struct W_View *parent;             /* parent WMView */
 555
 556     struct W_View *childrenList;       /* first in list of child windows */
 557
 558     struct W_View *nextSister;         /* next on parent's children list */
 559
 560     WMArray *eventHandlers;            /* event handlers for this window */
 561
 562     unsigned long attribFlags;
 563     XSetWindowAttributes attribs;
 564
 565     void *hangedData;                  /* data holder for user program */
 566
 567     WMColor *backColor;
 568
 569     Cursor cursor;
 570
 571     Atom *droppableTypes;
 572     struct W_DragSourceProcs      *dragSourceProcs;
 573     struct W_DragDestinationProcs *dragDestinationProcs;
 574     WMPixmap *dragImage;
 575     int helpContext;
 576
 577     XIC xic;
 578
 579     struct {
 580         unsigned int realized:1;
 581         unsigned int mapped:1;
 582         unsigned int parentDying:1;
 583         unsigned int dying:1;           /* the view is being destroyed */
 584         unsigned int topLevel:1;        /* is a top level window */
 585         unsigned int root:1;            /* is the root window */
 586         unsigned int mapWhenRealized:1; /* map the view when it's realized */
 587         unsigned int alreadyDead:1;     /* view was freed */
 588
 589         unsigned int dontCompressMotion:1; /* motion notify event compress */
 590         unsigned int notifySizeChanged:1;
 591         unsigned int dontCompressExpose:1; /* expose event compress */
 592
 593         /* toplevel only */
 594         unsigned int worksWhenModal:1;
 595         unsigned int pendingRelease1:1;
 596         unsigned int pendingRelease2:1;
 597         unsigned int pendingRelease3:1;
 598         unsigned int pendingRelease4:1;
 599         unsigned int pendingRelease5:1;
 600         unsigned int xdndHintSet:1;
 601     } flags;
 602
 603     int refCount;
 604 };
 605
 606 #define W_VIEW_REALIZED(view)   (view)->flags.realized
 607 #define W_VIEW_MAPPED(view)     (view)->flags.mapped
 608
 609 #define W_VIEW_DISPLAY(view)    (view)->screen->display
 610 #define W_VIEW_SCREEN(view)     (view)->screen
 611 #define W_VIEW_DRAWABLE(view)   (view)->window
 612
 613 #define W_VIEW_WIDTH(view)      (view)->size.width
 614 #define W_VIEW_HEIGHT(view)     (view)->size.height
 615
 616 /* -- Functions -- */
 617
 618 W_View *W_GetViewForXWindow(Display *display, Window window);
 619
 620 W_View *W_CreateView(W_View *parent);
 621
 622 W_View *W_CreateTopView(W_Screen *screen);
 623
 624 W_View *W_CreateUnmanagedTopView(W_Screen *screen);
 625
 626 W_View *W_CreateRootView(W_Screen *screen);
 627
 628 void W_DestroyView(W_View *view);
 629
 630 void W_RealizeView(W_View *view);
 631
 632 void W_RedisplayView(WMView *view);
 633
 634 void W_ReparentView(W_View *view, W_View *newParent, int x, int y);
 635
 636 void W_RaiseView(W_View *view);
 637
 638 void W_LowerView(W_View *view);
 639
 640 void W_MapView(W_View *view);
 641
 642 void W_MapSubviews(W_View *view);
 643
 644 void W_UnmapSubviews(W_View *view);
 645
 646 W_View *W_TopLevelOfView(W_View *view);
 647
 648 void W_UnmapView(W_View *view);
 649
 650 WMView *W_RetainView(WMView *view);
 651
 652 void W_ReleaseView(WMView *view);
 653
 654 void W_MoveView(W_View *view, int x, int y);
 655
 656 void W_ResizeView(W_View *view, unsigned int width, unsigned int height);
 657
 658 void W_SetViewBackgroundColor(W_View *view, WMColor *color);
 659
 660 void W_SetViewCursor(W_View *view, Cursor cursor);
 661
 662 void W_SetFocusOfTopLevel(W_View *toplevel, W_View *view);
 663
 664 W_View *W_FocusedViewOfToplevel(W_View *view);
 665
 666 void W_BroadcastMessage(W_View *targetParent, XEvent *event);
 667
 668 void W_DispatchMessage(W_View *target, XEvent *event);
 669
 670
 671 #ifdef __cplusplus
 672 }
 673 #endif /* __cplusplus */
 674
 675 #endif /* _WINGSP_H_ */