idl/inc/slot.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_IDL_INC_SLOT_HXX
  21 #define INCLUDED_IDL_INC_SLOT_HXX
  22
  23 #include <types.hxx>
  24 #include <command.hxx>
  25
  26 class SvMetaSlot : public SvMetaAttribute
  27 {
  28 public:
  29     tools::SvRef<SvMetaType>      aSlotType;
  30     tools::SvRef<SvMetaSlot>      aMethod;
  31     SvIdentifier     aGroupId;
  32     SvIdentifier     aExecMethod;
  33     SvIdentifier     aStateMethod;
  34     SvBOOL           aPseudoSlots;
  35
  36     SvBOOL           aToggle;
  37     SvBOOL           aAutoUpdate;
  38
  39     SvBOOL           aAsynchron;
  40
  41     SvBOOL           aRecordPerItem;// exclusive
  42     SvBOOL           aRecordPerSet;
  43     SvBOOL           aNoRecord;
  44     SvBOOL           aRecordAbsolute;
  45
  46     SvBOOL           aMenuConfig;
  47     SvBOOL           aToolBoxConfig;
  48     SvBOOL           aAccelConfig;
  49     SvBOOL           aFastCall;
  50     SvBOOL           aContainer;
  51     SvIdentifier     aPseudoPrefix;
  52     OString          aDisableFlags;
  53     SvMetaSlot*      pLinkedSlot;
  54     SvMetaSlot*      pNextSlot;
  55     sal_uLong        nListPos;
  56     SvMetaEnumValue* pEnumValue;
  57     SvBOOL           aReadOnlyDoc;
  58     SvBOOL           aExport;
  59
  60     void            WriteSlot( const OString& rShellName,
  61                             sal_uInt16 nCount, const OString& rSlotId,
  62                             SvSlotElementList &rList,
  63                             size_t nStart,
  64                             SvIdlDataBase & rBase, SvStream & rOutStm );
  65
  66     void            SetEnumValue(SvMetaEnumValue *p) { pEnumValue = p; }
  67     OString         GetMangleName() const;
  68     bool            IsVariable() const;
  69     bool            IsMethod() const;
  70
  71     void    SetRecordPerItem( bool bSet )
  72             {
  73                 aRecordPerItem = bSet;
  74                 if( bSet )
  75                     aRecordPerSet = aNoRecord = false;
  76             }
  77     void    SetRecordPerSet( bool bSet )
  78             {
  79                 aRecordPerSet = bSet;
  80                 if( bSet )
  81                     aRecordPerItem = aNoRecord = false;
  82             }
  83     void    SetNoRecord( bool bSet )
  84             {
  85                 aNoRecord = bSet;
  86                 if( bSet )
  87                     aRecordPerItem = aRecordPerSet = false;
  88             }
  89
  90 public:
  91             SvMetaSlot();
  92             SvMetaSlot( SvMetaType * pType );
  93
  94     SvMetaAttribute *   GetMethod() const;
  95     SvMetaType *        GetSlotType() const;
  96     const OString&      GetGroupId() const;
  97     const OString&      GetExecMethod() const;
  98     const OString&      GetStateMethod() const;
  99     const OString&      GetDisableFlags() const;
 100     bool                GetPseudoSlots() const;
 101     bool                GetToggle() const;
 102     bool                GetAutoUpdate() const;
 103
 104     bool                GetAsynchron() const;
 105
 106     bool                GetRecordPerItem() const;
 107     bool                GetRecordPerSet() const;
 108     bool                GetNoRecord() const;
 109     bool                GetRecordAbsolute() const;
 110
 111     const OString&      GetPseudoPrefix() const;
 112     bool                GetMenuConfig() const;
 113     bool                GetToolBoxConfig() const;
 114     bool                GetAccelConfig() const;
 115     bool                GetFastCall() const;
 116     bool                GetContainer() const;
 117     bool                GetReadOnlyDoc() const;
 118     bool                GetExport() const;
 119     bool                GetHidden() const;
 120
 121     sal_uLong           GetListPos() const
 122                         { return nListPos; }
 123     void                SetListPos(sal_uLong n)
 124                         { nListPos = n; }
 125     void                ResetSlotPointer()
 126                         { pNextSlot = pLinkedSlot = nullptr; }
 127
 128     virtual bool        Test( SvTokenStream & rInStm ) override;
 129     virtual void        ReadAttributesSvIdl( SvIdlDataBase & rBase,
 130                                              SvTokenStream & rInStm ) override;
 131     virtual bool        ReadSvIdl( SvIdlDataBase &, SvTokenStream & rInStm ) override;
 132     virtual void        Insert( SvSlotElementList&, const OString& rPrefix,
 133                                 SvIdlDataBase& ) override;
 134     void                WriteSlotStubs( const OString& rShellName,
 135                                     ByteStringList & rList,
 136                                     SvStream & rOutStm );
 137     sal_uInt16          WriteSlotMap( const OString& rShellName,
 138                                     sal_uInt16 nCount,
 139                                     SvSlotElementList&,
 140                                     size_t nStart,
 141                                     SvIdlDataBase & rBase,
 142                                     SvStream & rOutStm );
 143     sal_uInt16          WriteSlotParamArray( SvIdlDataBase & rBase,
 144                                             SvStream & rOutStm );
 145 };
 146
 147 #endif // INCLUDED_IDL_INC_SLOT_HXX
 148
 149 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */