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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: ctrl.hxx,v $
* $Revision: 1.4 $
*
* 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_CTRL_HXX
#define _SV_CTRL_HXX
#include <tools/link.hxx>
#include <vcl/sv.h>
#include <vcl/dllapi.h>
#include <vcl/window.hxx>
#include <vcl/salnativewidgets.hxx>
// forward
namespace vcl { struct ControlLayoutData; }
// -----------
// - Control -
// -----------
class VCL_DLLPUBLIC Control : public Window
{
protected:
mutable vcl::ControlLayoutData* mpLayoutData;
private:
BOOL mbHasFocus;
Link maGetFocusHdl;
Link maLoseFocusHdl;
SAL_DLLPRIVATE void ImplInitControlData();
// Copy assignment is forbidden and not implemented.
SAL_DLLPRIVATE Control (const Control &);
SAL_DLLPRIVATE Control & operator= (const Control &);
protected:
Control( WindowType nType );
virtual void FillLayoutData() const;
// helper method for composite controls
void AppendLayoutData( const Control& rSubControl ) const;
/** this calls both our event listeners, and a specified handler
If the Control instance is destroyed during any of those calls, the
method properly handles this (in particular, it doesn't crash :)
@param nEvent
the event to notify to our event listeners
@param rHandler
the handler to call
@param pCaller
the parameter to pass to the handler call
@return
if the Control instance has been destroyed in any of the call
*/
BOOL ImplCallEventListenersAndHandler(
ULONG nEvent, const Link& rHandler, void* pCaller
);
//#if 0 // _SOLAR__PRIVATE
public:
SAL_DLLPRIVATE void ImplClearLayoutData() const;
/** draws a frame around the give rectangle, onto the given device
only to be used from within the <member>Window::Draw</member> method of your sub class.
The frame is always drawn with a single line (without 3D effects). In addition, any mono
color set at the control's settings is respected. Yet more additionally, if we're living
in a themed desktop, this theming is ignored.
Note that this makes sense, since the *only known* clients of <member>Window::Draw</member>
are form controls, when printed or print-previewed. For form controls embedded in office documents,
you don't want to have the theme look.
@param pDev
the device to draw onto
@param rRect
the rect for drawing the frame. Upon returning from the call, the rect will be inflated
by the space occupied by the drawn pixels.
*/
SAL_DLLPRIVATE void ImplDrawFrame( OutputDevice* pDev, Rectangle& rRect );
//#endif
public:
Control( Window* pParent, WinBits nWinStyle = 0 );
Control( Window* pParent, const ResId& rResId );
~Control();
virtual void GetFocus();
virtual void LoseFocus();
virtual long Notify( NotifyEvent& rNEvt );
virtual void StateChanged( StateChangedType nStateChange );
virtual void Resize();
virtual void DataChanged( const DataChangedEvent& rDCEvt );
// invalidates layout data
virtual void SetText( const String& rStr );
// gets the displayed text
virtual String GetDisplayText() const;
// returns the bounding box for the character at index nIndex (in control coordinates)
Rectangle GetCharacterBounds( long nIndex ) const;
// returns the character index for corresponding to rPoint (in control coordinates)
// -1 is returned if no character is at that point
long GetIndexForPoint( const Point& rPoint ) const;
// returns the number of lines in the result of GetDisplayText()
long GetLineCount() const;
// returns the interval [start,end] of line nLine
// returns [-1,-1] for an invalid line
Pair GetLineStartEnd( long nLine ) const;
/** ToRelativeLineIndex changes a layout data index to a count relative to its line.
<p>This is equivalent to getting the line start/end pairs with
<member>GetLineStartEnd</member> until the index lies within [start,end] of a line
</p>
@param nIndex
the absolute index inside the display text to be changed to a relative index
@returns
the relative index inside the displayed line or -1 if the absolute index does
not match any line
*/
long ToRelativeLineIndex( long nIndex ) const;
void SetGetFocusHdl( const Link& rLink ) { maGetFocusHdl = rLink; }
const Link& GetGetFocusHdl() const { return maGetFocusHdl; }
void SetLoseFocusHdl( const Link& rLink ) { maLoseFocusHdl = rLink; }
const Link& GetLoseFocusHdl() const { return maLoseFocusHdl; }
void SetLayoutDataParent( const Control* pParent ) const;
virtual Size GetOptimalSize(WindowSizeType eType) const;
};
#endif // _SV_CTRL_HXX
|
