1 /*************************************************************************
2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3  *
4  * Copyright 2000, 2010 Oracle and/or its affiliates.
5  *
6  * OpenOffice.org - a multi-platform office productivity suite
7  *
8  * This file is part of OpenOffice.org.
9  *
10  * OpenOffice.org is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU Lesser General Public License version 3
12  * only, as published by the Free Software Foundation.
13  *
14  * OpenOffice.org is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Lesser General Public License version 3 for more details
18  * (a copy is included in the LICENSE file that accompanied this code).
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with OpenOffice.org.  If not, see
22  * <http://www.openoffice.org/license.html>
23  * for a copy of the LGPLv3 License.
24  *
25 ************************************************************************/
26 
27 #ifndef TABITEMDESCRIPTOR_HXX
28 #define TABITEMDESCRIPTOR_HXX
29 
30 #include "svtools/toolpanel/toolpanel.hxx"
31 #include "svtools/toolpanel/tabitemcontent.hxx"
32 
33 #include <tools/gen.hxx>
34 #include <osl/diagnose.h>
35 
36 #include <vector>
37 
38 //........................................................................
39 namespace svt
40 {
41 //........................................................................
42 
43     //==================================================================================================================
44 	//= ItemDescriptor
45 	//==================================================================================================================
46     struct ItemDescriptor
47     {
48         PToolPanel      pPanel;
49         Rectangle       aCompleteArea;  // bounding area if the both text and icon are to be rendererd
50         Rectangle       aIconOnlyArea;  // bounding area if the icon is to be rendererd
51         Rectangle       aTextOnlyArea;  // bounding area if the text is to be rendererd
52         TabItemContent  eContent;
53             // content to be used for this particular item. Might differ from item content which has been set
54             // up for the complete control, in case not the complete content fits into the available space.
55 
56         ItemDescriptor()
57             :pPanel()
58             ,aCompleteArea()
59             ,aIconOnlyArea()
60             ,aTextOnlyArea()
61             ,eContent( TABITEM_IMAGE_AND_TEXT )
62         {
63         }
64 
65         const Rectangle& GetRect( const TabItemContent i_eItemContent ) const
66         {
67             OSL_ENSURE( i_eItemContent != TABITEM_AUTO, "ItemDescriptor::GetRect: illegal value!" );
68 
69             return  ( i_eItemContent == TABITEM_IMAGE_AND_TEXT )
70                 ?   aCompleteArea
71                 :   (   ( i_eItemContent == TABITEM_TEXT_ONLY )
72                     ?   aTextOnlyArea
73                     :   aIconOnlyArea
74                     );
75         }
76 
77         const Rectangle& GetCurrentRect() const
78         {
79             return GetRect( eContent );
80         }
81     };
82 
83     typedef ::std::vector< ItemDescriptor > ItemDescriptors;
84 
85 
86 //........................................................................
87 } // namespace svt
88 //........................................................................
89 
90 #endif // TABITEMDESCRIPTOR_HXX
91