/* -*- 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 <boost/ptr_container/ptr_map.hpp>
#include <com/sun/star/beans/XPropertyState.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/uno/DeploymentException.hpp>
#include <swtypes.hxx>
#include <flyenum.hxx>
#include <pam.hxx>
class SfxItemSet;
class SfxItemPropertySet;
struct SfxItemPropertySimpleEntry;
class SdrObject;
class SwTextNode;
class SwCursor;
class SwUnoCrsr;
class SwUnoTableCrsr;
class SwFormatColl;
struct SwSortOptions;
class SwDoc;
namespace sw { namespace mark { class IMark; } }
namespace com{ namespace sun{ namespace star{
namespace uno{
class Any;
}
namespace beans{
struct PropertyValue;
}
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
{
// keep Any's mapped by (WhichId << 16 ) + (MemberId)
boost::ptr_map<sal_uInt32,com::sun::star::uno::Any> maMap;
public:
void SetValue( sal_uInt16 nWhichId, sal_uInt16 nMemberId, const com::sun::star::uno::Any& rAny );
bool FillValue( sal_uInt16 nWhichId, sal_uInt16 nMemberId, const com::sun::star::uno::Any*& pAny );
};
::com::sun::star::uno::Reference< ::com::sun::star::text::XTextContent >
GetNestedTextContent(SwTextNode & rTextNode, sal_Int32 const nIndex,
bool const bParent);
bool getCrsrPropertyValue(const SfxItemPropertySimpleEntry& rEntry
, SwPaM& rPam
, com::sun::star::uno::Any *pAny
, com::sun::star::beans::PropertyState& eState
, const SwTextNode* pNode = 0 );
void GetCurPageStyle(SwPaM& rPaM, OUString &rString);
inline bool IsStartOfPara(SwPaM& rUnoCrsr)
{ return rUnoCrsr.GetPoint()->nContent == 0;}
inline bool IsEndOfPara(SwPaM& rUnoCrsr)
{ return rUnoCrsr.GetContentNode() &&
rUnoCrsr.GetPoint()->nContent == rUnoCrsr.GetContentNode()->Len();}
void resetCrsrPropertyValue(const SfxItemPropertySimpleEntry& rEntry, SwPaM& rPam);
void InsertFile(SwUnoCrsr* pUnoCrsr,
const OUString& rURL,
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& rOptions)
throw (com::sun::star::lang::IllegalArgumentException,
com::sun::star::io::IOException,
com::sun::star::uno::RuntimeException,
std::exception);
void getNumberingProperty(
SwPaM& rPam,
com::sun::star::beans::PropertyState& eState,
com::sun::star::uno::Any *pAny );
void setNumberingProperty(
const com::sun::star::uno::Any& rValue,
SwPaM& rPam);
sal_Int16 IsNodeNumStart(
SwPaM& rPam,
com::sun::star::beans::PropertyState& eState);
bool DocInsertStringSplitCR( SwDoc &rDoc,
const SwPaM &rNewCursor, const OUString &rText,
const bool bForceExpandHints );
void makeRedline( SwPaM& rPaM, const OUString& RedlineType,
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& RedlineProperties )
throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
void makeTableRowRedline( SwTableLine& rTableLine, const OUString& RedlineType,
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& RedlineProperties )
throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
void makeTableCellRedline( SwTableBox& rTableBox, const OUString& RedlineType,
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& RedlineProperties )
throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
/// @param bTableMode: attributes should be applied to a table selection
void SetCrsrAttr(SwPaM & rPam, const SfxItemSet & rSet,
const SetAttrMode nAttrMode,
const bool bTableMode = false);
void GetCrsrAttr(SwPaM & rPam, SfxItemSet & rSet,
const bool bOnlyTextAttr = false,
const bool bGetFromChrFormat = true);
void GetTextFromPam(SwPaM & rPam, OUString & rBuffer);
SwFormatColl * GetCurTextFormatColl(SwPaM & rPam, const bool bConditional);
void SelectPam(SwPaM & rPam, const bool bExpand);
void SetString(SwCursor & rCursor, const OUString & rString);
::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >
CreateSortDescriptor(const bool bFromTable);
bool ConvertSortProperties(
const ::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue >& rDescriptor,
SwSortOptions & rSortOpt);
/// @param bTableMode: attributes should be applied to a table selection
void SetPropertyValue(
SwPaM& rPaM,
const SfxItemPropertySet & rPropSet,
const OUString & rPropertyName,
const ::com::sun::star::uno::Any & rValue,
const SetAttrMode nAttrMode = SetAttrMode::DEFAULT,
const bool bTableMode = false)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::beans::PropertyVetoException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
/// @param bTableMode: attributes should be applied to a table selection
void SetPropertyValues(
SwPaM& rPaM,
const SfxItemPropertySet & rPropSet,
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > &
rPropertyValues,
const SetAttrMode nAttrMode = SetAttrMode::DEFAULT,
const bool bTableMode = false)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::beans::PropertyVetoException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
::com::sun::star::uno::Any GetPropertyValue(
SwPaM& rPaM,
const SfxItemPropertySet & rPropSet,
const OUString & rPropertyName)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyState > GetPropertyStates(
SwPaM & rPaM,
const SfxItemPropertySet & rPropSet,
const ::com::sun::star::uno::Sequence< OUString >&
rPropertyNames,
const SwGetPropertyStatesCaller eCaller =
SW_PROPERTY_STATE_CALLER_DEFAULT)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::uno::RuntimeException);
::com::sun::star::beans::PropertyState GetPropertyState(
SwPaM & rPaM,
const SfxItemPropertySet & rPropSet,
const OUString & rPropertyName)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::uno::RuntimeException);
void SetPropertyToDefault(
SwPaM & rPaM,
const SfxItemPropertySet & rPropSet,
const OUString & rPropertyName)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::uno::RuntimeException);
::com::sun::star::uno::Any GetPropertyDefault(
SwPaM & rPaM,
const SfxItemPropertySet & rPropSet,
const OUString & rPropertyName)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
bool SetPageDesc(
const ::com::sun::star::uno::Any& rValue,
SwDoc & rDoc, SfxItemSet & rSet);
void SetTextFormatColl(const ::com::sun::star::uno::Any & rAny, SwPaM & rPaM)
throw (::com::sun::star::lang::IllegalArgumentException, css::uno::RuntimeException);
bool SetCursorPropertyValue(
SfxItemPropertySimpleEntry const& rEntry,
::com::sun::star::uno::Any const& rValue,
SwPaM & rPam, SfxItemSet & rItemSet)
throw (::com::sun::star::lang::IllegalArgumentException, css::uno::RuntimeException, css::uno::DeploymentException);
/// 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(
::com::sun::star::uno::Reference<
::com::sun::star::uno::XInterface> const& xIfc,
SwDoc & rTargetDoc,
SwPaM *& o_rpPaM, std::pair<OUString, FlyCntType> & o_rFrame,
OUString & o_rTableName, SwUnoTableCrsr const*& o_rpTableCursor,
::sw::mark::IMark const*& o_rpMark,
std::vector<SdrObject *> & o_rSdrObjects);
::com::sun::star::uno::Reference<
::com::sun::star::text::XFlatParagraphIterator>
CreateFlatParagraphIterator(SwDoc &, sal_Int32, bool);
} // namespace SwUnoCursorHelper
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */