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