summaryrefslogtreecommitdiff
path: root/vcl/inc/vcl/status.hxx
blob: 6574b6ac3c1e2efec9ef4ba497cd9db95e8e7a9b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef _SV_STATUS_HXX
#define _SV_STATUS_HXX

#include <vcl/sv.h>
#include <vcl/dllapi.h>
#include <vcl/window.hxx>

class ImplStatusItemList;

// --------------------
// - Progress-Ausgabe -
// --------------------

void VCL_DLLPUBLIC DrawProgress( Window* pWindow, const Point& rPos,
                                 long nOffset, long nPrgsWidth, long nPrgsHeight,
                                 USHORT nPercent1, USHORT nPercent2, USHORT nPercentCount,
                                 const Rectangle& rFramePosSize
                                 );

// ---------------------
// - StatusBarItemBits -
// ---------------------

typedef USHORT StatusBarItemBits;

// ----------------------------
// - Bits fuer StatusBarItems -
// ----------------------------

#define SIB_LEFT					((StatusBarItemBits)0x0001)
#define SIB_CENTER					((StatusBarItemBits)0x0002)
#define SIB_RIGHT					((StatusBarItemBits)0x0004)
#define SIB_IN						((StatusBarItemBits)0x0008)
#define SIB_OUT 					((StatusBarItemBits)0x0010)
#define SIB_FLAT					((StatusBarItemBits)0x0020)
#define SIB_AUTOSIZE				((StatusBarItemBits)0x0040)
#define SIB_USERDRAW				((StatusBarItemBits)0x0080)

// -------------------
// - StatusBar-Types -
// -------------------

#define STATUSBAR_APPEND			((USHORT)0xFFFF)
#define STATUSBAR_ITEM_NOTFOUND 	((USHORT)0xFFFF)
#define STATUSBAR_OFFSET			((long)5)

// -------------
// - StatusBar -
// -------------

class VCL_DLLPUBLIC StatusBar : public Window
{
    class   ImplData;
private:
    ImplStatusItemList* mpItemList;
    ImplData*           mpImplData;
    XubString			maPrgsTxt;
    Point				maPrgsTxtPos;
    Rectangle			maPrgsFrameRect;
    long				mnPrgsSize;
    long				mnItemsWidth;
    long				mnDX;
    long				mnDY;
    long				mnCalcHeight;
    long				mnTextY;
    long				mnItemY;
    USHORT				mnCurItemId;
    USHORT				mnPercent;
    USHORT				mnPercentCount;
    BOOL				mbVisibleItems;
    BOOL				mbFormat;
    BOOL				mbProgressMode;
    BOOL				mbInUserDraw;
    BOOL				mbBottomBorder;
    Link				maClickHdl;
    Link				maDoubleClickHdl;

    using Window::ImplInit;
    SAL_DLLPRIVATE void		 ImplInit( Window* pParent, WinBits nStyle );
    SAL_DLLPRIVATE void		 ImplInitSettings( BOOL bFont, BOOL bForeground, BOOL bBackground );
    SAL_DLLPRIVATE void		 ImplFormat();
    SAL_DLLPRIVATE BOOL		 ImplIsItemUpdate();
    using OutputDevice::ImplDrawText;
    SAL_DLLPRIVATE void		 ImplDrawText( BOOL bOffScreen, long nOldTextWidth );
    SAL_DLLPRIVATE void		 ImplDrawItem( BOOL bOffScreen, USHORT nPos, BOOL bDrawText, BOOL bDrawFrame );
    SAL_DLLPRIVATE void		 ImplDrawProgress( BOOL bPaint,
                                               USHORT nOldPerc, USHORT nNewPerc );
    SAL_DLLPRIVATE void		 ImplCalcProgressRect();
    SAL_DLLPRIVATE Rectangle ImplGetItemRectPos( USHORT nPos ) const;
    SAL_DLLPRIVATE USHORT    ImplGetFirstVisiblePos() const;
    SAL_DLLPRIVATE void      ImplCalcBorder();

public:
                        StatusBar( Window* pParent,
                                   WinBits nWinStyle = WB_BORDER | WB_RIGHT );
                        StatusBar( Window* pParent, const ResId& rResId );
                        ~StatusBar();

