sw/inc/docfunc.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_DOCFUNC_HXX
  20 #define INCLUDED_SW_INC_DOCFUNC_HXX
  21
  22 class SwDoc;
  23
  24 // namespace <docfunc> for functions and procedures working on a Writer document.
  25 namespace docfunc
  26 {
  27 /** method to check, if given Writer document contains at least one drawing object
  28
  29     @param p_rDoc
  30     input parameter - reference to the Writer document, which is investigated.
  31 */
  32 bool ExistsDrawObjs(SwDoc& p_rDoc);
  33
  34 /** method to check, if given Writer document contains only drawing objects,
  35     which are completely on its page.
  36
  37     @param p_rDoc
  38     input parameter - reference to the Writer document, which is investigated.
  39 */
  40 bool AllDrawObjsOnPage(SwDoc& p_rDoc);
  41
  42 /** method to check, if the outline style has to written as a normal list style
  43
  44     #i69627#
  45     The outline style has to written as a normal list style, if a parent
  46     paragraph style of one of the paragraph styles, which are assigned to
  47     the list levels of the outline style, has a list style set or inherits
  48     a list style from its parent paragraphs style.
  49     This information is needed for the OpenDocument file format export.
  50
  51     @param rDoc
  52     input parameter - reference to the text document, which is investigated.
  53
  54     @return boolean
  55     indicating, if the outline style has to written as a normal list style
  56 */
  57 bool HasOutlineStyleToBeWrittenAsNormalListStyle(SwDoc& rDoc);
  58 }
  59
  60 #endif //_DOCFUNC_HXX
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */