sw/inc/fmteiro.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 #ifndef INCLUDED_SW_INC_FMTEIRO_HXX
  20 #define INCLUDED_SW_INC_FMTEIRO_HXX
  21
  22 #include <svl/eitem.hxx>
  23 #include "hintids.hxx"
  24 #include "format.hxx"
  25 #include "swdllapi.h"
  26
  27 class IntlWrapper;
  28
  29 /// Allows you to edit the contents of a TextFrame in a document that is read-only.
  30 ///
  31 /// Appears in the item set of an sw::SpzFrameFormat.
  32 ///
  33 /// Insert -> Frame -> Frame -> Options -> Editable in read-only document on the UI.
  34 class SW_DLLPUBLIC SwFormatEditInReadonly final : public SfxBoolItem
  35 {
  36 public:
  37     SwFormatEditInReadonly( sal_uInt16 nId = RES_EDIT_IN_READONLY,
  38                      bool bPrt = false ) : SfxBoolItem( nId, bPrt, SfxItemType::SwFormatEditInReadonly ) {}
  39
  40     /// "pure virtual method" of SfxPoolItem
  41     virtual SwFormatEditInReadonly* Clone( SfxItemPool *pPool = nullptr ) const override;
  42     virtual bool GetPresentation( SfxItemPresentation ePres,
  43                                   MapUnit eCoreMetric,
  44                                   MapUnit ePresMetric,
  45                                   OUString &rText,
  46                                   const IntlWrapper& rIntl ) const override;
  47     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
  48 };
  49
  50 inline const SwFormatEditInReadonly &SwAttrSet::GetEditInReadonly(bool bInP) const
  51     { return Get( RES_EDIT_IN_READONLY,bInP); }
  52
  53 inline const SwFormatEditInReadonly &SwFormat::GetEditInReadonly(bool bInP) const
  54     { return m_aSet.GetEditInReadonly(bInP); }
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */