finalcut/doc/class_template.h

/***********************************************************************
* fclassname.h - [brief description]                                   *
*                                                                      *
* This file is part of the Final Cut widget toolkit                    *
*                                                                      *
* Copyright [year] [Maintainer]                                        *
*                                                                      *
* The Final Cut is free software; you can redistribute it and/or       *
* modify it under the terms of the GNU Lesser General Public License   *
* as published by the Free Software Foundation; either version 3 of    *
* the License, or (at your option) any later version.                  *
*                                                                      *
* The Final Cut is distributed in the hope that it will be useful,     *
* but WITHOUT ANY WARRANTY; without even the implied warranty of       *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
* GNU Lesser General Public License for more details.                  *
*                                                                      *
* You should have received a copy of the GNU Lesser General Public     *
* License along with this program.  If not, see                        *
* <http://www.gnu.org/licenses/>.                                      *
***********************************************************************/

/*  Standalone class
 *  ════════════════
 *
 * ▕▔▔▔▔▔▔▔▔▔▔▔▔▏
 * ▕ FClassName ▏
 * ▕▁▁▁▁▁▁▁▁▁▁▁▁▏
 */

#ifndef FCLASSNAME_H
#define FCLASSNAME_H

#if !defined (USE_FINAL_H) && !defined (COMPILE_FINAL_CUT)
  #error "Only <final/final.h> can be included directly."
#endif

//#include ...


//----------------------------------------------------------------------
// class FClassName
//----------------------------------------------------------------------

#pragma pack(push)
#pragma pack(1)

class FClassName
{
  public:
    // Using-declaration

    // Typedefs and Enumerations

    // Constants

    // Constructors
    FClassName();

    // Destructor
    ~FClassName();

    // Overloaded operators

    // Accessors

    // Mutators

    // Inquiries

    // Methods

    // Event handlers

    // Callback methods

    // Data Members

  protected:
    // Typedefs and Enumerations

    // Constants

    // Accessors

    // Inquiries

    // Methods

    // Event handlers

    // Callback methods

    // Data Members

  private:
    // Typedefs and Enumerations

    // Constants

    // Disable copy constructor
    FClassName (const FClassName&);

    // Disable assignment operator (=)
    FClassName& operator = (const FClassName&);

    // Accessors

    // Inquiries

    // Methods

    // Event handlers

    // Callback methods

    // Data Members

    // Friend class

};
#pragma pack(pop)

// FClassName inline functions
//----------------------------------------------------------------------


#endif  // FCLASSNAME_H