src/lyx_gui_misc.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1995 1996 Matthias Ettrich
   8  *           Copyright 1995-2000 The LyX Team
   9  *
  10  * ====================================================== */
  11
  12 // Misc. GUI specific routines
  13
  14 #ifndef LYX_GUI_MISC_H
  15 #define LYX_GUI_MISC_H
  16
  17 #ifdef __GNUG__
  18 #pragma interface
  19 #endif
  20
  21 #include FORMS_H_LOCATION
  22 #include "LString.h"
  23 #include <utility>  /* needed for pair<> definition */
  24
  25 /// Prevents LyX from being killed when the close box is pressed in a popup.
  26 extern "C" int CancelCloseBoxCB(FL_FORM *, void *);
  27 /// Prevents LyX from being killed when the close box is pressed in a popup.
  28 extern "C" int IgnoreCloseBoxCB(FL_FORM *, void *);
  29
  30 /// Prevents LyX from crashing when no buffers available
  31 void CloseAllBufferRelatedDialogs();
  32
  33 /// Ensures info in visible popups are always correct.
  34 void updateAllVisibleBufferRelatedDialogs();
  35
  36 /* These shortcut extractors should be shifted to frontends/xforms/ eventually */
  37 /// Extract shortcut from <ident>|<shortcut> string
  38 char const * flyx_shortcut_extract(char const * sc);
  39 /// Make a shortnamed version of the above func
  40 #define scex flyx_shortcut_extract
  41
  42 /// Extract shortcut from <ident>|<shortcut> string
  43 char const * flyx_ident_extract(char const * sc);
  44 /// Make a shortnamed versjon of the above func
  45 #define idex flyx_ident_extract
  46
  47 /// Show message
  48 void WriteAlert(string const & s1, string const & s2 = string(),
  49                 string const & s3 = string());
  50
  51 /// Alarms user of something related to files
  52 void WriteFSAlert(string const & s1, string const & s2 = string());
  53
  54 /// Asks "Yes" or "No". Returns true for yes, false for no
  55 bool AskQuestion(string const & s1, string const & s2 = string(),
  56                  string const & s3 = string());
  57
  58 /// Asks "Yes", "No" or "Cancel". Returns 1 for yes, 2 for no, 3 for cancel
  59 int AskConfirmation(string const & s1, string const & s2 = string(),
  60                     string const & s3 = string());
  61
  62 /// returns a bool: false=cancelled, true=okay. string contains returned text
  63 std::pair<bool, string> askForText(string const & msg,
  64                                    string const & dflt = string());
  65
  66 /// Informs the user that changes in the coming form will be ignored
  67 void WarnReadonly(string const & file);
  68
  69 /// Get the dpi setting of the current screen
  70 float getScreenDPI();
  71
  72 // inlined functions
  73 // rings the audio bell.
  74 inline
  75 void LyXBell() {
  76         // if (audio()) ON/OFF switch yet to be implemented
  77         fl_ringbell(20);
  78 }
  79
  80 #endif