    virtual void		MouseButtonDown( const MouseEvent& rMEvt );
    virtual void		Paint( const Rectangle& rRect );
    virtual void		Move();
    virtual void		Resize();
    virtual void		RequestHelp( const HelpEvent& rHEvt );
    virtual void		StateChanged( StateChangedType nType );
    virtual void		DataChanged( const DataChangedEvent& rDCEvt );

    virtual void		Click();
    virtual void		DoubleClick();
    virtual void		UserDraw( const UserDrawEvent& rUDEvt );

    void				InsertItem( USHORT nItemId, ULONG nWidth,
                                    StatusBarItemBits nBits = SIB_CENTER | SIB_IN,
                                    long nOffset = STATUSBAR_OFFSET,
                                    USHORT nPos = STATUSBAR_APPEND );
    void				RemoveItem( USHORT nItemId );

    void				ShowItem( USHORT nItemId );
    void				HideItem( USHORT nItemId );
    BOOL				IsItemVisible( USHORT nItemId ) const;

    void				ShowItems();
    void				HideItems();
    BOOL				AreItemsVisible() const { return mbVisibleItems; }

    void				CopyItems( const StatusBar& rStatusBar );
    void				Clear();

    USHORT				GetItemCount() const;
    USHORT				GetItemId( USHORT nPos ) const;
    USHORT				GetItemId( const Point& rPos ) const;
    USHORT				GetItemPos( USHORT nItemId ) const;
    Rectangle			GetItemRect( USHORT nItemId ) const;
    Point				GetItemTextPos( USHORT nItemId ) const;
    USHORT				GetCurItemId() const { return mnCurItemId; }

    ULONG				GetItemWidth( USHORT nItemId ) const;
    StatusBarItemBits	GetItemBits( USHORT nItemId ) const;
    long				GetItemOffset( USHORT nItemId ) const;

    void				SetItemText( USHORT nItemId, const XubString& rText );
    const XubString& 	GetItemText( USHORT nItemId ) const;

    void				SetItemData( USHORT nItemId, void* pNewData );
    void*				GetItemData( USHORT nItemId ) const;

    void                SetItemCommand( USHORT nItemId, const XubString& rCommand );
    const XubString&    GetItemCommand( USHORT nItemId );

    void				SetHelpText( USHORT nItemId, const XubString& rText );
    const XubString& 	GetHelpText( USHORT nItemId ) const;

    using Window::SetQuickHelpText;
    void                SetQuickHelpText( USHORT nItemId, const XubString& rText );
    using Window::GetQuickHelpText;
    const XubString&    GetQuickHelpText( USHORT nItemId ) const;

    void				SetHelpId( USHORT nItemId, ULONG nHelpId );
    ULONG				GetHelpId( USHORT nItemId ) const;

    void				SetBottomBorder( BOOL bBottomBorder = TRUE );
    BOOL				IsBottomBorder() const { return mbBottomBorder; }

    void				SetTopBorder( BOOL bTopBorder = TRUE );
    BOOL				IsTopBorder() const;

    void				StartProgressMode( const XubString& rText );
    void				SetProgressValue( USHORT nPercent );
    void				EndProgressMode();
    BOOL				IsProgressMode() const { return mbProgressMode; }
    void				ResetProgressMode();

    void				SetText( const XubString& rText );

    void				SetHelpText( const XubString& rText )
                            { Window::SetHelpText( rText ); }
    const XubString& 	GetHelpText() const
                            { return Window::GetHelpText(); }

    void				SetHelpId( ULONG nId )
                            { Window::SetHelpId( nId ); }
    ULONG				GetHelpId() const
                            { return Window::GetHelpId(); }

    Size				CalcWindowSizePixel() const;

    void				SetClickHdl( const Link& rLink ) { maClickHdl = rLink; }
    const Link& 		GetClickHdl() const { return maClickHdl; }
    void				SetDoubleClickHdl( const Link& rLink ) { maDoubleClickHdl = rLink; }
    const Link& 		GetDoubleClickHdl() const { return maDoubleClickHdl; }

    using Window::SetAccessibleName;
    void				SetAccessibleName( USHORT nItemId, const XubString& rName );
    using Window::GetAccessibleName;
    const XubString& 	GetAccessibleName( USHORT nItemId ) const;
};

#endif	// _SV_STATUS_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */