src/graphics/GraphicsTypes.h

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