/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef INCLUDED_SW_INC_FMTEIRO_HXX
#define INCLUDED_SW_INC_FMTEIRO_HXX

#include <svl/eitem.hxx>
#include "hintids.hxx"
#include "format.hxx"
#include "swdllapi.h"

/// Allows you to edit the contents of a TextFrame in a document that is read-only.
///
/// Appears in the item set of an sw::SpzFrameFormat.
///
/// Insert -> Frame -> Frame -> Options -> Editable in read-only document on the UI.
class SW_DLLPUBLIC SwFormatEditInReadonly final : public SfxBoolItem
{
public:
    DECLARE_ITEM_TYPE_FUNCTION(SwFormatEditInReadonly)
    SwFormatEditInReadonly( sal_uInt16 nId = RES_EDIT_IN_READONLY,
                     bool bPrt = false ) : SfxBoolItem( nId, bPrt ) {}

    /// "pure virtual method" of SfxPoolItem
    virtual SwFormatEditInReadonly* Clone( SfxItemPool *pPool = nullptr ) const override;
    virtual bool GetPresentation( SfxItemPresentation ePres,
                                  MapUnit eCoreMetric,
                                  MapUnit ePresMetric,
                                  OUString &rText,
                                  const IntlWrapper& rIntl ) const override;
    void dumpAsXml(xmlTextWriterPtr pWriter) const override;
};

inline const SwFormatEditInReadonly &SwAttrSet::GetEditInReadonly(bool bInP) const
    { return Get( RES_EDIT_IN_READONLY,bInP); }

inline const SwFormatEditInReadonly &SwFormat::GetEditInReadonly(bool bInP) const
    { return m_aSet.GetEditInReadonly(bInP); }

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
