src/graphics/GraphicsTypes.h

   1 // -*- C++ -*-
   2 /**
   3  *  \file GraphicsTypes.h
   4  *  Read the file COPYING
   5  *
   6  *  \author Angus Leeming
   7  *
   8  * Full author contact details available in file CREDITS
   9  *
  10  *  All that header files outside the graphics subdirectory should need to
  11  *  access.
  12  */
  13
  14 #ifndef GRAPHICSTYPES_H
  15 #define GRAPHICSTYPES_H
  16
  17 #include "support/translator.h"
  18
  19 #ifdef __GNUG__
  20 #pragma interface
  21 #endif
  22
  23 namespace grfx {
  24
  25         /// The status of the loading process
  26         enum ImageStatus {
  27                 /** The data is in the cache, but no request to display it
  28                  *  has been received.
  29                  */
  30                 WaitingToLoad,
  31                 /// The image is in a loadable format and is being loaded.
  32                 Loading,
  33                 /// The image is being converted to a loadable format.
  34                 Converting,
  35                 /// The image has been loaded into memory.
  36                 Loaded,
  37                 /// The image is in memory and is being scaled, rotated, etc.
  38                 ScalingEtc,
  39                 /// All finished. Can display the image.
  40                 Ready,
  41                 ///
  42                 ErrorNoFile,
  43                 ///
  44                 ErrorConverting,
  45                 ///
  46                 ErrorLoading,
  47                 ///
  48                 ErrorGeneratingPixmap,
  49                 /// The data is not in the cache at all!
  50                 ErrorUnknown
  51         };
  52
  53         /// How is the image to be displayed on the LyX screen?
  54         enum DisplayType {
  55                 ///
  56                 DefaultDisplay,
  57                 ///
  58                 MonochromeDisplay,
  59                 ///
  60                 GrayscaleDisplay,
  61                 ///
  62                 ColorDisplay,
  63                 ///
  64                 NoDisplay
  65         };
  66
  67         /// The translator between the Display enum and corresponding lyx string.
  68         extern Translator< DisplayType, string > displayTranslator;
  69
  70         void setDisplayTranslator();
  71
  72 } // namespace grfx
  73
  74 #endif // GRAPHICSTYPES_H