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     SvIdentifier     aGroupId;
  30     SvIdentifier     aExecMethod;
  31     SvIdentifier     aStateMethod;
  32
  33     SvBOOL           aToggle;
  34     SvBOOL           aAutoUpdate;
  35
  36     SvBOOL           aAsynchron;
  37
  38     SvBOOL           aRecordPerItem;// exclusive
  39     SvBOOL           aRecordPerSet;
  40     SvBOOL           aNoRecord;
  41     SvBOOL           aRecordAbsolute;
  42
  43     SvBOOL           aMenuConfig;
  44     SvBOOL           aToolBoxConfig;
  45     SvBOOL           aAccelConfig;
  46     SvBOOL           aFastCall;
  47     SvBOOL           aContainer;
  48     OString          aDisableFlags;
  49     SvMetaSlot*      pNextSlot;
  50     sal_uLong        nListPos;
  51     SvBOOL           aReadOnlyDoc;
  52
  53     void            WriteSlot( const OString& rShellName,
  54                             sal_uInt16 nCount, const OString& rSlotId,
  55                             SvSlotElementList &rList,
  56                             size_t nStart,
  57                             SvIdlDataBase & rBase, SvStream & rOutStm );
  58
  59     bool            IsVariable() const;
  60     bool            IsMethod() const;
  61
  62     void    SetRecordPerItem( bool bSet )
  63             {
  64                 aRecordPerItem = bSet;
  65                 if( bSet )
  66                     aRecordPerSet = aNoRecord = false;
  67             }
  68     void    SetRecordPerSet( bool bSet )
  69             {
  70                 aRecordPerSet = bSet;
  71                 if( bSet )
  72                     aRecordPerItem = aNoRecord = false;
  73             }
  74     void    SetNoRecord( bool bSet )
  75             {
  76                 aNoRecord = bSet;
  77                 if( bSet )
  78                     aRecordPerItem = aRecordPerSet = false;
  79             }
  80
  81 public:
  82             SvMetaSlot();
  83             SvMetaSlot( SvMetaType * pType );
  84
  85     const OString&      GetGroupId() const;
  86     const OString&      GetExecMethod() const;
  87     const OString&      GetStateMethod() const;
  88     const OString&      GetDisableFlags() const;
  89     bool                GetToggle() const;
  90     bool                GetAutoUpdate() const;
  91
  92     bool                GetAsynchron() const;
  93
  94     bool                GetRecordPerItem() const;
  95     bool                GetRecordPerSet() const;
  96     bool                GetNoRecord() const;
  97     bool                GetRecordAbsolute() const;
  98
  99     bool                GetMenuConfig() const;
 100     bool                GetToolBoxConfig() const;
 101     bool                GetAccelConfig() const;
 102     bool                GetFastCall() const;
 103     bool                GetContainer() const;
 104     bool                GetReadOnlyDoc() const;
 105
 106     sal_uLong           GetListPos() const
 107                         { return nListPos; }
 108     void                SetListPos(sal_uLong n)
 109                         { nListPos = n; }
 110     void                ResetSlotPointer()
 111                         { pNextSlot = nullptr; }
 112
 113     virtual bool        Test( SvTokenStream & rInStm ) override;
 114     virtual void        ReadAttributesSvIdl( SvIdlDataBase & rBase,
 115                                              SvTokenStream & rInStm ) override;
 116     virtual bool        ReadSvIdl( SvIdlDataBase &, SvTokenStream & rInStm ) override;
 117     virtual void        Insert( SvSlotElementList& ) override;
 118     void                WriteSlotStubs( const OString& rShellName,
 119                                     std::vector<OString> & rList,
 120                                     SvStream & rOutStm ) const;
 121     sal_uInt16          WriteSlotMap( const OString& rShellName,
 122                                     sal_uInt16 nCount,
 123                                     SvSlotElementList&,
 124                                     size_t nStart,
 125                                     SvIdlDataBase & rBase,
 126                                     SvStream & rOutStm );
 127     sal_uInt16          WriteSlotParamArray( SvIdlDataBase & rBase,
 128                                             SvStream & rOutStm ) const;
 129 };
 130
 131 #endif // INCLUDED_IDL_INC_SLOT_HXX
 132
 133 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */