sw/source/core/inc/environmentofanchoredobject.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
  20 #ifndef INCLUDED_SW_SOURCE_CORE_INC_ENVIRONMENTOFANCHOREDOBJECT_HXX
  21 #define INCLUDED_SW_SOURCE_CORE_INC_ENVIRONMENTOFANCHOREDOBJECT_HXX
  22
  23 class SwFrame;
  24 class SwLayoutFrame;
  25
  26 namespace objectpositioning
  27 {
  28 class SwEnvironmentOfAnchoredObject
  29 {
  30 private:
  31     const bool mbFollowTextFlow;
  32
  33 public:
  34     /** constructor
  35
  36         @param _bFollowTextFlow
  37         input parameter - indicates, if the anchored object, for which
  38         this environment is instantiated, follow the text flow or not
  39     */
  40     SwEnvironmentOfAnchoredObject(const bool _bFollowTextFlow);
  41
  42     /** determine environment layout frame for possible horizontal object
  43         positions respectively for alignment to 'page areas'
  44
  45         this is, if object has to follow the text flow:
  46         - cell frame, if anchored inside a cell
  47         - fly frame, if anchored inside a fly frame
  48         otherwise it's the page frame
  49
  50         this is, if object hasn't to follow the text flow:
  51         - page frame.
  52         - no exception any more. Thus remove
  53         parameter <_bForPageAlignment>
  54
  55         @param _rHoriOrientFrame
  56         input parameter - frame, at which the horizontal position is
  57         oriented at (typically it's the anchor frame).
  58         starting point for the search of the layout frame.
  59
  60         @return reference to the layout frame, which determines the
  61         horizontal environment the object has to be positioned in.
  62     */
  63     const SwLayoutFrame& GetHoriEnvironmentLayoutFrame(const SwFrame& _rHoriOrientFrame) const;
  64
  65     /** determine environment layout frame for possible vertical object
  66         positions respectively for alignments to 'page areas'
  67
  68         this is, if object has to follow the text flow:
  69         - cell frame, if anchored inside a cell
  70         - fly frame, if anchored inside a fly frame
  71         - header/footer frame, if anchored inside page header/footer
  72         - footnote frame, if anchored inside footnote
  73         otherwise it's the document body frame
  74
  75         this is, if object hasn't to follow the text flow:
  76         - page frame.
  77         - no exception any more. Thus remove
  78         parameter <_bForPageAlignment>
  79
  80         @param _rVertOrientFrame
  81         input parameter - frame, at which the vertical position is
  82         oriented at (typically it's the anchor frame).
  83         starting point for the search of the layout frame.
  84
  85         @return reference to the layout frame, which determines the
  86         vertical environment the object has to be positioned in.
  87     */
  88     const SwLayoutFrame& GetVertEnvironmentLayoutFrame(const SwFrame& _rVertOrientFrame) const;
  89 };
  90 }
  91
  92 #endif
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */