1*1d2dbeb0SAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3*1d2dbeb0SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*1d2dbeb0SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*1d2dbeb0SAndrew Rist * distributed with this work for additional information 6*1d2dbeb0SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*1d2dbeb0SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*1d2dbeb0SAndrew Rist * "License"); you may not use this file except in compliance 9*1d2dbeb0SAndrew Rist * with the License. You may obtain a copy of the License at 10cdf0e10cSrcweir * 11*1d2dbeb0SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12cdf0e10cSrcweir * 13*1d2dbeb0SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*1d2dbeb0SAndrew Rist * software distributed under the License is distributed on an 15*1d2dbeb0SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*1d2dbeb0SAndrew Rist * KIND, either express or implied. See the License for the 17*1d2dbeb0SAndrew Rist * specific language governing permissions and limitations 18*1d2dbeb0SAndrew Rist * under the License. 19cdf0e10cSrcweir * 20*1d2dbeb0SAndrew Rist *************************************************************/ 21*1d2dbeb0SAndrew Rist 22*1d2dbeb0SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir #ifndef IBLOCKCURSOR_HXX_INCLUDED 25cdf0e10cSrcweir #define IBLOCKCURSOR_HXX_INCLUDED 26cdf0e10cSrcweir 27cdf0e10cSrcweir class SwShellCrsr; 28cdf0e10cSrcweir class Point; 29cdf0e10cSrcweir 30cdf0e10cSrcweir /** Access to the block cursor 31cdf0e10cSrcweir 32cdf0e10cSrcweir A block cursor contains a SwShellCrsr and additional information about 33cdf0e10cSrcweir the rectangle which has been created by pressing the mouse button and 34cdf0e10cSrcweir moving the mouse. 35cdf0e10cSrcweir This interface provides access to the SwShellCrsr and to start and end 36cdf0e10cSrcweir point of the mouse movement. 37cdf0e10cSrcweir */ 38cdf0e10cSrcweir class IBlockCursor 39cdf0e10cSrcweir { 40cdf0e10cSrcweir public: 41cdf0e10cSrcweir /** Access to the shell cursor 42cdf0e10cSrcweir 43cdf0e10cSrcweir @return SwShellCrsr& which represents the start and end position of the 44cdf0e10cSrcweir current block selection 45cdf0e10cSrcweir */ 46cdf0e10cSrcweir virtual SwShellCrsr& getShellCrsr() = 0; 47cdf0e10cSrcweir 48cdf0e10cSrcweir /** Defines the starting vertex of the block selection 49cdf0e10cSrcweir 50cdf0e10cSrcweir @param rPt 51cdf0e10cSrcweir rPt should contain the document coordinates of the mouse cursor when 52cdf0e10cSrcweir the block selection starts (MouseButtonDown) 53cdf0e10cSrcweir */ 54cdf0e10cSrcweir virtual void setStartPoint( const Point &rPt ) = 0; 55cdf0e10cSrcweir 56cdf0e10cSrcweir /** Defines the ending vertex of the block selection 57cdf0e10cSrcweir 58cdf0e10cSrcweir @param rPt 59cdf0e10cSrcweir rPt should contain the document coordinates of the mouse cursor when 60cdf0e10cSrcweir the block selection has started and the mouse has been moved (MouseMove) 61cdf0e10cSrcweir */ 62cdf0e10cSrcweir virtual void setEndPoint( const Point &rPt ) = 0; 63cdf0e10cSrcweir 64cdf0e10cSrcweir /** The document coordinates where the block selection has been started 65cdf0e10cSrcweir 66cdf0e10cSrcweir @return 0, if no start point has been set 67cdf0e10cSrcweir */ 68cdf0e10cSrcweir virtual const Point* getStartPoint() const = 0; 69cdf0e10cSrcweir 70cdf0e10cSrcweir 71cdf0e10cSrcweir /** The document coordinates where the block selection ends (at the moment) 72cdf0e10cSrcweir 73cdf0e10cSrcweir @return 0, if no end point has been set 74cdf0e10cSrcweir */ 75cdf0e10cSrcweir virtual const Point* getEndPoint() const = 0; 76cdf0e10cSrcweir 77cdf0e10cSrcweir /** Deletion of the mouse created rectangle 78cdf0e10cSrcweir 79cdf0e10cSrcweir When start and end points exist, the block cursor depends on this. If the 80cdf0e10cSrcweir cursor is moved by cursor keys (e.g. up/down, home/end) the mouse rectangle 81cdf0e10cSrcweir is obsolet and has to be deleted. 82cdf0e10cSrcweir */ 83cdf0e10cSrcweir virtual void clearPoints() = 0; 84cdf0e10cSrcweir 85cdf0e10cSrcweir /** Destructor of the block curosr interface 86cdf0e10cSrcweir */ ~IBlockCursor()87cdf0e10cSrcweir virtual ~IBlockCursor() {}; 88cdf0e10cSrcweir }; 89cdf0e10cSrcweir 90cdf0e10cSrcweir #endif // IBLOCKCURSOR_HXX_INCLUDED 91cdf0e10cSrcweir 92