Missing wxUSE_PALETTE markup (#1369489).
[wxWidgets.git] / include / wx / gtk / dc.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/gtk/dc.h
3 // Purpose:
4 // Author: Robert Roebling
5 // Id: $Id$
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
9
10 #ifndef __GTKDCH__
11 #define __GTKDCH__
12
13 //-----------------------------------------------------------------------------
14 // classes
15 //-----------------------------------------------------------------------------
16
17 class WXDLLIMPEXP_CORE wxDC;
18
19 //-----------------------------------------------------------------------------
20 // constants
21 //-----------------------------------------------------------------------------
22
23 #ifndef MM_TEXT
24 #define MM_TEXT 0
25 #define MM_ISOTROPIC 1
26 #define MM_ANISOTROPIC 2
27 #define MM_LOMETRIC 3
28 #define MM_HIMETRIC 4
29 #define MM_TWIPS 5
30 #define MM_POINTS 6
31 #define MM_METRIC 7
32 #endif
33
34 //-----------------------------------------------------------------------------
35 // wxDC
36 //-----------------------------------------------------------------------------
37
38 class WXDLLIMPEXP_CORE wxDC : public wxDCBase
39 {
40 public:
41 wxDC();
42 ~wxDC() { }
43
44 #if wxUSE_PALETTE
45 void SetColourMap( const wxPalette& palette ) { SetPalette(palette); };
46 #endif // wxUSE_PALETTE
47
48 // Resolution in pixels per logical inch
49 virtual wxSize GetPPI() const;
50
51 virtual bool StartDoc( const wxString& WXUNUSED(message) ) { return true; }
52 virtual void EndDoc() { }
53 virtual void StartPage() { }
54 virtual void EndPage() { }
55
56 virtual void SetMapMode( int mode );
57 virtual void SetUserScale( double x, double y );
58 virtual void SetLogicalScale( double x, double y );
59 virtual void SetLogicalOrigin( wxCoord x, wxCoord y );
60 virtual void SetDeviceOrigin( wxCoord x, wxCoord y );
61
62 virtual void SetAxisOrientation( bool xLeftRight, bool yBottomUp );
63
64 // implementation
65 // --------------
66
67 virtual void ComputeScaleAndOrigin();
68
69 wxCoord XDEV2LOG(wxCoord x) const
70 {
71 wxCoord new_x = x - m_deviceOriginX;
72 if (new_x > 0)
73 return (wxCoord)((double)(new_x) / m_scaleX + 0.5) * m_signX + m_logicalOriginX;
74 else
75 return (wxCoord)((double)(new_x) / m_scaleX - 0.5) * m_signX + m_logicalOriginX;
76 }
77 wxCoord XDEV2LOGREL(wxCoord x) const
78 {
79 if (x > 0)
80 return (wxCoord)((double)(x) / m_scaleX + 0.5);
81 else
82 return (wxCoord)((double)(x) / m_scaleX - 0.5);
83 }
84 wxCoord YDEV2LOG(wxCoord y) const
85 {
86 wxCoord new_y = y - m_deviceOriginY;
87 if (new_y > 0)
88 return (wxCoord)((double)(new_y) / m_scaleY + 0.5) * m_signY + m_logicalOriginY;
89 else
90 return (wxCoord)((double)(new_y) / m_scaleY - 0.5) * m_signY + m_logicalOriginY;
91 }
92 wxCoord YDEV2LOGREL(wxCoord y) const
93 {
94 if (y > 0)
95 return (wxCoord)((double)(y) / m_scaleY + 0.5);
96 else
97 return (wxCoord)((double)(y) / m_scaleY - 0.5);
98 }
99 wxCoord XLOG2DEV(wxCoord x) const
100 {
101 wxCoord new_x = x - m_logicalOriginX;
102 if (new_x > 0)
103 return (wxCoord)((double)(new_x) * m_scaleX + 0.5) * m_signX + m_deviceOriginX;
104 else
105 return (wxCoord)((double)(new_x) * m_scaleX - 0.5) * m_signX + m_deviceOriginX;
106 }
107 wxCoord XLOG2DEVREL(wxCoord x) const
108 {
109 if (x > 0)
110 return (wxCoord)((double)(x) * m_scaleX + 0.5);
111 else
112 return (wxCoord)((double)(x) * m_scaleX - 0.5);
113 }
114 wxCoord YLOG2DEV(wxCoord y) const
115 {
116 wxCoord new_y = y - m_logicalOriginY;
117 if (new_y > 0)
118 return (wxCoord)((double)(new_y) * m_scaleY + 0.5) * m_signY + m_deviceOriginY;
119 else
120 return (wxCoord)((double)(new_y) * m_scaleY - 0.5) * m_signY + m_deviceOriginY;
121 }
122 wxCoord YLOG2DEVREL(wxCoord y) const
123 {
124 if (y > 0)
125 return (wxCoord)((double)(y) * m_scaleY + 0.5);
126 else
127 return (wxCoord)((double)(y) * m_scaleY - 0.5);
128 }
129
130 protected:
131 // base class pure virtuals implemented here
132 virtual void DoSetClippingRegion(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
133 virtual void DoGetSizeMM(int* width, int* height) const;
134
135 public:
136 // GTK-specific member variables
137
138 // not sure what for, but what is a mm on a screen you don't know the size
139 // of?
140 double m_mm_to_pix_x,
141 m_mm_to_pix_y;
142
143 bool m_needComputeScaleX,
144 m_needComputeScaleY; // not yet used
145
146
147 private:
148 DECLARE_ABSTRACT_CLASS(wxDC)
149 };
150
151 // this must be defined when wxDC::Blit() honours the DC origian and needed to
152 // allow wxUniv code in univ/winuniv.cpp to work with versions of wxGTK
153 // 2.3.[23]
154 #ifndef wxHAS_WORKING_GTK_DC_BLIT
155 #define wxHAS_WORKING_GTK_DC_BLIT
156 #endif
157
158 #endif // __GTKDCH__