1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef SC_OLINEWIN_HXX 25*b1cdbd2cSJim Jagielski #define SC_OLINEWIN_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "viewdata.hxx" 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski class ScOutlineEntry; 30*b1cdbd2cSJim Jagielski class ScOutlineArray; 31*b1cdbd2cSJim Jagielski class ScOutlineTable; 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski // ============================================================================ 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski enum ScOutlineMode { SC_OUTLINE_HOR, SC_OUTLINE_VER }; 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski // ---------------------------------------------------------------------------- 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski /** The window left of or above the spreadsheet containing the outline groups 42*b1cdbd2cSJim Jagielski and controls to expand/collapse them. */ 43*b1cdbd2cSJim Jagielski class ScOutlineWindow : public Window 44*b1cdbd2cSJim Jagielski { 45*b1cdbd2cSJim Jagielski private: 46*b1cdbd2cSJim Jagielski ScViewData& mrViewData; /// View data containing the document. 47*b1cdbd2cSJim Jagielski ScSplitPos meWhich; /// Which area in split window. 48*b1cdbd2cSJim Jagielski bool mbHoriz; /// true = Horizontal orientation. 49*b1cdbd2cSJim Jagielski bool mbMirrorEntries; /// true = mirror the order of entries (including header) 50*b1cdbd2cSJim Jagielski bool mbMirrorLevels; /// true = mirror the order of levels, including the border 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski ImageList* mpSymbols; /// Symbols for buttons. 53*b1cdbd2cSJim Jagielski Color maLineColor; /// Line color for expanded groups. 54*b1cdbd2cSJim Jagielski long mnHeaderSize; /// Size of the header area in entry direction. 55*b1cdbd2cSJim Jagielski long mnHeaderPos; /// Position of the header area in entry direction. 56*b1cdbd2cSJim Jagielski long mnMainFirstPos; /// First position of main area in entry direction. 57*b1cdbd2cSJim Jagielski long mnMainLastPos; /// Last position of main area in entry direction. 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski size_t mnMTLevel; /// Mouse tracking: Level of active button. 60*b1cdbd2cSJim Jagielski size_t mnMTEntry; /// Mouse tracking: Entry index of active button. 61*b1cdbd2cSJim Jagielski bool mbMTActive; /// Mouse tracking active? 62*b1cdbd2cSJim Jagielski bool mbMTPressed; /// Mouse tracking: Button currently drawed pressed? 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski Rectangle maFocusRect; /// Focus rectangle on screen. 65*b1cdbd2cSJim Jagielski size_t mnFocusLevel; /// Level of focused button. 66*b1cdbd2cSJim Jagielski size_t mnFocusEntry; /// Entry index of focused button. 67*b1cdbd2cSJim Jagielski bool mbDontDrawFocus; /// Do not redraw focus in next Paint(). 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski public: 70*b1cdbd2cSJim Jagielski ScOutlineWindow( 71*b1cdbd2cSJim Jagielski Window* pParent, 72*b1cdbd2cSJim Jagielski ScOutlineMode eMode, 73*b1cdbd2cSJim Jagielski ScViewData* pViewData, 74*b1cdbd2cSJim Jagielski ScSplitPos eWhich ); 75*b1cdbd2cSJim Jagielski virtual ~ScOutlineWindow(); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski /** Sets the size of the header area (width/height dep. on window type). */ 78*b1cdbd2cSJim Jagielski void SetHeaderSize( long nNewSize ); 79*b1cdbd2cSJim Jagielski /** Returns the width/height the window needs to show all levels. */ 80*b1cdbd2cSJim Jagielski long GetDepthSize() const; 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski /** Scrolls the window content by the specified amount of pixels. */ 83*b1cdbd2cSJim Jagielski void ScrollPixel( long nDiff ); 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski using Window::ShowFocus; 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski private: 88*b1cdbd2cSJim Jagielski /** Initializes color and image settings. */ 89*b1cdbd2cSJim Jagielski void InitSettings(); 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski /** Returns the calc document. */ GetDoc() const92*b1cdbd2cSJim Jagielski inline ScDocument& GetDoc() const { return *mrViewData.GetDocument(); } 93*b1cdbd2cSJim Jagielski /** Returns the current sheet index. */ GetTab() const94*b1cdbd2cSJim Jagielski inline SCTAB GetTab() const { return mrViewData.GetTabNo(); } 95*b1cdbd2cSJim Jagielski /** Returns the outline array of the corresponding document. */ 96*b1cdbd2cSJim Jagielski const ScOutlineArray* GetOutlineArray() const; 97*b1cdbd2cSJim Jagielski /** Returns the specified outline entry. */ 98*b1cdbd2cSJim Jagielski const ScOutlineEntry* GetOutlineEntry( size_t nLevel, size_t nEntry ) const; 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski /** Returns true, if the column/row is hidden. */ 101*b1cdbd2cSJim Jagielski bool IsHidden( SCCOLROW nColRowIndex ) const; 102*b1cdbd2cSJim Jagielski /** Returns true, if the column/row is filtered. */ 103*b1cdbd2cSJim Jagielski bool IsFiltered( SCCOLROW nColRowIndex ) const; 104*b1cdbd2cSJim Jagielski /** Returns true, if all columns/rows before nColRowIndex are hidden. */ 105*b1cdbd2cSJim Jagielski bool IsFirstVisible( SCCOLROW nColRowIndex ) const; 106*b1cdbd2cSJim Jagielski /** Returns the currently visible column/row range. */ 107*b1cdbd2cSJim Jagielski void GetVisibleRange( SCCOLROW& rnColRowStart, SCCOLROW& rnColRowEnd ) const; 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski /** Returns the point in the window of the specified position. */ 110*b1cdbd2cSJim Jagielski Point GetPoint( long nLevelPos, long nEntryPos ) const; 111*b1cdbd2cSJim Jagielski /** Returns the rectangle in the window of the specified position. */ 112*b1cdbd2cSJim Jagielski Rectangle GetRectangle( 113*b1cdbd2cSJim Jagielski long nLevelStart, long nEntryStart, 114*b1cdbd2cSJim Jagielski long nLevelEnd, long nEntryEnd ) const; 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski /** Returns the window size for the level coordinate. */ 117*b1cdbd2cSJim Jagielski long GetOutputSizeLevel() const; 118*b1cdbd2cSJim Jagielski /** Returns the window size for the entry coordinate. */ 119*b1cdbd2cSJim Jagielski long GetOutputSizeEntry() const; 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski /** Returns the count of levels of the outline array. 0 means no outlines. */ 122*b1cdbd2cSJim Jagielski size_t GetLevelCount() const; 123*b1cdbd2cSJim Jagielski /** Returns the pixel position of the specified level. */ 124*b1cdbd2cSJim Jagielski long GetLevelPos( size_t nLevel ) const; 125*b1cdbd2cSJim Jagielski /** Returns the level of the passed pixel position. */ 126*b1cdbd2cSJim Jagielski size_t GetLevelFromPos( long nLevelPos ) const; 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski /** Returns the start coordinate of the specified column/row in the window. */ 129*b1cdbd2cSJim Jagielski long GetColRowPos( SCCOLROW nColRowIndex ) const; 130*b1cdbd2cSJim Jagielski /** Returns the entry position of header images. */ 131*b1cdbd2cSJim Jagielski long GetHeaderEntryPos() const; 132*b1cdbd2cSJim Jagielski /** Calculates the coordinates the outline entry takes in the window. 133*b1cdbd2cSJim Jagielski @return false = no part of the group is visible (outside window or collapsed by parent group). */ 134*b1cdbd2cSJim Jagielski bool GetEntryPos( 135*b1cdbd2cSJim Jagielski size_t nLevel, size_t nEntry, 136*b1cdbd2cSJim Jagielski long& rnStartPos, long& rnEndPos, long& rnImagePos ) const; 137*b1cdbd2cSJim Jagielski /** Calculates the absolute position of the image of the specified outline entry. 138*b1cdbd2cSJim Jagielski @param nLevel The level of the entry. 139*b1cdbd2cSJim Jagielski @param nEntry The entry index or SC_OL_HEADERENTRY for the header image. 140*b1cdbd2cSJim Jagielski @return false = image is not visible. */ 141*b1cdbd2cSJim Jagielski bool GetImagePos( size_t nLevel, size_t nEntry, Point& rPos ) const; 142*b1cdbd2cSJim Jagielski /** Returns true, if the button of the specified entry is visible in the window. */ 143*b1cdbd2cSJim Jagielski bool IsButtonVisible( size_t nLevel, size_t nEntry ) const; 144*b1cdbd2cSJim Jagielski 145*b1cdbd2cSJim Jagielski /** Returns true, if rPos is inside of a button or over the line of an expanded 146*b1cdbd2cSJim Jagielski group. The outline entry data is stored in the passed variables. */ 147*b1cdbd2cSJim Jagielski bool ItemHit( const Point& rPos, size_t& rnLevel, size_t& rnEntry, bool& rbButton ) const; 148*b1cdbd2cSJim Jagielski /** Returns true, if rPos is inside of a button. 149*b1cdbd2cSJim Jagielski The button data is stored in the passed variables. */ 150*b1cdbd2cSJim Jagielski bool ButtonHit( const Point& rPos, size_t& rnLevel, size_t& rnEntry ) const; 151*b1cdbd2cSJim Jagielski /** Returns true, if rPos is over the line of an expanded group. 152*b1cdbd2cSJim Jagielski The outline entry data is stored in the passed variables. */ 153*b1cdbd2cSJim Jagielski bool LineHit( const Point& rPos, size_t& rnLevel, size_t& rnEntry ) const; 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski /** Performs an action with the specified item. 156*b1cdbd2cSJim Jagielski @param nLevel The level of the entry. 157*b1cdbd2cSJim Jagielski @param nEntry The entry index or SC_OL_HEADERENTRY for the header entry. */ 158*b1cdbd2cSJim Jagielski void DoFunction( size_t nLevel, size_t nEntry ) const; 159*b1cdbd2cSJim Jagielski /** Expands the specified entry (does nothing with header entries). */ 160*b1cdbd2cSJim Jagielski void DoExpand( size_t nLevel, size_t nEntry ) const; 161*b1cdbd2cSJim Jagielski /** Collapses the specified entry (does nothing with header entries). */ 162*b1cdbd2cSJim Jagielski void DoCollapse( size_t nLevel, size_t nEntry ) const; 163*b1cdbd2cSJim Jagielski 164*b1cdbd2cSJim Jagielski /** Returns true, if the focused button is visible in the window. */ 165*b1cdbd2cSJim Jagielski bool IsFocusButtonVisible() const; 166*b1cdbd2cSJim Jagielski 167*b1cdbd2cSJim Jagielski /** Calculates index of next/previous focus button in the current level (no paint). 168*b1cdbd2cSJim Jagielski @param bFindVisible true = repeats until a visible button has been found. 169*b1cdbd2cSJim Jagielski @return true = focus wrapped from end to start or vice versa. */ 170*b1cdbd2cSJim Jagielski bool ImplMoveFocusByEntry( bool bForward, bool bFindVisible ); 171*b1cdbd2cSJim Jagielski /** Calculates position of focus button in next/previous level (no paint). 172*b1cdbd2cSJim Jagielski @return true = focus wrapped from end to start or vice versa. */ 173*b1cdbd2cSJim Jagielski bool ImplMoveFocusByLevel( bool bForward ); 174*b1cdbd2cSJim Jagielski /** Calculates position of focus button in tab order. 175*b1cdbd2cSJim Jagielski @param bFindVisible true = repeats until a visible button has been found. 176*b1cdbd2cSJim Jagielski @return true = focus wrapped from end to start or vice versa. */ 177*b1cdbd2cSJim Jagielski bool ImplMoveFocusByTabOrder( bool bForward, bool bFindVisible ); 178*b1cdbd2cSJim Jagielski 179*b1cdbd2cSJim Jagielski /** If the focused entry is invisible, tries to move to visible position. */ 180*b1cdbd2cSJim Jagielski void ImplMoveFocusToVisible( bool bForward ); 181*b1cdbd2cSJim Jagielski 182*b1cdbd2cSJim Jagielski /** Focuses next/previous button in the current level. */ 183*b1cdbd2cSJim Jagielski void MoveFocusByEntry( bool bForward ); 184*b1cdbd2cSJim Jagielski /** Focuses button in next/previous level. */ 185*b1cdbd2cSJim Jagielski void MoveFocusByLevel( bool bForward ); 186*b1cdbd2cSJim Jagielski /** Focuses next/previous button in tab order. */ 187*b1cdbd2cSJim Jagielski void MoveFocusByTabOrder( bool bForward ); 188*b1cdbd2cSJim Jagielski 189*b1cdbd2cSJim Jagielski /** Starts mouse tracking after click on a button. */ 190*b1cdbd2cSJim Jagielski void StartMouseTracking( size_t nLevel, size_t nEntry ); 191*b1cdbd2cSJim Jagielski /** Returns whether mouse tracking mode is active. */ IsMouseTracking() const192*b1cdbd2cSJim Jagielski inline bool IsMouseTracking() const { return mbMTActive; } 193*b1cdbd2cSJim Jagielski /** Ends mouse tracking. */ 194*b1cdbd2cSJim Jagielski void EndMouseTracking(); 195*b1cdbd2cSJim Jagielski 196*b1cdbd2cSJim Jagielski /** Sets a clip region for the window area without header. */ 197*b1cdbd2cSJim Jagielski void SetEntryAreaClipRegion(); 198*b1cdbd2cSJim Jagielski /** Converts coordinates to real window points and draws the line. */ 199*b1cdbd2cSJim Jagielski void DrawLineRel( 200*b1cdbd2cSJim Jagielski long nLevelStart, long nEntryStart, 201*b1cdbd2cSJim Jagielski long nLevelEnd, long nEntryEnd ); 202*b1cdbd2cSJim Jagielski /** Converts coordinates to real window points and draws the rectangle. */ 203*b1cdbd2cSJim Jagielski void DrawRectRel( 204*b1cdbd2cSJim Jagielski long nLevelStart, long nEntryStart, 205*b1cdbd2cSJim Jagielski long nLevelEnd, long nEntryEnd ); 206*b1cdbd2cSJim Jagielski /** Draws the specified image unpressed. */ 207*b1cdbd2cSJim Jagielski void DrawImageRel( long nLevelPos, long nEntryPos, sal_uInt16 nId ); 208*b1cdbd2cSJim Jagielski /** Draws a pressed or unpressed border. */ 209*b1cdbd2cSJim Jagielski void DrawBorderRel( size_t nLevel, size_t nEntry, bool bPressed ); 210*b1cdbd2cSJim Jagielski 211*b1cdbd2cSJim Jagielski /** Draws the focus rectangle into the focused button. */ 212*b1cdbd2cSJim Jagielski void ShowFocus(); 213*b1cdbd2cSJim Jagielski /** Erases the focus rectangle from the focused button. */ 214*b1cdbd2cSJim Jagielski void HideFocus(); 215*b1cdbd2cSJim Jagielski 216*b1cdbd2cSJim Jagielski /** Scrolls the specified range of the window in entry-relative direction. */ 217*b1cdbd2cSJim Jagielski void ScrollRel( long nEntryDiff, long nEntryStart, long nEntryEnd ); 218*b1cdbd2cSJim Jagielski 219*b1cdbd2cSJim Jagielski protected: 220*b1cdbd2cSJim Jagielski virtual void Paint( const Rectangle& rRect ); 221*b1cdbd2cSJim Jagielski 222*b1cdbd2cSJim Jagielski virtual void Resize(); 223*b1cdbd2cSJim Jagielski virtual void GetFocus(); 224*b1cdbd2cSJim Jagielski virtual void LoseFocus(); 225*b1cdbd2cSJim Jagielski 226*b1cdbd2cSJim Jagielski virtual void MouseMove( const MouseEvent& rMEvt ); 227*b1cdbd2cSJim Jagielski virtual void MouseButtonUp( const MouseEvent& rMEvt ); 228*b1cdbd2cSJim Jagielski virtual void MouseButtonDown( const MouseEvent& rMEvt ); 229*b1cdbd2cSJim Jagielski 230*b1cdbd2cSJim Jagielski virtual void KeyInput( const KeyEvent& rKEvt ); 231*b1cdbd2cSJim Jagielski 232*b1cdbd2cSJim Jagielski public: 233*b1cdbd2cSJim Jagielski virtual void DataChanged( const DataChangedEvent& rDCEvt ); 234*b1cdbd2cSJim Jagielski }; 235*b1cdbd2cSJim Jagielski 236*b1cdbd2cSJim Jagielski 237*b1cdbd2cSJim Jagielski // ============================================================================ 238*b1cdbd2cSJim Jagielski 239*b1cdbd2cSJim Jagielski #endif 240*b1cdbd2cSJim Jagielski 241