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 // ============================================================================
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski #ifndef _SC_CSVCONTROL_HXX
27*b1cdbd2cSJim Jagielski #define _SC_CSVCONTROL_HXX
28*b1cdbd2cSJim Jagielski
29*b1cdbd2cSJim Jagielski #include <vcl/ctrl.hxx>
30*b1cdbd2cSJim Jagielski #include "scdllapi.h"
31*b1cdbd2cSJim Jagielski #include "global.hxx"
32*b1cdbd2cSJim Jagielski #include "address.hxx"
33*b1cdbd2cSJim Jagielski #include "csvsplits.hxx"
34*b1cdbd2cSJim Jagielski #include <com/sun/star/uno/Reference.hxx>
35*b1cdbd2cSJim Jagielski
36*b1cdbd2cSJim Jagielski
37*b1cdbd2cSJim Jagielski class ScAccessibleCsvControl;
38*b1cdbd2cSJim Jagielski namespace com { namespace sun { namespace star { namespace accessibility {
39*b1cdbd2cSJim Jagielski class XAccessible;
40*b1cdbd2cSJim Jagielski } } } }
41*b1cdbd2cSJim Jagielski
42*b1cdbd2cSJim Jagielski
43*b1cdbd2cSJim Jagielski // ============================================================================
44*b1cdbd2cSJim Jagielski
45*b1cdbd2cSJim Jagielski /** Minimum character count for a column in separators mode. */
46*b1cdbd2cSJim Jagielski const sal_Int32 CSV_MINCOLWIDTH = 8;
47*b1cdbd2cSJim Jagielski /** Maximum length of a cell string. */
48*b1cdbd2cSJim Jagielski const xub_StrLen CSV_MAXSTRLEN = 0x7FFF;
49*b1cdbd2cSJim Jagielski /** Transparency for header color of selected columns. */
50*b1cdbd2cSJim Jagielski const sal_uInt16 CSV_HDR_TRANSPARENCY = 85;
51*b1cdbd2cSJim Jagielski /** Minimum distance to border for auto scroll. */
52*b1cdbd2cSJim Jagielski const sal_Int32 CSV_SCROLL_DIST = 3;
53*b1cdbd2cSJim Jagielski
54*b1cdbd2cSJim Jagielski //! TODO make string array dynamic
55*b1cdbd2cSJim Jagielski const sal_Int32 CSV_PREVIEW_LINES = 32; // maximum count of preview lines
56*b1cdbd2cSJim Jagielski /** Maximum count of columns. */
57*b1cdbd2cSJim Jagielski const sal_Int32 CSV_MAXCOLCOUNT = MAXCOLCOUNT;
58*b1cdbd2cSJim Jagielski
59*b1cdbd2cSJim Jagielski /** Default column data type. */
60*b1cdbd2cSJim Jagielski const sal_Int32 CSV_TYPE_DEFAULT = 0;
61*b1cdbd2cSJim Jagielski /** Multi selection with different types. */
62*b1cdbd2cSJim Jagielski const sal_Int32 CSV_TYPE_MULTI = -1;
63*b1cdbd2cSJim Jagielski /** No column selected. */
64*b1cdbd2cSJim Jagielski const sal_Int32 CSV_TYPE_NOSELECTION = -2;
65*b1cdbd2cSJim Jagielski
66*b1cdbd2cSJim Jagielski // External used column types.
67*b1cdbd2cSJim Jagielski const sal_uInt8 SC_COL_STANDARD = 1;
68*b1cdbd2cSJim Jagielski const sal_uInt8 SC_COL_TEXT = 2;
69*b1cdbd2cSJim Jagielski const sal_uInt8 SC_COL_MDY = 3;
70*b1cdbd2cSJim Jagielski const sal_uInt8 SC_COL_DMY = 4;
71*b1cdbd2cSJim Jagielski const sal_uInt8 SC_COL_YMD = 5;
72*b1cdbd2cSJim Jagielski const sal_uInt8 SC_COL_SKIP = 9;
73*b1cdbd2cSJim Jagielski const sal_uInt8 SC_COL_ENGLISH = 10;
74*b1cdbd2cSJim Jagielski
75*b1cdbd2cSJim Jagielski
76*b1cdbd2cSJim Jagielski // ============================================================================
77*b1cdbd2cSJim Jagielski
78*b1cdbd2cSJim Jagielski /** Exported data of a column (data used in the dialog). */
79*b1cdbd2cSJim Jagielski struct ScCsvExpData
80*b1cdbd2cSJim Jagielski {
81*b1cdbd2cSJim Jagielski xub_StrLen mnIndex; /// Index of a column.
82*b1cdbd2cSJim Jagielski sal_uInt8 mnType; /// External type of the column.
83*b1cdbd2cSJim Jagielski
ScCsvExpDataScCsvExpData84*b1cdbd2cSJim Jagielski inline ScCsvExpData() : mnIndex( 0 ), mnType( SC_COL_STANDARD ) {}
ScCsvExpDataScCsvExpData85*b1cdbd2cSJim Jagielski inline ScCsvExpData( xub_StrLen nIndex, sal_uInt8 nType ) :
86*b1cdbd2cSJim Jagielski mnIndex( nIndex ), mnType( nType ) {}
87*b1cdbd2cSJim Jagielski };
88*b1cdbd2cSJim Jagielski
89*b1cdbd2cSJim Jagielski typedef ::std::vector< ScCsvExpData > ScCsvExpDataVec;
90*b1cdbd2cSJim Jagielski
91*b1cdbd2cSJim Jagielski
92*b1cdbd2cSJim Jagielski // ============================================================================
93*b1cdbd2cSJim Jagielski
94*b1cdbd2cSJim Jagielski /** Specifies which element should be used to perform an action. */
95*b1cdbd2cSJim Jagielski enum ScMoveMode
96*b1cdbd2cSJim Jagielski {
97*b1cdbd2cSJim Jagielski MOVE_NONE, /// No action.
98*b1cdbd2cSJim Jagielski MOVE_FIRST, /// First element in current context.
99*b1cdbd2cSJim Jagielski MOVE_LAST, /// Last element in current context.
100*b1cdbd2cSJim Jagielski MOVE_PREV, /// Predecessor of current element in current context.
101*b1cdbd2cSJim Jagielski MOVE_NEXT, /// Successor of current element in current context.
102*b1cdbd2cSJim Jagielski MOVE_PREVPAGE, /// Previous page relative to current context.
103*b1cdbd2cSJim Jagielski MOVE_NEXTPAGE /// Next page relative to current context.
104*b1cdbd2cSJim Jagielski };
105*b1cdbd2cSJim Jagielski
106*b1cdbd2cSJim Jagielski
107*b1cdbd2cSJim Jagielski // ============================================================================
108*b1cdbd2cSJim Jagielski
109*b1cdbd2cSJim Jagielski /** Flags for comparison of old and new control layout data. */
110*b1cdbd2cSJim Jagielski typedef sal_uInt32 ScCsvDiff;
111*b1cdbd2cSJim Jagielski
112*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_EQUAL = 0x00000000;
113*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_POSCOUNT = 0x00000001;
114*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_POSOFFSET = 0x00000002;
115*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_HDRWIDTH = 0x00000004;
116*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_CHARWIDTH = 0x00000008;
117*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_LINECOUNT = 0x00000010;
118*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_LINEOFFSET = 0x00000020;
119*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_HDRHEIGHT = 0x00000040;
120*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_LINEHEIGHT = 0x00000080;
121*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_RULERCURSOR = 0x00000100;
122*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_GRIDCURSOR = 0x00000200;
123*b1cdbd2cSJim Jagielski
124*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_HORIZONTAL = CSV_DIFF_POSCOUNT | CSV_DIFF_POSOFFSET | CSV_DIFF_HDRWIDTH | CSV_DIFF_CHARWIDTH;
125*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_VERTICAL = CSV_DIFF_LINECOUNT | CSV_DIFF_LINEOFFSET | CSV_DIFF_HDRHEIGHT | CSV_DIFF_LINEHEIGHT;
126*b1cdbd2cSJim Jagielski const ScCsvDiff CSV_DIFF_CURSOR = CSV_DIFF_RULERCURSOR | CSV_DIFF_GRIDCURSOR;
127*b1cdbd2cSJim Jagielski
128*b1cdbd2cSJim Jagielski
129*b1cdbd2cSJim Jagielski // ----------------------------------------------------------------------------
130*b1cdbd2cSJim Jagielski
131*b1cdbd2cSJim Jagielski /** A structure containing all layout data valid for both ruler and data grid
132*b1cdbd2cSJim Jagielski (i.e. scroll position or column width). */
133*b1cdbd2cSJim Jagielski struct ScCsvLayoutData
134*b1cdbd2cSJim Jagielski {
135*b1cdbd2cSJim Jagielski // horizontal settings
136*b1cdbd2cSJim Jagielski sal_Int32 mnPosCount; /// Number of positions.
137*b1cdbd2cSJim Jagielski sal_Int32 mnPosOffset; /// Horizontal scroll offset.
138*b1cdbd2cSJim Jagielski
139*b1cdbd2cSJim Jagielski sal_Int32 mnWinWidth; /// Width of ruler and data grid.
140*b1cdbd2cSJim Jagielski sal_Int32 mnHdrWidth; /// Width of the header column.
141*b1cdbd2cSJim Jagielski sal_Int32 mnCharWidth; /// Pixel width of one character.
142*b1cdbd2cSJim Jagielski
143*b1cdbd2cSJim Jagielski // vertical settings
144*b1cdbd2cSJim Jagielski sal_Int32 mnLineCount; /// Number of data lines.
145*b1cdbd2cSJim Jagielski sal_Int32 mnLineOffset; /// Index of first visible line (0-based).
146*b1cdbd2cSJim Jagielski
147*b1cdbd2cSJim Jagielski sal_Int32 mnWinHeight; /// Height of entire data grid (incl. header).
148*b1cdbd2cSJim Jagielski sal_Int32 mnHdrHeight; /// Height of the header line.
149*b1cdbd2cSJim Jagielski sal_Int32 mnLineHeight; /// Height of a data line.
150*b1cdbd2cSJim Jagielski
151*b1cdbd2cSJim Jagielski // cursor settings
152*b1cdbd2cSJim Jagielski sal_Int32 mnPosCursor; /// Position of ruler cursor.
153*b1cdbd2cSJim Jagielski sal_Int32 mnColCursor; /// Position of grid column cursor.
154*b1cdbd2cSJim Jagielski
155*b1cdbd2cSJim Jagielski mutable sal_Int32 mnNoRepaint; /// >0 = no repaint.
156*b1cdbd2cSJim Jagielski bool mbAppRTL; /// true = application in RTL mode.
157*b1cdbd2cSJim Jagielski
158*b1cdbd2cSJim Jagielski explicit ScCsvLayoutData();
159*b1cdbd2cSJim Jagielski
160*b1cdbd2cSJim Jagielski /** Returns differences to rData.
161*b1cdbd2cSJim Jagielski @descr For each difference the appropriate bit is set in the returned value. */
162*b1cdbd2cSJim Jagielski ScCsvDiff GetDiff( const ScCsvLayoutData& rData ) const;
163*b1cdbd2cSJim Jagielski };
164*b1cdbd2cSJim Jagielski
operator ==(const ScCsvLayoutData & rData1,const ScCsvLayoutData & rData2)165*b1cdbd2cSJim Jagielski inline bool operator==( const ScCsvLayoutData& rData1, const ScCsvLayoutData& rData2 )
166*b1cdbd2cSJim Jagielski {
167*b1cdbd2cSJim Jagielski return rData1.GetDiff( rData2 ) == CSV_DIFF_EQUAL;
168*b1cdbd2cSJim Jagielski }
169*b1cdbd2cSJim Jagielski
operator !=(const ScCsvLayoutData & rData1,const ScCsvLayoutData & rData2)170*b1cdbd2cSJim Jagielski inline bool operator!=( const ScCsvLayoutData& rData1, const ScCsvLayoutData& rData2 )
171*b1cdbd2cSJim Jagielski {
172*b1cdbd2cSJim Jagielski return !(rData1 == rData2);
173*b1cdbd2cSJim Jagielski }
174*b1cdbd2cSJim Jagielski
175*b1cdbd2cSJim Jagielski
176*b1cdbd2cSJim Jagielski // ============================================================================
177*b1cdbd2cSJim Jagielski
178*b1cdbd2cSJim Jagielski /** Enumeration of possible commands to change any settings of the CSV controls.
179*b1cdbd2cSJim Jagielski @descr Controls have to send commands instead of changing their settings directly.
180*b1cdbd2cSJim Jagielski This helps to keep the different controls consistent to each other.
181*b1cdbd2cSJim Jagielski A command can contain 0 to 2 sal_Int32 parameters. In the description of each
182*b1cdbd2cSJim Jagielski command the required parameters are swown in brackets. [-] means no parameter. */
183*b1cdbd2cSJim Jagielski enum ScCsvCmdType
184*b1cdbd2cSJim Jagielski {
185*b1cdbd2cSJim Jagielski // misc
186*b1cdbd2cSJim Jagielski CSVCMD_NONE, /// No command. [-]
187*b1cdbd2cSJim Jagielski CSVCMD_REPAINT, /// Repaint all controls. [-]
188*b1cdbd2cSJim Jagielski
189*b1cdbd2cSJim Jagielski // modify horizontal dimensions
190*b1cdbd2cSJim Jagielski CSVCMD_SETPOSCOUNT, /// Change position/column count. [character count]
191*b1cdbd2cSJim Jagielski CSVCMD_SETPOSOFFSET, /// Change position offset (scroll pos). [position]
192*b1cdbd2cSJim Jagielski CSVCMD_SETHDRWIDTH, /// Change width of the header column. [width in pixel]
193*b1cdbd2cSJim Jagielski CSVCMD_SETCHARWIDTH, /// Change character pixel width. [width in pixel]
194*b1cdbd2cSJim Jagielski
195*b1cdbd2cSJim Jagielski // modify vertical dimensions
196*b1cdbd2cSJim Jagielski CSVCMD_SETLINECOUNT, /// Change number of data lines. [line count]
197*b1cdbd2cSJim Jagielski CSVCMD_SETLINEOFFSET, /// Change first visible line. [line index]
198*b1cdbd2cSJim Jagielski CSVCMD_SETHDRHEIGHT, /// Change height of top header line. [height in pixel]
199*b1cdbd2cSJim Jagielski CSVCMD_SETLINEHEIGHT, /// Change data line pixel height. [height in pixel}
200*b1cdbd2cSJim Jagielski
201*b1cdbd2cSJim Jagielski // cursors/positions
202*b1cdbd2cSJim Jagielski CSVCMD_MOVERULERCURSOR, /// Move ruler cursor to new position. [position]
203*b1cdbd2cSJim Jagielski CSVCMD_MOVEGRIDCURSOR, /// Move data grid cursor to new column. [position]
204*b1cdbd2cSJim Jagielski CSVCMD_MAKEPOSVISIBLE, /// Move to make passed position visible (for mouse tracking). [position]
205*b1cdbd2cSJim Jagielski
206*b1cdbd2cSJim Jagielski // table contents
207*b1cdbd2cSJim Jagielski CSVCMD_NEWCELLTEXTS, /// Recalculate splits and cell texts. [-]
208*b1cdbd2cSJim Jagielski CSVCMD_UPDATECELLTEXTS, /// Update cell texts with current split settings. [-]
209*b1cdbd2cSJim Jagielski CSVCMD_SETCOLUMNTYPE, /// Change data type of selected columns. [column type]
210*b1cdbd2cSJim Jagielski CSVCMD_EXPORTCOLUMNTYPE, /// Send selected column type to external controls. [-]
211*b1cdbd2cSJim Jagielski CSVCMD_SETFIRSTIMPORTLINE, /// Set number of first imported line. [line index]
212*b1cdbd2cSJim Jagielski
213*b1cdbd2cSJim Jagielski // splits
214*b1cdbd2cSJim Jagielski CSVCMD_INSERTSPLIT, /// Insert a split. [position]
215*b1cdbd2cSJim Jagielski CSVCMD_REMOVESPLIT, /// Remove a split. [position]
216*b1cdbd2cSJim Jagielski CSVCMD_TOGGLESPLIT, /// Inserts or removes a split. [position]
217*b1cdbd2cSJim Jagielski CSVCMD_MOVESPLIT, /// Move a split. [old position, new position]
218*b1cdbd2cSJim Jagielski CSVCMD_REMOVEALLSPLITS /// Remove all splits. [-]
219*b1cdbd2cSJim Jagielski };
220*b1cdbd2cSJim Jagielski
221*b1cdbd2cSJim Jagielski
222*b1cdbd2cSJim Jagielski // ----------------------------------------------------------------------------
223*b1cdbd2cSJim Jagielski
224*b1cdbd2cSJim Jagielski /** Data for a CSV control command. The stored position data is aways character based,
225*b1cdbd2cSJim Jagielski it's never a column index (required for internal consistency). */
226*b1cdbd2cSJim Jagielski class ScCsvCmd
227*b1cdbd2cSJim Jagielski {
228*b1cdbd2cSJim Jagielski private:
229*b1cdbd2cSJim Jagielski ScCsvCmdType meType; /// The command.
230*b1cdbd2cSJim Jagielski sal_Int32 mnParam1; /// First parameter.
231*b1cdbd2cSJim Jagielski sal_Int32 mnParam2; /// Second parameter.
232*b1cdbd2cSJim Jagielski
233*b1cdbd2cSJim Jagielski public:
ScCsvCmd()234*b1cdbd2cSJim Jagielski inline explicit ScCsvCmd() : meType( CSVCMD_NONE ),
235*b1cdbd2cSJim Jagielski mnParam1( CSV_POS_INVALID ), mnParam2( CSV_POS_INVALID ) {}
236*b1cdbd2cSJim Jagielski
237*b1cdbd2cSJim Jagielski inline void Set( ScCsvCmdType eType, sal_Int32 nParam1, sal_Int32 nParam2 );
238*b1cdbd2cSJim Jagielski
GetType() const239*b1cdbd2cSJim Jagielski inline ScCsvCmdType GetType() const { return meType; }
GetParam1() const240*b1cdbd2cSJim Jagielski inline sal_Int32 GetParam1() const { return mnParam1; }
GetParam2() const241*b1cdbd2cSJim Jagielski inline sal_Int32 GetParam2() const { return mnParam2; }
242*b1cdbd2cSJim Jagielski };
243*b1cdbd2cSJim Jagielski
Set(ScCsvCmdType eType,sal_Int32 nParam1,sal_Int32 nParam2)244*b1cdbd2cSJim Jagielski inline void ScCsvCmd::Set( ScCsvCmdType eType, sal_Int32 nParam1, sal_Int32 nParam2 )
245*b1cdbd2cSJim Jagielski {
246*b1cdbd2cSJim Jagielski meType = eType; mnParam1 = nParam1; mnParam2 = nParam2;
247*b1cdbd2cSJim Jagielski }
248*b1cdbd2cSJim Jagielski
249*b1cdbd2cSJim Jagielski
250*b1cdbd2cSJim Jagielski // ============================================================================
251*b1cdbd2cSJim Jagielski
252*b1cdbd2cSJim Jagielski /** Base class for the CSV ruler and the data grid control. Implements command handling. */
253*b1cdbd2cSJim Jagielski class SC_DLLPUBLIC ScCsvControl : public Control
254*b1cdbd2cSJim Jagielski {
255*b1cdbd2cSJim Jagielski protected:
256*b1cdbd2cSJim Jagielski typedef ::std::vector< String > StringVec;
257*b1cdbd2cSJim Jagielski typedef ::std::vector< StringVec > StringVecVec;
258*b1cdbd2cSJim Jagielski
259*b1cdbd2cSJim Jagielski typedef ::com::sun::star::uno::Reference<
260*b1cdbd2cSJim Jagielski ::com::sun::star::accessibility::XAccessible > XAccessibleRef;
261*b1cdbd2cSJim Jagielski
262*b1cdbd2cSJim Jagielski private:
263*b1cdbd2cSJim Jagielski Link maCmdHdl; /// External command handler.
264*b1cdbd2cSJim Jagielski ScCsvCmd maCmd; /// Data of last command.
265*b1cdbd2cSJim Jagielski const ScCsvLayoutData& mrData; /// Shared layout data.
266*b1cdbd2cSJim Jagielski
267*b1cdbd2cSJim Jagielski XAccessibleRef mxAccessible; /// The accessible object of the control.
268*b1cdbd2cSJim Jagielski ScAccessibleCsvControl* mpAccessible; /// Pointer to the accessible implementation object.
269*b1cdbd2cSJim Jagielski bool mbValidGfx; /// Content of virtual devices valid?
270*b1cdbd2cSJim Jagielski
271*b1cdbd2cSJim Jagielski // ------------------------------------------------------------------------
272*b1cdbd2cSJim Jagielski public:
273*b1cdbd2cSJim Jagielski explicit ScCsvControl( ScCsvControl& rParent );
274*b1cdbd2cSJim Jagielski explicit ScCsvControl( Window* pParent, const ScCsvLayoutData& rData, WinBits nStyle = 0 );
275*b1cdbd2cSJim Jagielski explicit ScCsvControl( Window* pParent, const ScCsvLayoutData& rData, const ResId& rResId );
276*b1cdbd2cSJim Jagielski virtual ~ScCsvControl();
277*b1cdbd2cSJim Jagielski
278*b1cdbd2cSJim Jagielski // event handling ---------------------------------------------------------
279*b1cdbd2cSJim Jagielski
280*b1cdbd2cSJim Jagielski virtual void GetFocus();
281*b1cdbd2cSJim Jagielski virtual void LoseFocus();
282*b1cdbd2cSJim Jagielski
283*b1cdbd2cSJim Jagielski /** Sends a GetFocus or LoseFocus event to the accessibility object. */
284*b1cdbd2cSJim Jagielski void AccSendFocusEvent( bool bFocused );
285*b1cdbd2cSJim Jagielski /** Sends a caret changed event to the accessibility object. */
286*b1cdbd2cSJim Jagielski void AccSendCaretEvent();
287*b1cdbd2cSJim Jagielski /** Sends a visible area changed event to the accessibility object. */
288*b1cdbd2cSJim Jagielski void AccSendVisibleEvent();
289*b1cdbd2cSJim Jagielski /** Sends a selection changed event to the accessibility object. */
290*b1cdbd2cSJim Jagielski void AccSendSelectionEvent();
291*b1cdbd2cSJim Jagielski /** Sends a table model changed event for changed cell contents to the accessibility object. */
292*b1cdbd2cSJim Jagielski void AccSendTableUpdateEvent( sal_uInt32 nFirstColumn, sal_uInt32 nLastColumn, bool bAllRows = true );
293*b1cdbd2cSJim Jagielski /** Sends a table model changed event for an inserted column to the accessibility object. */
294*b1cdbd2cSJim Jagielski void AccSendInsertColumnEvent( sal_uInt32 nFirstColumn, sal_uInt32 nLastColumn );
295*b1cdbd2cSJim Jagielski /** Sends a table model changed event for a removed column to the accessibility object. */
296*b1cdbd2cSJim Jagielski void AccSendRemoveColumnEvent( sal_uInt32 nFirstColumn, sal_uInt32 nLastColumn );
297*b1cdbd2cSJim Jagielski
298*b1cdbd2cSJim Jagielski // repaint helpers --------------------------------------------------------
299*b1cdbd2cSJim Jagielski
300*b1cdbd2cSJim Jagielski /** Sets the graphic invalid (next Redraw() will not use cached graphic). */
InvalidateGfx()301*b1cdbd2cSJim Jagielski inline void InvalidateGfx() { mbValidGfx = false; }
302*b1cdbd2cSJim Jagielski /** Sets the graphic valid (next Redraw() will use cached graphic). */
ValidateGfx()303*b1cdbd2cSJim Jagielski inline void ValidateGfx() { mbValidGfx = true; }
304*b1cdbd2cSJim Jagielski /** Returns true, if cached graphic is valid. */
IsValidGfx() const305*b1cdbd2cSJim Jagielski inline bool IsValidGfx() const { return mbValidGfx; }
306*b1cdbd2cSJim Jagielski
307*b1cdbd2cSJim Jagielski /** Repaints all controls.
308*b1cdbd2cSJim Jagielski @param bInvalidate true = invalidates graphics of this control (not all). */
309*b1cdbd2cSJim Jagielski void Repaint( bool bInvalidate = false );
310*b1cdbd2cSJim Jagielski /** Increases no-repaint counter (controls do not repaint until the last EnableRepaint()). */
311*b1cdbd2cSJim Jagielski void DisableRepaint();
312*b1cdbd2cSJim Jagielski /** Decreases no-repaint counter and repaints if counter reaches 0.
313*b1cdbd2cSJim Jagielski @param bInvalidate true = invalidates graphics of this control (not all). */
314*b1cdbd2cSJim Jagielski void EnableRepaint( bool bInvalidate = false );
315*b1cdbd2cSJim Jagielski /** Returns true, if controls will not repaint. */
IsNoRepaint() const316*b1cdbd2cSJim Jagielski inline bool IsNoRepaint() const { return mrData.mnNoRepaint > 0; }
317*b1cdbd2cSJim Jagielski
318*b1cdbd2cSJim Jagielski // command handling -------------------------------------------------------
319*b1cdbd2cSJim Jagielski
320*b1cdbd2cSJim Jagielski /** Sets a new command handler. */
SetCmdHdl(const Link & rHdl)321*b1cdbd2cSJim Jagielski inline void SetCmdHdl( const Link& rHdl ) { maCmdHdl = rHdl; }
322*b1cdbd2cSJim Jagielski /** Returns the current command handler. */
GetCmdHdl() const323*b1cdbd2cSJim Jagielski inline const Link& GetCmdHdl() const { return maCmdHdl; }
324*b1cdbd2cSJim Jagielski /** Returns data of the last command. */
GetCmd() const325*b1cdbd2cSJim Jagielski inline const ScCsvCmd& GetCmd() const { return maCmd; }
326*b1cdbd2cSJim Jagielski
327*b1cdbd2cSJim Jagielski /** Executes a command by calling command handler. */
328*b1cdbd2cSJim Jagielski void Execute(
329*b1cdbd2cSJim Jagielski ScCsvCmdType eType,
330*b1cdbd2cSJim Jagielski sal_Int32 nParam1 = CSV_POS_INVALID,
331*b1cdbd2cSJim Jagielski sal_Int32 nParam2 = CSV_POS_INVALID );
332*b1cdbd2cSJim Jagielski
333*b1cdbd2cSJim Jagielski // layout helpers ---------------------------------------------------------
334*b1cdbd2cSJim Jagielski
335*b1cdbd2cSJim Jagielski /** Returns a reference to the current layout data. */
GetLayoutData() const336*b1cdbd2cSJim Jagielski inline const ScCsvLayoutData& GetLayoutData() const { return mrData; }
337*b1cdbd2cSJim Jagielski /** Returns true, if the Right-to-Left layout mode is active. */
IsRTL() const338*b1cdbd2cSJim Jagielski inline bool IsRTL() const { return mrData.mbAppRTL; }
339*b1cdbd2cSJim Jagielski
340*b1cdbd2cSJim Jagielski /** Returns the number of available positions. */
GetPosCount() const341*b1cdbd2cSJim Jagielski inline sal_Int32 GetPosCount() const { return mrData.mnPosCount; }
342*b1cdbd2cSJim Jagielski /** Returns the number of visible positions. */
343*b1cdbd2cSJim Jagielski sal_Int32 GetVisPosCount() const;
344*b1cdbd2cSJim Jagielski /** Returns the first visible position. */
GetFirstVisPos() const345*b1cdbd2cSJim Jagielski inline sal_Int32 GetFirstVisPos() const { return mrData.mnPosOffset; }
346*b1cdbd2cSJim Jagielski /** Returns the last visible position. */
GetLastVisPos() const347*b1cdbd2cSJim Jagielski inline sal_Int32 GetLastVisPos() const { return GetFirstVisPos() + GetVisPosCount(); }
348*b1cdbd2cSJim Jagielski /** Returns highest possible position for first visible character. */
349*b1cdbd2cSJim Jagielski sal_Int32 GetMaxPosOffset() const;
350*b1cdbd2cSJim Jagielski
351*b1cdbd2cSJim Jagielski /** Returns true, if it is allowed to set a split at nPos. */
352*b1cdbd2cSJim Jagielski bool IsValidSplitPos( sal_Int32 nPos ) const;
353*b1cdbd2cSJim Jagielski /** Returns true, if nPos is an allowed AND visible split position. */
354*b1cdbd2cSJim Jagielski bool IsVisibleSplitPos( sal_Int32 nPos ) const;
355*b1cdbd2cSJim Jagielski
356*b1cdbd2cSJim Jagielski /** Returns the width of the header column. */
GetHdrWidth() const357*b1cdbd2cSJim Jagielski inline sal_Int32 GetHdrWidth() const { return mrData.mnHdrWidth; }
358*b1cdbd2cSJim Jagielski /** Returns the width of one character column. */
GetCharWidth() const359*b1cdbd2cSJim Jagielski inline sal_Int32 GetCharWidth() const { return mrData.mnCharWidth; }
360*b1cdbd2cSJim Jagielski /** Returns the start position of the header column. */
361*b1cdbd2cSJim Jagielski sal_Int32 GetHdrX() const;
362*b1cdbd2cSJim Jagielski /** Returns the X position of the first pixel of the data area. */
363*b1cdbd2cSJim Jagielski sal_Int32 GetFirstX() const;
364*b1cdbd2cSJim Jagielski /** Returns the X position of the last pixel of the data area. */
365*b1cdbd2cSJim Jagielski sal_Int32 GetLastX() const;
366*b1cdbd2cSJim Jagielski /** Returns output X coordinate of the specified position. */
367*b1cdbd2cSJim Jagielski sal_Int32 GetX( sal_Int32 nPos ) const;
368*b1cdbd2cSJim Jagielski /** Returns position from output coordinate. */
369*b1cdbd2cSJim Jagielski sal_Int32 GetPosFromX( sal_Int32 nX ) const;
370*b1cdbd2cSJim Jagielski
371*b1cdbd2cSJim Jagielski /** Returns the number of data lines. */
GetLineCount() const372*b1cdbd2cSJim Jagielski inline sal_Int32 GetLineCount() const { return mrData.mnLineCount; }
373*b1cdbd2cSJim Jagielski /** Returns the number of visible lines (including partly visible bottom line). */
374*b1cdbd2cSJim Jagielski sal_Int32 GetVisLineCount() const;
375*b1cdbd2cSJim Jagielski /** Returns index of first visible line. */
GetFirstVisLine() const376*b1cdbd2cSJim Jagielski inline sal_Int32 GetFirstVisLine() const { return mrData.mnLineOffset; }
377*b1cdbd2cSJim Jagielski /** Returns index of last visible line. */
378*b1cdbd2cSJim Jagielski sal_Int32 GetLastVisLine() const;
379*b1cdbd2cSJim Jagielski /** Returns highest possible index for first line. */
380*b1cdbd2cSJim Jagielski sal_Int32 GetMaxLineOffset() const;
381*b1cdbd2cSJim Jagielski
382*b1cdbd2cSJim Jagielski /** Returns true, if nLine is a valid line index. */
383*b1cdbd2cSJim Jagielski bool IsValidLine( sal_Int32 nLine ) const;
384*b1cdbd2cSJim Jagielski /** Returns true, if nLine is a valid and visible line index. */
385*b1cdbd2cSJim Jagielski bool IsVisibleLine( sal_Int32 nLine ) const;
386*b1cdbd2cSJim Jagielski
387*b1cdbd2cSJim Jagielski /** Returns the height of the header line. */
GetHdrHeight() const388*b1cdbd2cSJim Jagielski inline sal_Int32 GetHdrHeight() const { return mrData.mnHdrHeight; }
389*b1cdbd2cSJim Jagielski /** Returns the height of one line. */
GetLineHeight() const390*b1cdbd2cSJim Jagielski inline sal_Int32 GetLineHeight() const { return mrData.mnLineHeight; }
391*b1cdbd2cSJim Jagielski /** Returns output Y coordinate of the specified line. */
392*b1cdbd2cSJim Jagielski sal_Int32 GetY( sal_Int32 nLine ) const;
393*b1cdbd2cSJim Jagielski /** Returns line index from output coordinate. */
394*b1cdbd2cSJim Jagielski sal_Int32 GetLineFromY( sal_Int32 nY ) const;
395*b1cdbd2cSJim Jagielski
396*b1cdbd2cSJim Jagielski /** Returns the ruler cursor position. */
GetRulerCursorPos() const397*b1cdbd2cSJim Jagielski inline sal_Int32 GetRulerCursorPos() const { return mrData.mnPosCursor; }
398*b1cdbd2cSJim Jagielski /** Returns the data grid cursor position (not column index!). */
GetGridCursorPos() const399*b1cdbd2cSJim Jagielski inline sal_Int32 GetGridCursorPos() const { return mrData.mnColCursor; }
400*b1cdbd2cSJim Jagielski
401*b1cdbd2cSJim Jagielski // static helpers ---------------------------------------------------------
402*b1cdbd2cSJim Jagielski
403*b1cdbd2cSJim Jagielski /** Inverts a rectangle in the specified output device. */
404*b1cdbd2cSJim Jagielski static void ImplInvertRect( OutputDevice& rOutDev, const Rectangle& rRect );
405*b1cdbd2cSJim Jagielski
406*b1cdbd2cSJim Jagielski /** Returns direction code for the keys LEFT, RIGHT, HOME, END.
407*b1cdbd2cSJim Jagielski @param bHomeEnd false = ignore HOME and END key. */
408*b1cdbd2cSJim Jagielski static ScMoveMode GetHorzDirection( sal_uInt16 nCode, bool bHomeEnd );
409*b1cdbd2cSJim Jagielski /** Returns direction code for the keys UP, DOWN, HOME, END, PAGE UP, PAGE DOWN.
410*b1cdbd2cSJim Jagielski @param bHomeEnd false = ignore HOME and END key. */
411*b1cdbd2cSJim Jagielski static ScMoveMode GetVertDirection( sal_uInt16 nCode, bool bHomeEnd );
412*b1cdbd2cSJim Jagielski
413*b1cdbd2cSJim Jagielski // accessibility ----------------------------------------------------------
414*b1cdbd2cSJim Jagielski public:
415*b1cdbd2cSJim Jagielski /** Creates and returns the accessible object of this control. Do not overwrite in
416*b1cdbd2cSJim Jagielski derived classes, use ImplCreateAccessible() instead. */
417*b1cdbd2cSJim Jagielski virtual XAccessibleRef CreateAccessible();
418*b1cdbd2cSJim Jagielski
419*b1cdbd2cSJim Jagielski protected:
420*b1cdbd2cSJim Jagielski /** Derived classes create a new accessible object here. */
421*b1cdbd2cSJim Jagielski virtual ScAccessibleCsvControl* ImplCreateAccessible() = 0;
422*b1cdbd2cSJim Jagielski };
423*b1cdbd2cSJim Jagielski
424*b1cdbd2cSJim Jagielski
425*b1cdbd2cSJim Jagielski // ============================================================================
426*b1cdbd2cSJim Jagielski
427*b1cdbd2cSJim Jagielski #endif
428*b1cdbd2cSJim Jagielski
429