XTPReportRecordItemProgress.h
上传用户:szled88
上传日期:2015-04-09
资源大小:43957k
文件大小:8k
源码类别:

对话框与窗口

开发平台:

Visual C++

  1. // XTPReportRecordItemProgress.h: interface for the CXTPReportRecordItemProgress class.
  2. //
  3. // This file is a part of the XTREME REPORTCONTROL MFC class library.
  4. // (c)1998-2008 Codejock Software, All Rights Reserved.
  5. //
  6. // THIS SOURCE FILE IS THE PROPERTY OF CODEJOCK SOFTWARE AND IS NOT TO BE
  7. // RE-DISTRIBUTED BY ANY MEANS WHATSOEVER WITHOUT THE EXPRESSED WRITTEN
  8. // CONSENT OF CODEJOCK SOFTWARE.
  9. //
  10. // THIS SOURCE CODE CAN ONLY BE USED UNDER THE TERMS AND CONDITIONS OUTLINED
  11. // IN THE XTREME TOOLKIT PRO LICENSE AGREEMENT. CODEJOCK SOFTWARE GRANTS TO
  12. // YOU (ONE SOFTWARE DEVELOPER) THE LIMITED RIGHT TO USE THIS SOFTWARE ON A
  13. // SINGLE COMPUTER.
  14. //
  15. // CONTACT INFORMATION:
  16. // support@codejock.com
  17. // http://www.codejock.com
  18. //
  19. /////////////////////////////////////////////////////////////////////////////
  20. //{{AFX_CODEJOCK_PRIVATE
  21. #if !defined(__XTPREPORTRECORDITEMPROGRESS_H__)
  22. #define __XTPREPORTRECORDITEMPROGRESS_H__
  23. //}}AFX_CODEJOCK_PRIVATE
  24. #if _MSC_VER > 1000
  25. #pragma once
  26. #endif // _MSC_VER > 1000
  27. #include "......SourceReportControlXTPReportRecordItemText.h"
  28. //===========================================================================
  29. // Summary:
  30. //     This Class represents a progress bar cell and inherits basic functionality
  31. //     from CXTPReportRecordItemText class.
  32. //     You create a progress record item by calling a constructor with one
  33. //     parameter - text string. You create progress bars by subsequent calls to
  34. //     AddProgress method.
  35. // See Also: CXTPReportRecordItem, AddProgress
  36. //===========================================================================
  37. class CXTPReportRecordItemProgress : public CXTPReportRecordItemText
  38. {
  39. DECLARE_SERIAL(CXTPReportRecordItemProgress)
  40. public:
  41. //-----------------------------------------------------------------------
  42. // Summary:
  43. //     Creates a record progress item.
  44. // Parameters:
  45. //     szText - A text value for the item.
  46. //-----------------------------------------------------------------------
  47. CXTPReportRecordItemProgress(LPCTSTR szText = _T(""));
  48. //-----------------------------------------------------------------------
  49. // Summary:
  50. //     Creates a record progress item.
  51. // Parameters:
  52. //     szText - A text value for the item.
  53. //-----------------------------------------------------------------------
  54. CXTPReportRecordItemProgress(LPCTSTR szText, COLORREF clrProgress, int nWidth, int nLower, int nUpper, int nStep, int nPos);
  55. //-----------------------------------------------------------------------
  56. // Summary:
  57. //     Sets progress color.
  58. // Parameters:
  59. //     clrProgress - progress color.
  60. //-----------------------------------------------------------------------
  61. void SetProgressColor(COLORREF clrProgress);
  62. //-----------------------------------------------------------------------
  63. // Summary:
  64. //     Gets progress color.
  65. // Returns:
  66. //     The progress color.
  67. //-----------------------------------------------------------------------
  68. COLORREF GetProgressColor();
  69. //-----------------------------------------------------------------------
  70. // Summary:
  71. //     Sets progress width.
  72. // Parameters:
  73. //     nWidth - progress width.
  74. //-----------------------------------------------------------------------
  75. void SetProgressWidth(int nWidth);
  76. //-----------------------------------------------------------------------
  77. // Summary:
  78. //     Gets progress width.
  79. // Returns:
  80. //     The progress width.
  81. //-----------------------------------------------------------------------
  82. int GetProgressWidth();
  83. //-----------------------------------------------------------------------
  84. // Summary:
  85. //     Sets progress range.
  86. // Parameters:
  87. //     nLower - progress lower limit.
  88. //     nUpper - progress upper limit.
  89. //-----------------------------------------------------------------------
  90. void SetProgressRange(int nLower, int nUpper);
  91. //-----------------------------------------------------------------------
  92. // Summary:
  93. //     Gets progress range.
  94. // Parameters:
  95. //     nLower - progress lower limit.
  96. //     nUpper - progress upper limit.
  97. //-----------------------------------------------------------------------
  98. void GetProgressRange(int& nLower, int& nUpper);
  99. //-----------------------------------------------------------------------
  100. // Summary:
  101. //     Sets progress step.
  102. // Parameters:
  103. //     nStep - progress step.
  104. //-----------------------------------------------------------------------
  105. void SetProgressStep(int nWidth);
  106. //-----------------------------------------------------------------------
  107. // Summary:
  108. //     Gets progress step.
  109. // Returns:
  110. //     The progress step.
  111. //-----------------------------------------------------------------------
  112. int GetProgressStep();
  113. //-----------------------------------------------------------------------
  114. // Summary:
  115. //     Sets the progress position.
  116. // Parameters:
  117. //     nPos - progress position.
  118. // Returns:
  119. //     The previous position of the progress.
  120. //-----------------------------------------------------------------------
  121. int SetProgressPos(int nPos);
  122. //-----------------------------------------------------------------------
  123. // Summary:
  124. //     Returns the progress position.
  125. // Returns:
  126. //     Progress position.
  127. //-----------------------------------------------------------------------
  128. int GetProgressPos();
  129. //-----------------------------------------------------------------------
  130. // Summary:
  131. //     Returns the progress position in percents.
  132. // Returns:
  133. //     Progress position in percents.
  134. //-----------------------------------------------------------------------
  135. int GetProgressPosPercent();
  136. //-----------------------------------------------------------------------
  137. // Summary:
  138. //     Advances the progress position by the specified increment.
  139. // Parameters:
  140. //     nOffset - amount to advance the position.
  141. // Returns:
  142. //     The previous position of the progress.
  143. //-----------------------------------------------------------------------
  144. int OffsetProgressPos(int nOffset);
  145. //-----------------------------------------------------------------------
  146. // Summary:
  147. //     Advances the progress position by the step increment.
  148. // Returns:
  149. //     The previous position of the progress.
  150. //-----------------------------------------------------------------------
  151. int StepProgressPos();
  152. //-----------------------------------------------------------------------
  153. // Summary:
  154. //     Should be overridden by descendants for drawing itself.
  155. // Parameters:
  156. //     pDrawArgs - structure which contain drawing arguments.
  157. //     pMetrics - structure which contain metrics of the item.
  158. //-----------------------------------------------------------------------
  159. virtual void OnDrawCaption(XTP_REPORTRECORDITEM_DRAWARGS* pDrawArgs, XTP_REPORTRECORDITEM_METRICS* pMetrics);
  160. //-----------------------------------------------------------------------
  161. // Summary:
  162. //     Call this member function to Store/Load a report record item
  163. //     using the specified data object.
  164. // Parameters:
  165. //     pPX - Source or destination CXTPPropExchange data object reference.
  166. //-----------------------------------------------------------------------
  167. // virtual void DoPropExchange(CXTPPropExchange* pPX);
  168. protected:
  169. COLORREF m_clrProgress; // progress color.
  170. int m_nProgressWidth;   // progress width.
  171. int m_nProgressLower;   // progress lower limit.
  172. int m_nProgressUpper;   // progress upper limit.
  173. int m_nProgressStep;    // progress step increment.
  174. int m_nProgressPos;     // current progress position.
  175. };
  176. #endif //#if !defined(__XTPREPORTRECORDITEMPROGRESS_H__)