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