Subversion Repositories DevTools

//## begin module%1.7%.codegen_version preserve=yes
//   Read the documentation to learn more about C++ code generator
//   versioning.
//## end module%1.7%.codegen_version

//## begin module%42007ECF0011.cm preserve=no
//## end module%42007ECF0011.cm

//## begin module%42007ECF0011.cp preserve=no
//      C O P Y R I G H T   N O T I C E
//      This material is confidential to ERG and may not be disclosed in whole
//      or in part to any third party nor used in any manner whatsoever other
//      than for the purposes expressly consented to by ERG in writing.
//
//      This material is also copyright and may not be reproduced, stored in a
//      retrieval system or transmitted in any form or by any means in whole or
//      in part without the express written consent of ERG.
//## end module%42007ECF0011.cp

//## Module: ProgressBar%42007ECF0011; Pseudo Package specification
//## Subsystem: MASS::Dev::Tools::TxnTestManager::src%41F5A79001E4
//## Source file: Z:\MASS_Dev\Tools\TxnTestManager\src\ProgressBar.h

#ifndef ProgressBar_h
#define ProgressBar_h 1

//## begin module%42007ECF0011.additionalIncludes preserve=no
//## end module%42007ECF0011.additionalIncludes

//## begin module%42007ECF0011.includes preserve=yes
#include <vcl.h>
#pragma hdrstop
//## end module%42007ECF0011.includes

//## begin module%42007ECF0011.additionalDeclarations preserve=yes
#define ADV_PROGRESS_BAR
#ifdef ADV_PROGRESS_BAR
        #include "AdvProgressBar.hpp"
        typedef TAdvProgressBar ProgressBar_t;
#else
        typedef TProgressBar ProgressBar_t;
#endif
//## end module%42007ECF0011.additionalDeclarations


//## begin ProgressBar%42007ECF0011.preface preserve=yes
//## end ProgressBar%42007ECF0011.preface

//## Class: ProgressBar%42007ECF0011; private
//      A convenience wrapper around a progress bar.
//## Category: TransactionTestManager::Progress Bar%42007E0B0178
//## Subsystem: MASS::Dev::Tools::TxnTestManager::src%41F5A79001E4
//## Persistence: Transient
//## Cardinality/Multiplicity: n



class ProgressBar 
{
  //## begin ProgressBar%42007ECF0011.initialDeclarations preserve=yes
  //## end ProgressBar%42007ECF0011.initialDeclarations

  public:
    //## Constructors (specified)
      //## Operation: ProgressBar%42007F04030F
      //        The only constructor.
      ProgressBar (TWinControl *owner);

    //## Destructor (generated)
      virtual ~ProgressBar();


    //## Other Operations (specified)
      //## Operation: close%4200859302A4
      //        Close the progress bar.
      void close ();

      //## Operation: increment%4200923803B3
      //        Increment the position by the given amount.
      void increment (const unsigned int &delta = 1     // The amount by which to increment, which must be in the range 0..total.
      );

      //## Operation: open%4200813001F0
      //        Open the progress bar.
      void open (const unsigned int &total,     // The progress bar shall be at 100% when the position reaches total.
      const unsigned int &position = 0  // The starting position, with 0 being at 0%.
      );

      //## Operation: resize%4200826C0074
      //        Resize the progress bar.
      void resize (const int &top, const int &left, const int &width, const int &height);

      //## Operation: update%420085F6011D
      //        Update the position of this progress bar.
      void update (const unsigned int &position // The new position, which must be in the range 0..total.
      );

    // Additional Public Declarations
      //## begin ProgressBar%42007ECF0011.public preserve=yes
      //## end ProgressBar%42007ECF0011.public

  protected:
    // Additional Protected Declarations
      //## begin ProgressBar%42007ECF0011.protected preserve=yes
      //## end ProgressBar%42007ECF0011.protected

  private:
    //## Constructors (generated)
      ProgressBar();

      ProgressBar(const ProgressBar &right);

    //## Assignment Operation (generated)
      ProgressBar & operator=(const ProgressBar &right);

    // Data Members for Class Attributes

      //## Attribute: percent%420084A3037F
      //        The current position as percent.
      //## begin ProgressBar::percent%420084A3037F.attr preserve=no  private: unsigned int {VA} 0
      unsigned int m_percent;
      //## end ProgressBar::percent%420084A3037F.attr

      //## Attribute: position%4200929A03A4
      //        The current position.
      //## begin ProgressBar::position%4200929A03A4.attr preserve=no  private: unsigned int {VA} 0
      unsigned int m_position;
      //## end ProgressBar::position%4200929A03A4.attr

      //## Attribute: progressBar%42007F430144
      //        The underlying progress bar.
      //## begin ProgressBar::progressBar%42007F430144.attr preserve=no  private: ProgressBar_t {RA} 0
      ProgressBar_t *m_progressBar;
      //## end ProgressBar::progressBar%42007F430144.attr

      //## Attribute: total%420084330302
      //        The progress bar shall be at 100% when the position reaches total.
      //## begin ProgressBar::total%420084330302.attr preserve=no  private: unsigned int {VA} 0
      unsigned int m_total;
      //## end ProgressBar::total%420084330302.attr

    // Additional Private Declarations
      //## begin ProgressBar%42007ECF0011.private preserve=yes
      //## end ProgressBar%42007ECF0011.private

  private: //## implementation
    // Additional Implementation Declarations
      //## begin ProgressBar%42007ECF0011.implementation preserve=yes
      //## end ProgressBar%42007ECF0011.implementation

};

//## begin ProgressBar%42007ECF0011.postscript preserve=yes
//## end ProgressBar%42007ECF0011.postscript

// Class ProgressBar 

//## begin module%42007ECF0011.epilog preserve=yes
//## end module%42007ECF0011.epilog


#endif