No Description

class_q_c_p_grid.tex 10KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. \hypertarget{class_q_c_p_grid}{}\section{Q\+C\+P\+Grid Class Reference}
  2. \label{class_q_c_p_grid}\index{Q\+C\+P\+Grid@{Q\+C\+P\+Grid}}
  3. Responsible for drawing the grid of a \hyperlink{class_q_c_p_axis}{Q\+C\+P\+Axis}.
  4. Inheritance diagram for Q\+C\+P\+Grid\+:\begin{figure}[H]
  5. \begin{center}
  6. \leavevmode
  7. \includegraphics[height=3.000000cm]{class_q_c_p_grid}
  8. \end{center}
  9. \end{figure}
  10. \subsection*{Public Member Functions}
  11. \begin{DoxyCompactItemize}
  12. \item
  13. \hyperlink{class_q_c_p_grid_acd1cdd2909625388a13048b698494a17}{Q\+C\+P\+Grid} (\hyperlink{class_q_c_p_axis}{Q\+C\+P\+Axis} $\ast$parent\+Axis)
  14. \item
  15. \hypertarget{class_q_c_p_grid_a0a8963e384d53cd77cbab7df96147458}{}bool {\bfseries sub\+Grid\+Visible} () const \label{class_q_c_p_grid_a0a8963e384d53cd77cbab7df96147458}
  16. \item
  17. \hypertarget{class_q_c_p_grid_abfa6c638a05b45b2ed31b680fc9b31fc}{}bool {\bfseries antialiased\+Sub\+Grid} () const \label{class_q_c_p_grid_abfa6c638a05b45b2ed31b680fc9b31fc}
  18. \item
  19. \hypertarget{class_q_c_p_grid_a4dfbc1cee989d8cae1434b765ab2a13b}{}bool {\bfseries antialiased\+Zero\+Line} () const \label{class_q_c_p_grid_a4dfbc1cee989d8cae1434b765ab2a13b}
  20. \item
  21. \hypertarget{class_q_c_p_grid_aca20b67548e3ae31fd02e6398ffd6cb9}{}Q\+Pen {\bfseries pen} () const \label{class_q_c_p_grid_aca20b67548e3ae31fd02e6398ffd6cb9}
  22. \item
  23. \hypertarget{class_q_c_p_grid_ac698f8c6864b1d8f0e2af97ca4b39cc6}{}Q\+Pen {\bfseries sub\+Grid\+Pen} () const \label{class_q_c_p_grid_ac698f8c6864b1d8f0e2af97ca4b39cc6}
  24. \item
  25. \hypertarget{class_q_c_p_grid_a06ea986b651860446e1224d2097259b9}{}Q\+Pen {\bfseries zero\+Line\+Pen} () const \label{class_q_c_p_grid_a06ea986b651860446e1224d2097259b9}
  26. \item
  27. void \hyperlink{class_q_c_p_grid_ad4ad6bf714ec45e08845456355a1b700}{set\+Sub\+Grid\+Visible} (bool visible)
  28. \item
  29. void \hyperlink{class_q_c_p_grid_a5692310ba183721a413d60951407d114}{set\+Antialiased\+Sub\+Grid} (bool enabled)
  30. \item
  31. void \hyperlink{class_q_c_p_grid_a3cc6d54647393ee71afb6da56af07aa4}{set\+Antialiased\+Zero\+Line} (bool enabled)
  32. \item
  33. void \hyperlink{class_q_c_p_grid_aa05ab9816ffb440908171e45e833b593}{set\+Pen} (const Q\+Pen \&pen)
  34. \item
  35. void \hyperlink{class_q_c_p_grid_a9edd3593f384d1f0b0202a39cef4453d}{set\+Sub\+Grid\+Pen} (const Q\+Pen \&pen)
  36. \item
  37. void \hyperlink{class_q_c_p_grid_a209f40fdb252397b418b82d3494d8ea0}{set\+Zero\+Line\+Pen} (const Q\+Pen \&pen)
  38. \end{DoxyCompactItemize}
  39. \subsection*{Protected Member Functions}
  40. \begin{DoxyCompactItemize}
  41. \item
  42. \hypertarget{class_q_c_p_grid_a9916f5e38b4d6cae446537aeb47c7272}{}virtual void {\bfseries apply\+Default\+Antialiasing\+Hint} (\hyperlink{class_q_c_p_painter}{Q\+C\+P\+Painter} $\ast$painter) const \label{class_q_c_p_grid_a9916f5e38b4d6cae446537aeb47c7272}
  43. \item
  44. \hypertarget{class_q_c_p_grid_ad009c23f96078616aa4f66a750974b23}{}virtual void {\bfseries draw} (\hyperlink{class_q_c_p_painter}{Q\+C\+P\+Painter} $\ast$painter)\label{class_q_c_p_grid_ad009c23f96078616aa4f66a750974b23}
  45. \item
  46. \hypertarget{class_q_c_p_grid_a3aff10e993f6625e255c19e4f97a09d8}{}void {\bfseries draw\+Grid\+Lines} (\hyperlink{class_q_c_p_painter}{Q\+C\+P\+Painter} $\ast$painter) const \label{class_q_c_p_grid_a3aff10e993f6625e255c19e4f97a09d8}
  47. \item
  48. \hypertarget{class_q_c_p_grid_afa5d9d12de419e881f381f2ab7cb414d}{}void {\bfseries draw\+Sub\+Grid\+Lines} (\hyperlink{class_q_c_p_painter}{Q\+C\+P\+Painter} $\ast$painter) const \label{class_q_c_p_grid_afa5d9d12de419e881f381f2ab7cb414d}
  49. \end{DoxyCompactItemize}
  50. \subsection*{Protected Attributes}
  51. \begin{DoxyCompactItemize}
  52. \item
  53. \hypertarget{class_q_c_p_grid_a4e4a0400d6319bb44c06341f6298c87b}{}bool {\bfseries m\+Sub\+Grid\+Visible}\label{class_q_c_p_grid_a4e4a0400d6319bb44c06341f6298c87b}
  54. \item
  55. \hypertarget{class_q_c_p_grid_a71b7051f833f0c5de3094998d6afdd87}{}bool {\bfseries m\+Antialiased\+Sub\+Grid}\label{class_q_c_p_grid_a71b7051f833f0c5de3094998d6afdd87}
  56. \item
  57. \hypertarget{class_q_c_p_grid_a8c0df56ae86440408c050895dcdb922b}{}bool {\bfseries m\+Antialiased\+Zero\+Line}\label{class_q_c_p_grid_a8c0df56ae86440408c050895dcdb922b}
  58. \item
  59. \hypertarget{class_q_c_p_grid_a1cdc4a3bccf6a40c2d4360def9fefa40}{}Q\+Pen {\bfseries m\+Pen}\label{class_q_c_p_grid_a1cdc4a3bccf6a40c2d4360def9fefa40}
  60. \item
  61. \hypertarget{class_q_c_p_grid_aa9004bc139ad3ea92629f0aaae81d83f}{}Q\+Pen {\bfseries m\+Sub\+Grid\+Pen}\label{class_q_c_p_grid_aa9004bc139ad3ea92629f0aaae81d83f}
  62. \item
  63. \hypertarget{class_q_c_p_grid_a379481871f17655c27eda30af233554f}{}Q\+Pen {\bfseries m\+Zero\+Line\+Pen}\label{class_q_c_p_grid_a379481871f17655c27eda30af233554f}
  64. \item
  65. \hypertarget{class_q_c_p_grid_a9a8a76731e6e737b65b929fd1995cc88}{}\hyperlink{class_q_c_p_axis}{Q\+C\+P\+Axis} $\ast$ {\bfseries m\+Parent\+Axis}\label{class_q_c_p_grid_a9a8a76731e6e737b65b929fd1995cc88}
  66. \end{DoxyCompactItemize}
  67. \subsection*{Friends}
  68. \begin{DoxyCompactItemize}
  69. \item
  70. \hypertarget{class_q_c_p_grid_af123edeca169ec7a31958a1d714e1a8a}{}class {\bfseries Q\+C\+P\+Axis}\label{class_q_c_p_grid_af123edeca169ec7a31958a1d714e1a8a}
  71. \end{DoxyCompactItemize}
  72. \subsection{Detailed Description}
  73. Responsible for drawing the grid of a \hyperlink{class_q_c_p_axis}{Q\+C\+P\+Axis}.
  74. This class is tightly bound to \hyperlink{class_q_c_p_axis}{Q\+C\+P\+Axis}. Every axis owns a grid instance and uses it to draw the grid lines, sub grid lines and zero-\/line. You can interact with the grid of an axis via \hyperlink{class_q_c_p_axis_ac4fb913cce3072b5e75a4635e0f6cd04}{Q\+C\+P\+Axis\+::grid}. Normally, you don\textquotesingle{}t need to create an instance of \hyperlink{class_q_c_p_grid}{Q\+C\+P\+Grid} yourself.
  75. The axis and grid drawing was split into two classes to allow them to be placed on different layers (both \hyperlink{class_q_c_p_axis}{Q\+C\+P\+Axis} and \hyperlink{class_q_c_p_grid}{Q\+C\+P\+Grid} inherit from \hyperlink{class_q_c_p_layerable}{Q\+C\+P\+Layerable}). Thus it is possible to have the grid in the background and the axes in the foreground, and any plottables/items in between. This described situation is the default setup, see the \hyperlink{class_q_c_p_layer}{Q\+C\+P\+Layer} documentation.
  76. \subsection{Constructor \& Destructor Documentation}
  77. \hypertarget{class_q_c_p_grid_acd1cdd2909625388a13048b698494a17}{}\index{Q\+C\+P\+Grid@{Q\+C\+P\+Grid}!Q\+C\+P\+Grid@{Q\+C\+P\+Grid}}
  78. \index{Q\+C\+P\+Grid@{Q\+C\+P\+Grid}!Q\+C\+P\+Grid@{Q\+C\+P\+Grid}}
  79. \subsubsection[{Q\+C\+P\+Grid}]{\setlength{\rightskip}{0pt plus 5cm}Q\+C\+P\+Grid\+::\+Q\+C\+P\+Grid (
  80. \begin{DoxyParamCaption}
  81. \item[{{\bf Q\+C\+P\+Axis} $\ast$}]{parent\+Axis}
  82. \end{DoxyParamCaption}
  83. )}\label{class_q_c_p_grid_acd1cdd2909625388a13048b698494a17}
  84. Creates a \hyperlink{class_q_c_p_grid}{Q\+C\+P\+Grid} instance and sets default values.
  85. You shouldn\textquotesingle{}t instantiate grids on their own, since every \hyperlink{class_q_c_p_axis}{Q\+C\+P\+Axis} brings its own \hyperlink{class_q_c_p_grid}{Q\+C\+P\+Grid}.
  86. \subsection{Member Function Documentation}
  87. \hypertarget{class_q_c_p_grid_a5692310ba183721a413d60951407d114}{}\index{Q\+C\+P\+Grid@{Q\+C\+P\+Grid}!set\+Antialiased\+Sub\+Grid@{set\+Antialiased\+Sub\+Grid}}
  88. \index{set\+Antialiased\+Sub\+Grid@{set\+Antialiased\+Sub\+Grid}!Q\+C\+P\+Grid@{Q\+C\+P\+Grid}}
  89. \subsubsection[{set\+Antialiased\+Sub\+Grid}]{\setlength{\rightskip}{0pt plus 5cm}void Q\+C\+P\+Grid\+::set\+Antialiased\+Sub\+Grid (
  90. \begin{DoxyParamCaption}
  91. \item[{bool}]{enabled}
  92. \end{DoxyParamCaption}
  93. )}\label{class_q_c_p_grid_a5692310ba183721a413d60951407d114}
  94. Sets whether sub grid lines are drawn antialiased. \hypertarget{class_q_c_p_grid_a3cc6d54647393ee71afb6da56af07aa4}{}\index{Q\+C\+P\+Grid@{Q\+C\+P\+Grid}!set\+Antialiased\+Zero\+Line@{set\+Antialiased\+Zero\+Line}}
  95. \index{set\+Antialiased\+Zero\+Line@{set\+Antialiased\+Zero\+Line}!Q\+C\+P\+Grid@{Q\+C\+P\+Grid}}
  96. \subsubsection[{set\+Antialiased\+Zero\+Line}]{\setlength{\rightskip}{0pt plus 5cm}void Q\+C\+P\+Grid\+::set\+Antialiased\+Zero\+Line (
  97. \begin{DoxyParamCaption}
  98. \item[{bool}]{enabled}
  99. \end{DoxyParamCaption}
  100. )}\label{class_q_c_p_grid_a3cc6d54647393ee71afb6da56af07aa4}
  101. Sets whether zero lines are drawn antialiased. \hypertarget{class_q_c_p_grid_aa05ab9816ffb440908171e45e833b593}{}\index{Q\+C\+P\+Grid@{Q\+C\+P\+Grid}!set\+Pen@{set\+Pen}}
  102. \index{set\+Pen@{set\+Pen}!Q\+C\+P\+Grid@{Q\+C\+P\+Grid}}
  103. \subsubsection[{set\+Pen}]{\setlength{\rightskip}{0pt plus 5cm}void Q\+C\+P\+Grid\+::set\+Pen (
  104. \begin{DoxyParamCaption}
  105. \item[{const Q\+Pen \&}]{pen}
  106. \end{DoxyParamCaption}
  107. )}\label{class_q_c_p_grid_aa05ab9816ffb440908171e45e833b593}
  108. Sets the pen with which (major) grid lines are drawn. \hypertarget{class_q_c_p_grid_a9edd3593f384d1f0b0202a39cef4453d}{}\index{Q\+C\+P\+Grid@{Q\+C\+P\+Grid}!set\+Sub\+Grid\+Pen@{set\+Sub\+Grid\+Pen}}
  109. \index{set\+Sub\+Grid\+Pen@{set\+Sub\+Grid\+Pen}!Q\+C\+P\+Grid@{Q\+C\+P\+Grid}}
  110. \subsubsection[{set\+Sub\+Grid\+Pen}]{\setlength{\rightskip}{0pt plus 5cm}void Q\+C\+P\+Grid\+::set\+Sub\+Grid\+Pen (
  111. \begin{DoxyParamCaption}
  112. \item[{const Q\+Pen \&}]{pen}
  113. \end{DoxyParamCaption}
  114. )}\label{class_q_c_p_grid_a9edd3593f384d1f0b0202a39cef4453d}
  115. Sets the pen with which sub grid lines are drawn. \hypertarget{class_q_c_p_grid_ad4ad6bf714ec45e08845456355a1b700}{}\index{Q\+C\+P\+Grid@{Q\+C\+P\+Grid}!set\+Sub\+Grid\+Visible@{set\+Sub\+Grid\+Visible}}
  116. \index{set\+Sub\+Grid\+Visible@{set\+Sub\+Grid\+Visible}!Q\+C\+P\+Grid@{Q\+C\+P\+Grid}}
  117. \subsubsection[{set\+Sub\+Grid\+Visible}]{\setlength{\rightskip}{0pt plus 5cm}void Q\+C\+P\+Grid\+::set\+Sub\+Grid\+Visible (
  118. \begin{DoxyParamCaption}
  119. \item[{bool}]{visible}
  120. \end{DoxyParamCaption}
  121. )}\label{class_q_c_p_grid_ad4ad6bf714ec45e08845456355a1b700}
  122. Sets whether grid lines at sub tick marks are drawn.
  123. \begin{DoxySeeAlso}{See also}
  124. \hyperlink{class_q_c_p_grid_a9edd3593f384d1f0b0202a39cef4453d}{set\+Sub\+Grid\+Pen}
  125. \end{DoxySeeAlso}
  126. \hypertarget{class_q_c_p_grid_a209f40fdb252397b418b82d3494d8ea0}{}\index{Q\+C\+P\+Grid@{Q\+C\+P\+Grid}!set\+Zero\+Line\+Pen@{set\+Zero\+Line\+Pen}}
  127. \index{set\+Zero\+Line\+Pen@{set\+Zero\+Line\+Pen}!Q\+C\+P\+Grid@{Q\+C\+P\+Grid}}
  128. \subsubsection[{set\+Zero\+Line\+Pen}]{\setlength{\rightskip}{0pt plus 5cm}void Q\+C\+P\+Grid\+::set\+Zero\+Line\+Pen (
  129. \begin{DoxyParamCaption}
  130. \item[{const Q\+Pen \&}]{pen}
  131. \end{DoxyParamCaption}
  132. )}\label{class_q_c_p_grid_a209f40fdb252397b418b82d3494d8ea0}
  133. Sets the pen with which zero lines are drawn.
  134. Zero lines are lines at value coordinate 0 which may be drawn with a different pen than other grid lines. To disable zero lines and just draw normal grid lines at zero, set {\itshape pen} to Qt\+::\+No\+Pen.
  135. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
  136. \item
  137. \hyperlink{qcustomplot_8h}{qcustomplot.\+h}\item
  138. \hyperlink{qcustomplot_8cpp}{qcustomplot.\+cpp}\end{DoxyCompactItemize}