diff options
Diffstat (limited to 'sw/inc/unocrsrhelper.hxx')
| -rw-r--r-- | sw/inc/unocrsrhelper.hxx | 247 |
1 files changed, 247 insertions, 0 deletions
diff --git a/sw/inc/unocrsrhelper.hxx b/sw/inc/unocrsrhelper.hxx new file mode 100644 index 0000000000..17a86716c3 --- /dev/null +++ b/sw/inc/unocrsrhelper.hxx @@ -0,0 +1,247 @@ +/* -*- 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_UNOCRSRHELPER_HXX +#define INCLUDED_SW_INC_UNOCRSRHELPER_HXX + +#include "swtypes.hxx" +#include "flyenum.hxx" +#include "pam.hxx" + +#include <map> +#include <string_view> + +class SfxItemSet; +class SfxItemPropertySet; +struct SfxItemPropertyMapEntry; +class SdrObject; +class SwTextNode; +class SwCursor; +class SwUnoCursor; +class SwUnoTableCursor; +class SwFormatColl; +struct SwSortOptions; +class SwDoc; +class SwRootFrame; + +namespace sw::mark { class IMark; } + +namespace com::sun::star{ + namespace beans{ + struct PropertyValue; + enum class PropertyState; + } + namespace text { + class XTextContent; + class XFlatParagraphIterator; + } +} + +enum SwGetPropertyStatesCaller +{ + SW_PROPERTY_STATE_CALLER_DEFAULT, + SW_PROPERTY_STATE_CALLER_SWX_TEXT_PORTION, + SW_PROPERTY_STATE_CALLER_SINGLE_VALUE_ONLY, + SW_PROPERTY_STATE_CALLER_SWX_TEXT_PORTION_TOLERANT +}; + +namespace SwUnoCursorHelper +{ + class SwAnyMapHelper + { + private: + // keep Any's mapped by (WhichId << 16 ) + (MemberId) + std::map<sal_uInt32, css::uno::Any> m_Map; + + public: + void SetValue( sal_uInt16 nWhichId, sal_uInt16 nMemberId, const css::uno::Any& rAny ); + bool FillValue( sal_uInt16 nWhichId, sal_uInt16 nMemberId, const css::uno::Any*& pAny ); + }; + + css::uno::Reference< css::text::XTextContent > + GetNestedTextContent(SwTextNode const & rTextNode, sal_Int32 const nIndex, + bool const bParent); + + bool getCursorPropertyValue(const SfxItemPropertyMapEntry& rEntry + , SwPaM& rPam + , css::uno::Any *pAny + , css::beans::PropertyState& eState + , const SwTextNode* pNode = nullptr ); + + void GetCurPageStyle(SwPaM const & rPaM, OUString &rString); + + inline bool IsStartOfPara(SwPaM& rUnoCursor) + { return rUnoCursor.GetPoint()->GetContentIndex() == 0;} + inline bool IsEndOfPara(SwPaM& rUnoCursor) + { return rUnoCursor.GetPointContentNode() && + rUnoCursor.GetPoint()->GetContentIndex() == rUnoCursor.GetPointContentNode()->Len();} + + void resetCursorPropertyValue(const SfxItemPropertyMapEntry& rEntry, SwPaM& rPam); + /// @throws css::lang::IllegalArgumentException + /// @throws css::io::IOException + /// @throws css::uno::RuntimeException + void InsertFile(SwUnoCursor* pUnoCursor, + const OUString& rURL, + const css::uno::Sequence< css::beans::PropertyValue >& rOptions); + + void getNumberingProperty( + SwPaM& rPam, + css::beans::PropertyState& eState, + css::uno::Any *pAny ); + + void setNumberingProperty( + const css::uno::Any& rValue, + SwPaM& rPam); + + sal_Int16 IsNodeNumStart( + SwPaM const & rPam, + css::beans::PropertyState& eState); + + bool DocInsertStringSplitCR( SwDoc &rDoc, + const SwPaM &rNewCursor, std::u16string_view aText, + const bool bForceExpandHints ); + /// @throws css::lang::IllegalArgumentException + /// @throws css::uno::RuntimeException + void makeRedline( SwPaM const & rPaM, std::u16string_view RedlineType, + const css::uno::Sequence< css::beans::PropertyValue >& RedlineProperties ); + + /// @throws css::lang::IllegalArgumentException + /// @throws css::uno::RuntimeException + void makeTableRowRedline( SwTableLine& rTableLine, std::u16string_view RedlineType, + const css::uno::Sequence< css::beans::PropertyValue >& RedlineProperties ); + + /// @throws css::lang::IllegalArgumentException + /// @throws css::uno::RuntimeException + SW_DLLPUBLIC void makeTableCellRedline( SwTableBox& rTableBox, std::u16string_view RedlineType, + const css::uno::Sequence< css::beans::PropertyValue >& RedlineProperties ); + + /// @param bTableMode: attributes should be applied to a table selection + void SetCursorAttr(SwPaM & rPam, const SfxItemSet & rSet, + const SetAttrMode nAttrMode, + const bool bTableMode = false); + void GetCursorAttr(SwPaM & rPam, SfxItemSet & rSet, + const bool bOnlyTextAttr = false, + const bool bGetFromChrFormat = true); + void GetTextFromPam(SwPaM & rPam, OUString & rBuffer, SwRootFrame const* pLayout = nullptr); + SwFormatColl * GetCurTextFormatColl(SwPaM & rPam, const bool bConditional); + + void SelectPam(SwPaM & rPam, const bool bExpand); + void SetString(SwCursor & rCursor, std::u16string_view aString); + + css::uno::Sequence< css::beans::PropertyValue > + CreateSortDescriptor(const bool bFromTable); + bool ConvertSortProperties( + const css::uno::Sequence< css::beans::PropertyValue >& rDescriptor, + SwSortOptions & rSortOpt); + + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException + void SetPropertyValue( + SwPaM& rPaM, + const SfxItemPropertySet & rPropSet, + const OUString & rPropertyName, + const css::uno::Any & rValue, + const SetAttrMode nAttrMode = SetAttrMode::DEFAULT); + /// @throws css::beans::UnknownPropertyException + /// @throws css::beans::PropertyVetoException + /// @throws css::lang::IllegalArgumentException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException + void SetPropertyValues( + SwPaM& rPaM, + const SfxItemPropertySet & rPropSet, + const css::uno::Sequence< css::beans::PropertyValue > & + rPropertyValues, + const SetAttrMode nAttrMode = SetAttrMode::DEFAULT); + void SetPropertyValues( + SwPaM& rPaM, + const SfxItemPropertySet & rPropSet, + std::span< const css::beans::PropertyValue > aPropertyValues, + const SetAttrMode nAttrMode = SetAttrMode::DEFAULT); + /// @throws css::beans::UnknownPropertyException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException + css::uno::Any GetPropertyValue( + SwPaM& rPaM, + const SfxItemPropertySet & rPropSet, + std::u16string_view rPropertyName); + /// @throws css::beans::UnknownPropertyException + /// @throws css::uno::RuntimeException + css::uno::Sequence< css::beans::PropertyState > GetPropertyStates( + SwPaM & rPaM, + const SfxItemPropertySet & rPropSet, + const css::uno::Sequence< OUString >& + rPropertyNames, + const SwGetPropertyStatesCaller eCaller = + SW_PROPERTY_STATE_CALLER_DEFAULT); + /// @throws css::beans::UnknownPropertyException + /// @throws css::uno::RuntimeException + css::beans::PropertyState GetPropertyState( + SwPaM & rPaM, + const SfxItemPropertySet & rPropSet, + const OUString & rPropertyName); + /// @throws css::beans::UnknownPropertyException + /// @throws css::uno::RuntimeException + void SetPropertyToDefault( + SwPaM & rPaM, + const SfxItemPropertySet & rPropSet, + std::u16string_view rPropertyName); + /// @throws css::beans::UnknownPropertyException + /// @throws css::lang::WrappedTargetException + /// @throws css::uno::RuntimeException + css::uno::Any GetPropertyDefault( + SwPaM const & rPaM, + const SfxItemPropertySet & rPropSet, + std::u16string_view rPropertyName); + + bool SetPageDesc( + const css::uno::Any& rValue, + SwDoc & rDoc, SfxItemSet & rSet); + /// @throws css::lang::IllegalArgumentException + /// @throws css::uno::RuntimeException + void SetTextFormatColl(const css::uno::Any & rAny, SwPaM & rPaM); + /// @throws css::lang::IllegalArgumentException + /// @throws css::uno::RuntimeException + /// @throws css::uno::DeploymentException + bool SetCursorPropertyValue( + SfxItemPropertyMapEntry const& rEntry, + css::uno::Any const& rValue, + SwPaM & rPam, SfxItemSet & rItemSet); + + /// try to get something that can be selected out of the XInterface + /// at most one of the out parameters gets assigned a non-null value + /// o_rpPaM is newly allocated and must be deleted; other parameters not + SW_DLLPUBLIC void GetSelectableFromAny( + css::uno::Reference<css::uno::XInterface> const& xIfc, + SwDoc & rTargetDoc, + SwPaM *& o_rpPaM, std::pair<OUString, FlyCntType> & o_rFrame, + OUString & o_rTableName, SwUnoTableCursor const*& o_rpTableCursor, + ::sw::mark::IMark const*& o_rpMark, + std::vector<SdrObject *> & o_rSdrObjects); + + css::uno::Reference<css::text::XFlatParagraphIterator> + CreateFlatParagraphIterator(SwDoc &, sal_Int32, bool); + +} // namespace SwUnoCursorHelper + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |