fd07479803
2003/11/10 12:59:02 od 1.1.2.1: #113049# - further improvements to the isolated object positioning algorithms
162 lines
6.2 KiB
C++
162 lines
6.2 KiB
C++
/*************************************************************************
|
|
*
|
|
* $RCSfile: environmentofanchoredobject.hxx,v $
|
|
*
|
|
* $Revision: 1.2 $
|
|
*
|
|
* last change: $Author: hr $ $Date: 2004-03-08 13:57:55 $
|
|
*
|
|
* The Contents of this file are made available subject to the terms of
|
|
* either of the following licenses
|
|
*
|
|
* - GNU Lesser General Public License Version 2.1
|
|
* - Sun Industry Standards Source License Version 1.1
|
|
*
|
|
* Sun Microsystems Inc., October, 2000
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2000 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
*
|
|
* Sun Industry Standards Source License Version 1.1
|
|
* =================================================
|
|
* The contents of this file are subject to the Sun Industry Standards
|
|
* Source License Version 1.1 (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.openoffice.org/license.html.
|
|
*
|
|
* Software provided under this License is provided on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
|
|
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
|
|
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
|
|
* See the License for the specific provisions governing your rights and
|
|
* obligations concerning the Software.
|
|
*
|
|
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
|
|
*
|
|
* Copyright: 2000 by Sun Microsystems, Inc.
|
|
*
|
|
* All Rights Reserved.
|
|
*
|
|
* Contributor(s): _______________________________________
|
|
*
|
|
*
|
|
************************************************************************/
|
|
#ifndef _ENVIRONMENTOFANCHOREDOBJECT_HXX
|
|
#define _ENVIRONMENTOFANCHOREDOBJECT_HXX
|
|
|
|
class SwFrm;
|
|
class SwLayoutFrm;
|
|
|
|
namespace objectpositioning
|
|
{
|
|
class SwEnvironmentOfAnchoredObject
|
|
{
|
|
private:
|
|
const bool mbFollowTextFlow;
|
|
|
|
public:
|
|
/** construtor
|
|
|
|
OD 05.11.2003
|
|
|
|
@author OD
|
|
|
|
@param _bFollowTextFlow
|
|
input parameter - indicates, if the anchored object, for which
|
|
this environment is instantiated, follow the text flow or not
|
|
*/
|
|
SwEnvironmentOfAnchoredObject( const bool _bFollowTextFlow );
|
|
|
|
/** destructor
|
|
|
|
OD 05.11.2003
|
|
|
|
@author OD
|
|
*/
|
|
~SwEnvironmentOfAnchoredObject();
|
|
|
|
/** determine environment layout frame for possible horizontal object
|
|
positions respectively for alignment to 'page areas'
|
|
|
|
OD 05.11.2003
|
|
this is, if object has to follow the text flow:
|
|
- cell frame, if anchored inside a cell
|
|
- fly frame, if anchored inside a fly frame
|
|
otherwise it's the page frame
|
|
|
|
this is, if object hasn't to follow the text flow:
|
|
- page frame.
|
|
- Exception: If environment layout frame is used for page alignment,
|
|
it's the cell frame, if anchored inside a cell.
|
|
|
|
@author OD
|
|
|
|
@param _rHoriOrientFrm
|
|
input parameter - frame, at which the horizontal position is
|
|
oriented at (typically it's the anchor frame).
|
|
starting point for the search of the layout frame.
|
|
|
|
@param _bForPageAlignment
|
|
input parameter - indicates, if the environment layout frame
|
|
for the page alignments has to be determined or not.
|
|
|
|
@return reference to the layout frame, which determines the
|
|
the horizontal environment the object has to be positioned in.
|
|
*/
|
|
const SwLayoutFrm& GetHoriEnvironmentLayoutFrm( const SwFrm& _rHoriOrientFrm,
|
|
const bool _bForPageAlignment ) const;
|
|
|
|
/** determine environment layout frame for possible vertical object
|
|
positions respectively for alignments to 'page areas'
|
|
|
|
OD 05.11.2003
|
|
this is, if object has to follow the text flow:
|
|
- cell frame, if anchored inside a cell
|
|
- fly frame, if anchored inside a fly frame
|
|
- header/footer frame, if anchored inside page header/footer
|
|
- footnote frame, if anchored inside footnote
|
|
otherwise it's the document body frame
|
|
|
|
this is, if object hasn't to follow the text flow:
|
|
- page frame.
|
|
- Exception: If environment layout frame is used for page alignment,
|
|
it's the cell frame, if anchored inside a cell.
|
|
|
|
@author OD
|
|
|
|
@param _rVertOrientFrm
|
|
input parameter - frame, at which the vertical position is
|
|
oriented at (typically it's the anchor frame).
|
|
starting point for the search of the layout frame.
|
|
|
|
@param _bForPageAlignment
|
|
input parameter - indicates, if the environment layout frame
|
|
for the page alignments has to be determined or not.
|
|
|
|
@return reference to the layout frame, which determines the
|
|
the vertical environment the object has to be positioned in.
|
|
*/
|
|
const SwLayoutFrm& GetVertEnvironmentLayoutFrm( const SwFrm& _rVertOrientFrm,
|
|
const bool _bForPageAlignment ) const;
|
|
};
|
|
};
|
|
|
|
#endif
|