basic/source/inc/object.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: object.hxx,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _SAMPLE_OBJECT_HXX
  32 #define _SAMPLE_OBJECT_HXX
  33
  34 #include <basic/sbxfac.hxx>
  35 #ifndef __SBX_SBXVARIABLE_HXX //autogen
  36 #include <basic/sbxvar.hxx>
  37 #endif
  38 #include <basic/sbxobj.hxx>
  39
  40 // 1) Properties:
  41 //    Name      der Name, R/O
  42 //    Value     ein double-Wert, R/W
  43 // 2) Methoden:
  44 //    Display   Ausgabe eines Textes
  45 //    Square    Argument * Argument
  46 //    Event     Aufruf eines Basic-Programms
  47 // 3) Unterobjekte:
  48 //    eine Collection names "Elements". Der Zugriff ist sowohl als
  49 //    Property (fuer das gesamte Objekt) als auch als Methode (fuer
  50 //    einzelne Elemente, wird durchgereicht) implementiert.
  51 // Diese Implementation ist ein Beispiel fuer eine tabellengesteuerte
  52 // Version, die sehr viele Elemente enthalten kann.
  53 // Die Collection findet sich in COLLECTN.*, die in der Collection
  54 // enthaltenen Objekte in COLLELEM.*
  55
  56 class SampleObject : public SbxObject
  57 {
  58 using SbxVariable::GetInfo;
  59     // Definition eines Tabelleneintrags. Dies wird hier gemacht,
  60     // da dadurch die Methoden und Properties als private deklariert
  61     // werden koennen.
  62 #if defined ( ICC ) || defined ( HPUX ) || defined ( C50 ) || defined ( C52 )
  63 public:
  64 #endif
  65     typedef void( SampleObject::*pMeth )
  66         ( SbxVariable* pThis, SbxArray* pArgs, BOOL bWrite );
  67 #if defined ( ICC ) || defined ( HPUX )
  68 private:
  69 #endif
  70
  71     struct Methods {
  72         const char* pName;      // Name des Eintrags
  73         SbxDataType eType;      // Datentyp
  74         pMeth pFunc;            // Function Pointer
  75         short nArgs;            // Argumente und Flags
  76     };
  77     static Methods aMethods[];  // Methodentabelle
  78
  79     // Methoden
  80     void Display( SbxVariable*, SbxArray*, BOOL );
  81     void Event( SbxVariable*, SbxArray*, BOOL );
  82     void Square( SbxVariable*, SbxArray*, BOOL );
  83     void Create( SbxVariable*, SbxArray*, BOOL );
  84     // Infoblock auffuellen
  85     SbxInfo* GetInfo( short nIdx );
  86     // Broadcaster Notification
  87     virtual void SFX_NOTIFY( SfxBroadcaster& rBC, const TypeId& rBCType,
  88                              const SfxHint& rHint, const TypeId& rHintType );
  89 public:
  90     SampleObject( const String& );
  91     // Suchen eines Elements
  92     virtual SbxVariable* Find( const String&, SbxClassType );
  93 };
  94
  95 // Die dazugehoerige Factory:
  96
  97 class SampleObjectFac : public SbxFactory
  98 {
  99 public:
 100     virtual SbxObject* CreateObject( const String& );
 101 };
 102
 103 #endif