• Skip to content
  • Skip to link menu
KDE 3.5 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

kviewshell

Template.h

Go to the documentation of this file.
00001 //C-  -*- C++ -*-
00002 //C- -------------------------------------------------------------------
00003 //C- DjVuLibre-3.5
00004 //C- Copyright (c) 2002  Leon Bottou and Yann Le Cun.
00005 //C- Copyright (c) 2001  AT&T
00006 //C-
00007 //C- This software is subject to, and may be distributed under, the
00008 //C- GNU General Public License, Version 2. The license should have
00009 //C- accompanied the software or you may obtain a copy of the license
00010 //C- from the Free Software Foundation at http://www.fsf.org .
00011 //C-
00012 //C- This program is distributed in the hope that it will be useful,
00013 //C- but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 //C- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015 //C- GNU General Public License for more details.
00016 //C- 
00017 //C- DjVuLibre-3.5 is derived from the DjVu(r) Reference Library
00018 //C- distributed by Lizardtech Software.  On July 19th 2002, Lizardtech 
00019 //C- Software authorized us to replace the original DjVu(r) Reference 
00020 //C- Library notice by the following text (see doc/lizard2002.djvu):
00021 //C-
00022 //C-  ------------------------------------------------------------------
00023 //C- | DjVu (r) Reference Library (v. 3.5)
00024 //C- | Copyright (c) 1999-2001 LizardTech, Inc. All Rights Reserved.
00025 //C- | The DjVu Reference Library is protected by U.S. Pat. No.
00026 //C- | 6,058,214 and patents pending.
00027 //C- |
00028 //C- | This software is subject to, and may be distributed under, the
00029 //C- | GNU General Public License, Version 2. The license should have
00030 //C- | accompanied the software or you may obtain a copy of the license
00031 //C- | from the Free Software Foundation at http://www.fsf.org .
00032 //C- |
00033 //C- | The computer code originally released by LizardTech under this
00034 //C- | license and unmodified by other parties is deemed "the LIZARDTECH
00035 //C- | ORIGINAL CODE."  Subject to any third party intellectual property
00036 //C- | claims, LizardTech grants recipient a worldwide, royalty-free, 
00037 //C- | non-exclusive license to make, use, sell, or otherwise dispose of 
00038 //C- | the LIZARDTECH ORIGINAL CODE or of programs derived from the 
00039 //C- | LIZARDTECH ORIGINAL CODE in compliance with the terms of the GNU 
00040 //C- | General Public License.   This grant only confers the right to 
00041 //C- | infringe patent claims underlying the LIZARDTECH ORIGINAL CODE to 
00042 //C- | the extent such infringement is reasonably necessary to enable 
00043 //C- | recipient to make, have made, practice, sell, or otherwise dispose 
00044 //C- | of the LIZARDTECH ORIGINAL CODE (or portions thereof) and not to 
00045 //C- | any greater extent that may be necessary to utilize further 
00046 //C- | modifications or combinations.
00047 //C- |
00048 //C- | The LIZARDTECH ORIGINAL CODE is provided "AS IS" WITHOUT WARRANTY
00049 //C- | OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
00050 //C- | TO ANY WARRANTY OF NON-INFRINGEMENT, OR ANY IMPLIED WARRANTY OF
00051 //C- | MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
00052 //C- +------------------------------------------------------------------
00053 // 
00054 // $Id: Template.h,v 1.8 2003/11/07 22:08:22 leonb Exp $
00055 // $Name: release_3_5_15 $
00056 
00057 //T// This is a template for the header files in the
00058 //T// DjVu reference library. It describes the general
00059 //T// conventions as well as the documentation. 
00060 //T// Comments prefixed with '//T//' explain the template
00061 //T// features and should be removed.
00062 
00063 #ifndef _TEMPLATE_H_
00064 #define _TEMPLATE_H_
00065 #ifdef HAVE_CONFIG_H
00066 #include "config.h"
00067 #endif
00068 #if NEED_GNUG_PRAGMAS
00069 # pragma interface
00070 #endif
00071 
00072 //T// Always include "DjVuGlobal.h"
00073 #include "DjVuGlobal.h"
00074 
00075 //T// Other include files
00076 #include <string.h>
00077 #include "GException.h"
00078 
00079 //T// Begin name space
00080 
00081 #ifdef HAVE_NAMESPACES
00082 namespace DJVU {
00083 # ifdef NOT_DEFINED // Just to fool emacs c++ mode
00084 }
00085 #endif
00086 #endif
00087 
00133 //T// The magic doc++ comment above opens a doc++ context.
00134 
00135 
00136 
00137 //T// Now comes the 'interface part' of the file.
00138 //T// The c++ classes and public functions are defined there.
00139 //T// Doc++ comments must be inserted for all functions
00140 //T// intended to be used by other people. 
00141 //T//
00142 //T// Quite often c++ sucks and it is necessary to have public or external symbols
00143 //T// that actually are only there for implementation purposes. 
00144 //T// It is good to give a comment but this should not be a doc++ comment
00145 //T// (see class GPool in GContainer.h).  All other 'public' and 'protected' 
00146 //T// members should have a doc++ comment. There is no need to comment 'private'
00147 //T// members, although a regular comment can be useful (not a doc++ comment). 
00148 
00149 
00150 
00162 class ExampleClass
00163 {
00164 public:
00166   ~ExampleClass();
00168   ExampleClass();
00170   ExampleClass(ExampleClass &ref);
00172   ExampleClass& operator=(ExampleClass &ref);
00184   void draw(Window win);
00185 protected:
00187   int xmin;
00189   int xmax;
00190 private:
00191   int whatever;
00192   float encode;
00193 };
00194 
00195 
00201 ExampleClass combine_example_classes(const ExampleClass&, 
00202                                      const ExampleClass &b);
00203 
00204 
00216 //T// The following comments should be used when
00217 //T// the preceding generic entry contains sub-entries
00219 //T// Sub-entries (both DOC++ and C++) should be declared there.
00221 
00222 
00223 
00224 
00225 
00226 
00228 //T// The magic doc++ comment above closes the doc++ file context.
00229 //T// The rest of the file only contains implementation stuff.
00230 
00231 // ------------ CLASSEXAMPLE INLINES
00232 //T// This is where all the inline/template functions should be written
00233 //T// This part of the file is segmented with comments.
00234 
00235 inline void 
00236 ClassExample::width()
00237 {
00238   return xmax-xmin;
00239 }
00240 
00241 
00242 
00243 // ------------ THE END
00244 //T// End name space
00245 
00246 #ifdef HAVE_NAMESPACES
00247 }
00248 # ifndef NOT_USING_DJVU_NAMESPACE
00249 using namespace DJVU;
00250 # endif
00251 #endif
00252 #endif
00253 //T// Terminates the multiple inclusion #ifndef
00254       
00255       
00256              
00257 
00258     

kviewshell

Skip menu "kviewshell"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

API Reference

Skip menu "API Reference"
  • kviewshell
Generated for API Reference by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal