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 SD_TOOLPANEL_SCROLL_PANEL_HXX 25*b1cdbd2cSJim Jagielski #define SD_TOOLPANEL_SCROLL_PANEL_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "taskpane/TaskPaneTreeNode.hxx" 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski #include <vcl/ctrl.hxx> 30*b1cdbd2cSJim Jagielski #include <vcl/scrbar.hxx> 31*b1cdbd2cSJim Jagielski #include <memory> 32*b1cdbd2cSJim Jagielski #include <vector> 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski namespace sd { namespace toolpanel { 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski class TitledControl; 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski /** The scroll panel shows its controls one above the other. When their 39*b1cdbd2cSJim Jagielski total height is larger than the height of the scroll area then only a 40*b1cdbd2cSJim Jagielski part of the controls is visible. Scroll bars control which part that 41*b1cdbd2cSJim Jagielski is. 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski The scroll panel registers itself as window event listener at the 44*b1cdbd2cSJim Jagielski controls and their title bars (conceptually; it really is the 45*b1cdbd2cSJim Jagielski TitledControl) to track changes of the selection and focus rectangles. 46*b1cdbd2cSJim Jagielski On such a change it tries to move the selected or focused part into the 47*b1cdbd2cSJim Jagielski visible area. At the moment this moving into view only works with 48*b1cdbd2cSJim Jagielski valuesets and TitleBars. 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielski class ScrollPanel 51*b1cdbd2cSJim Jagielski : public ::Control, 52*b1cdbd2cSJim Jagielski public TreeNode 53*b1cdbd2cSJim Jagielski { 54*b1cdbd2cSJim Jagielski public: 55*b1cdbd2cSJim Jagielski /** Create a new scroll panel which itself is the root of a TreeNode hierarchy 56*b1cdbd2cSJim Jagielski parent. This will usually be a child window. 57*b1cdbd2cSJim Jagielski */ 58*b1cdbd2cSJim Jagielski ScrollPanel (::Window& i_rParentWindow); 59*b1cdbd2cSJim Jagielski virtual ~ScrollPanel (void); 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski /** Add a control to the sub panel. An title bar is added above the 62*b1cdbd2cSJim Jagielski control. 63*b1cdbd2cSJim Jagielski @param rTitle 64*b1cdbd2cSJim Jagielski The title that will be shown in the two title bars that 65*b1cdbd2cSJim Jagielski belong to the control. 66*b1cdbd2cSJim Jagielski @param nHelpId 67*b1cdbd2cSJim Jagielski The help id is set at the title bar not the actual control. 68*b1cdbd2cSJim Jagielski @return 69*b1cdbd2cSJim Jagielski The new titled control that contains the given control and a new 70*b1cdbd2cSJim Jagielski title bar as children is returned. 71*b1cdbd2cSJim Jagielski */ 72*b1cdbd2cSJim Jagielski TitledControl* AddControl ( 73*b1cdbd2cSJim Jagielski ::std::auto_ptr<TreeNode> pControl, 74*b1cdbd2cSJim Jagielski const String& rTitle, 75*b1cdbd2cSJim Jagielski const rtl::OString& sHelpId); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski /** Add a control to the sub panel without a title bar. 78*b1cdbd2cSJim Jagielski */ 79*b1cdbd2cSJim Jagielski void AddControl (::std::auto_ptr<TreeNode> pControl); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski virtual void Paint (const Rectangle& rRect); 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski /** Initiate a rearrangement of the controls and title bars. 84*b1cdbd2cSJim Jagielski */ 85*b1cdbd2cSJim Jagielski virtual void Resize (void); 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski virtual void RequestResize (void); 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski virtual Size GetPreferredSize (void); 90*b1cdbd2cSJim Jagielski virtual sal_Int32 GetPreferredWidth (sal_Int32 nHeight); 91*b1cdbd2cSJim Jagielski virtual sal_Int32 GetPreferredHeight (sal_Int32 nWidth); 92*b1cdbd2cSJim Jagielski virtual bool IsResizable (void); 93*b1cdbd2cSJim Jagielski virtual ::Window* GetWindow (void); 94*b1cdbd2cSJim Jagielski virtual sal_Int32 GetMinimumWidth (void); 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski virtual void ExpandControl ( 97*b1cdbd2cSJim Jagielski TreeNode* pControl, 98*b1cdbd2cSJim Jagielski bool bExpansionState); 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski bool IsVerticalScrollBarVisible (void) const; 101*b1cdbd2cSJim Jagielski bool IsHorizontalScrollBarVisible (void) const; 102*b1cdbd2cSJim Jagielski ScrollBar& GetVerticalScrollBar (void); 103*b1cdbd2cSJim Jagielski ScrollBar& GetHorizontalScrollBar (void); 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski // ::Window 106*b1cdbd2cSJim Jagielski virtual long Notify( NotifyEvent& rNEvt ); 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski virtual ::com::sun::star::uno::Reference< 109*b1cdbd2cSJim Jagielski ::com::sun::star::accessibility::XAccessible> CreateAccessibleObject ( 110*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference< 111*b1cdbd2cSJim Jagielski ::com::sun::star::accessibility::XAccessible>& rxParent); 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski /** Scroll the given rectangle into the visible area. 114*b1cdbd2cSJim Jagielski @param aRectangle 115*b1cdbd2cSJim Jagielski The box to move into the visible area in pixel coordinates 116*b1cdbd2cSJim Jagielski relative to the given window. 117*b1cdbd2cSJim Jagielski @param pWindow 118*b1cdbd2cSJim Jagielski This window is used to translate the given coordinates into ones 119*b1cdbd2cSJim Jagielski that are relative to the scroll panel. 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski */ 122*b1cdbd2cSJim Jagielski void MakeRectangleVisible ( 123*b1cdbd2cSJim Jagielski Rectangle& aRectangle, 124*b1cdbd2cSJim Jagielski ::Window* pWindow); 125*b1cdbd2cSJim Jagielski 126*b1cdbd2cSJim Jagielski private: 127*b1cdbd2cSJim Jagielski ::Control maScrollWindow; 128*b1cdbd2cSJim Jagielski ScrollBar maVerticalScrollBar; 129*b1cdbd2cSJim Jagielski ScrollBar maHorizontalScrollBar; 130*b1cdbd2cSJim Jagielski ::Window maScrollBarFiller; 131*b1cdbd2cSJim Jagielski ::Window maScrollWindowFiller; 132*b1cdbd2cSJim Jagielski Point maScrollOffset; 133*b1cdbd2cSJim Jagielski bool mbIsRearrangePending; 134*b1cdbd2cSJim Jagielski bool mbIsLayoutPending; 135*b1cdbd2cSJim Jagielski sal_uInt32 mnChildrenWidth; 136*b1cdbd2cSJim Jagielski /// Border above top-most and below bottom-most control. 137*b1cdbd2cSJim Jagielski const int mnVerticalBorder; 138*b1cdbd2cSJim Jagielski /// Gap between two controls. 139*b1cdbd2cSJim Jagielski const int mnVerticalGap; 140*b1cdbd2cSJim Jagielski /// Border at the left and right of the controls. 141*b1cdbd2cSJim Jagielski const int mnHorizontalBorder; 142*b1cdbd2cSJim Jagielski /** List of horizontal stripes that is created from the gaps between 143*b1cdbd2cSJim Jagielski children when they are layouted. The stripes are painted in Paint() 144*b1cdbd2cSJim Jagielski to fill the space arround the children. 145*b1cdbd2cSJim Jagielski */ 146*b1cdbd2cSJim Jagielski typedef ::std::vector< ::std::pair<int,int> > StripeList; 147*b1cdbd2cSJim Jagielski StripeList maStripeList; 148*b1cdbd2cSJim Jagielski 149*b1cdbd2cSJim Jagielski /** Calculate position, size, and visibility of the controls. 150*b1cdbd2cSJim Jagielski Call this method after the list of controls, their expansion 151*b1cdbd2cSJim Jagielski state, or the size of the sub panel has changed. 152*b1cdbd2cSJim Jagielski */ 153*b1cdbd2cSJim Jagielski void Rearrange (void); 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski /** Determine the minimal size that is necessary to show the controls 156*b1cdbd2cSJim Jagielski one over the other. It may be smaller than the available area. 157*b1cdbd2cSJim Jagielski */ 158*b1cdbd2cSJim Jagielski Size GetRequiredSize (void); 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski /** Place the child windows one above the other and return the size of 161*b1cdbd2cSJim Jagielski the bounding box. 162*b1cdbd2cSJim Jagielski */ 163*b1cdbd2cSJim Jagielski sal_Int32 LayoutChildren (void); 164*b1cdbd2cSJim Jagielski 165*b1cdbd2cSJim Jagielski /** ctor-impl 166*b1cdbd2cSJim Jagielski */ 167*b1cdbd2cSJim Jagielski void Construct(); 168*b1cdbd2cSJim Jagielski 169*b1cdbd2cSJim Jagielski Size SetupScrollBars (const Size& rRequiresSize); 170*b1cdbd2cSJim Jagielski sal_Int32 SetupVerticalScrollBar (bool bShow, sal_Int32 nRange); 171*b1cdbd2cSJim Jagielski sal_Int32 SetupHorizontalScrollBar (bool bShow, sal_Int32 nRange); 172*b1cdbd2cSJim Jagielski 173*b1cdbd2cSJim Jagielski DECL_LINK(ScrollBarHandler, ScrollBar*); 174*b1cdbd2cSJim Jagielski DECL_LINK(WindowEventListener, VclSimpleEvent*); 175*b1cdbd2cSJim Jagielski 176*b1cdbd2cSJim Jagielski using Window::GetWindow; 177*b1cdbd2cSJim Jagielski }; 178*b1cdbd2cSJim Jagielski 179*b1cdbd2cSJim Jagielski } } // end of namespace ::sd::toolpanel 180*b1cdbd2cSJim Jagielski 181*b1cdbd2cSJim Jagielski #endif 182