dialogs.h

   1 /*
   2  * dialogs.h -- shared variables for generic dialog popup of XBoard
   3  *
   4  * Copyright 2000, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
   5  * ------------------------------------------------------------------------
   6  *
   7  * GNU XBoard is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or (at
  10  * your option) any later version.
  11  *
  12  * GNU XBoard is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program. If not, see http://www.gnu.org/licenses/.  *
  19  *
  20  *------------------------------------------------------------------------
  21  ** See the file ChangeLog for a revision history.  */
  22
  23 // [HGM] Some remarks about the generic dialog creator of XBoard:
  24 // GenericPopUp is needed to create a dialog from the lists of options supplied by the engines.
  25 // But once it is there, it provides a very easy way for creating other settings dialogs as well,
  26 // by letting XBoard provide its own, compiled-in lists of XBoard options (located in dialogs.c).
  27 // The Option struct uses the following fields (E = for engine options, X = for XBoard options):
  28 //                    Option types                  | XBoard-only ->
  29 // TYPE    NAME       spin check string combo button box label list graph menu break end
  30 // int     value       E     E    (h)    X/E         [w]       (h)   (h)
  31 // int     min        X/E         (2)    (3)         (1)  (1)  (1)   (1)  (3)   (1)  (4)
  32 // int     max        X/E   (w)   (w)    (w)   (w)   (w)  (w)  (w)   (w)
  33 // void*   handle     X/E   X/E   X/E    X/E   X/E    X    X    X     X    X
  34 // void*   target      X     X     X     X/C    C          X    X     C    C
  35 // char*   textValue               E     X/E    *
  36 // char ** choice                        X/E    *                          X
  37 // enum    type       X/E   X/E   X/E    X/E    X     X    X    X     X    X     X    X
  38 // char[]  name       X/E   X/E   X/E    X/E    X          X    X     X    X
  39 // File and Path options are like String (but get a browse button added in the dialog), and Slider
  40 // is like Spin. Menu can be PopUp or PopDown; both need the COMBO_CALLBACK bit (3) set!
  41 // (h) or (w) means the field optionally (when non-null) specifies the height or width of the main
  42 // control element (excluding accompanying description texts). [w] means the width is written there.
  43 // C specifies the 'target' is a user-supplied callback function, which will be executed when the
  44 // option is exercised.
  45
  46
  47 /* Flags Option.min used (2) for TextBox (-string): */
  48 #define T_VSCRL         (1 << 0)
  49 #define T_HSCRL         (1 << 1)
  50 #define T_FILL          (1 << 2)
  51 #define T_WRAP          (1 << 3)
  52 #define T_TOP           (1 << 4)
  53
  54 /* Flags Option.min used (3) for ComboBox (-combo) and menus (PopUp, PopDown): */
  55 #define COMBO_CALLBACK  (1 << 0)
  56 #define NO_GETTEXT      (1 << 2)
  57
  58 /* Flags for Option.min used (1) for Button, SaveButton, ListBox, Label: */
  59 #define SAME_ROW        (1 << 0) /* also in Break & EndMark */
  60 #define BORDER          (1 << 1) /* Label */
  61 #define FIX_H           (1 << 1) /* in other, this bit specifies top and botom of the control chain to same window edge */
  62 #define B2B             (1 << 2) /* chain bottom to bottom (by default, no chaining is done) */
  63 #define T2T             (1 << 3)
  64 #define R2R             (1 << 4)
  65 #define L2R             (1 << 5)
  66 #define R2L             (1 << 6)
  67 #define L2L             (1 << 7)
  68 #define TT              (T2T|FIX_H) /* useful combinations: 0xA = entirely to top */
  69 #define BB              (B2B|FIX_H) /*   6 = entirely to bottom */
  70 #define TB              (B2B|T2T)   /*   0xC = absorb all vertical size change */
  71 #define LL              (L2L|R2L)   /*   0xC0 = entirely to left */
  72 #define RR              (L2R|R2R)   /*   0x30 = entirely to right */
  73 #define LR              (L2L|R2R)   /*   0x90 = absorb all horizontal size change */
  74
  75 /* Flags for Option.min used (4) for EndMark: */
  76 #define NO_OK           (1 << 1)
  77 #define NO_CANCEL       (1 << 2)
  78
  79 #define MODAL 1
  80 #define NONMODAL 0
  81
  82 typedef enum {  // identifier of dialogs done by GenericPopup
  83 TransientDlg=0, // transient: grabs mouse events and is destroyed at pop-down (so other dialog can use this ID next time)
  84 CommentDlg, TagsDlg, TextMenuDlg, InputBoxDlg, NoDlg, DummyDlg, HistoryDlg, // persistent: no grab and reused
  85 GameListDlg,
  86 EngOutDlg,
  87 EvalGraphDlg,
  88 PromoDlg,       // this and beyond are destroyed at pop-down
  89 ErrorDlg,
  90 AskDlg,         // this and beyond do grab mouse events (and are destroyed)
  91 FatalDlg,
  92 BoardWindow,
  93 BrowserDlg,
  94 NrOfDialogs     // dummy for total
  95 } DialogClass;
  96
  97 typedef Option *PointerCallback(int n, int x, int y);
  98 typedef void ListBoxCallback(int n, int selected);
  99 typedef void ButtonCallback(int n);
 100 typedef int OKCallback(int n);
 101
 102 extern char commentTranslations[];
 103 extern char historyTranslations[];
 104 extern Pixel timerBackgroundPixel;
 105 extern int values[];
 106 extern ChessProgramState *currentCps;
 107 extern int dialogError;
 108 extern ButtonCallback *comboCallback;
 109
 110 extern WindowPlacement wpComment, wpTags, wpMoveHistory, wpMain;
 111 extern char *marked[];
 112 extern Boolean shellUp[];
 113 extern Option textOptions[], typeOptions[];
 114
 115
 116 int DialogExists P((DialogClass n));
 117 int GenericPopUp P((Option *option, char *title, DialogClass dlgNr, DialogClass parent, int modal, int topLevel));
 118 int GenericReadout P((Option *currentOption, int selected));
 119 int PopDown P((DialogClass n));
 120 int AppendText P((Option *opt, char *s));
 121 void SetColor P((char *colorName, Option *box));
 122 void ColorChanged P((Widget w, XtPointer data, XEvent *event, Boolean *b));
 123 void SetInsertPos P((Option *opt, int pos));
 124 void HardSetFocus P((Option *opt));
 125 void GetWidgetText  P((Option *opt, char **buf));
 126 void SetWidgetText  P((Option *opt, char *buf, int n));
 127 void GetWidgetState  P((Option *opt, int *state));
 128 void SetWidgetState  P((Option *opt, int state));
 129 void SetWidgetLabel P((Option *opt, char *buf));
 130 void SetDialogTitle  P((DialogClass dlg, char *title));
 131 void LoadListBox P((Option *opt, char *emptyText));
 132 void HighlightListBoxItem P((Option *opt, int nr));
 133 void HighlightWithScroll P((Option *opt, int sel, int max));
 134 int  SelectedListBoxItem P((Option *opt));
 135 void BoardFocus P((void));
 136 void FocusOnWidget P((Option *opt, DialogClass dlg));
 137 void UnCaret P((void));
 138 void SetIconName P((DialogClass dlg, char *name));
 139 int  ReadScroll P((Option *opt, float *top, float *bottom));
 140 void SetScroll P((Option *opt, float f));
 141 void AddHandler  P((Option *opt, int nr));
 142 void SendText P((int n));
 143 FILE *Browse P((DialogClass dlg, char *label, char *proposed, char *ext,
 144                         Boolean pathFlag, char *mode, char **name, FILE **fp));
 145
 146 void InitDrawingParams P(()); // in xboard.c
 147 void ErrorPopUp P((char *title, char *text, int modal));
 148 int  ShiftKeys P((void));
 149 void SetClockIcon P((int color));
 150 void DelayedLoad P((void));
 151 void DisplayTimerLabel P((Option *opt, char *color, long timer, int highlight));
 152 Option *BoardPopUp P((int squareSize, int lineGap, void *clockFontThingy));
 153
 154 int  SetCurrentComboSelection P((Option *opt));
 155 void BoxAutoPopUp P((char *buf));
 156 void IcsKey P((int n));
 157 void ICSInputBoxPopUp P((void));
 158 void LoadOptionsPopUp P((DialogClass parent));
 159 void GameListOptionsPopUp P((DialogClass parent));
 160
 161 // in ngamelist.c
 162 int GameListClicks P((int direction));
 163 void SetFilter P((void));
 164 int SaveGameListAsText P((FILE *f));
 165
 166