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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
// FIX fdo#38246 https://bugs.freedesktop.org/show_bug.cgi?id=38246
// Design proposal: https://wiki.documentfoundation.org/Design/Whiteboards/Comments_Ruler_Control
// TODO Alpha blend border when it doesn't fit in window
// TODO Delayed highlight fading when user moves mouse over and out the control
#include "swruler.hxx"
#include "viewsh.hxx"
#include "edtwin.hxx"
#include "PostItMgr.hxx"
#include "viewopt.hxx"
#include <view.hxx>
#include "cmdid.h"
#include <sfx2/request.hxx>
#include <vcl/svapp.hxx>
#include <vcl/window.hxx>
#include "misc.hrc"
#define CONTROL_BORDER_WIDTH 1
#define CONTROL_LEFT_OFFSET 6
#define CONTROL_RIGHT_OFFSET 3
#define CONTROL_TOP_OFFSET 4
#define CONTROL_TRIANGLE_WIDTH 4
#define CONTROL_TRIANGLE_PAD 3
// Constructor
SwCommentRuler::SwCommentRuler( ViewShell* pViewSh, Window* pParent, SwEditWin* pWin, sal_uInt16 nRulerFlags, SfxBindings& rBindings, WinBits nWinStyle)
: SvxRuler(pParent, pWin, nRulerFlags, rBindings, nWinStyle | WB_HSCROLL)
, mpViewShell(pViewSh)
, mpSwWin(pWin)
, mbIsHighlighted(false)
, maVirDev( *this )
{
}
// Destructor
SwCommentRuler::~SwCommentRuler()
{
}
void SwCommentRuler::Paint( const Rectangle& rRect )
{
SvxRuler::Paint( rRect );
// Don't draw if there is not any note
if ( mpViewShell->GetPostItMgr()->HasNotes() )
DrawCommentControl();
}
void SwCommentRuler::DrawCommentControl()
{
const StyleSettings& rStyleSettings = GetSettings().GetStyleSettings();
bool bIsCollapsed = ! mpViewShell->GetPostItMgr()->ShowNotes();
Rectangle aControlRect = GetCommentControlRegion();
maVirDev.SetOutputSizePixel( aControlRect.GetSize() );
// Paint comment control background
// TODO Check if these are best colors to be used
if ( mbIsHighlighted )
maVirDev.SetFillColor( rStyleSettings.GetDarkShadowColor() );
else
maVirDev.SetFillColor( rStyleSettings.GetWorkspaceColor() );
if ( mbIsHighlighted || !bIsCollapsed )
{
// Draw borders
maVirDev.SetLineColor( rStyleSettings.GetShadowColor() );
}
else
{
// No borders
maVirDev.SetLineColor();
}
maVirDev.DrawRect( Rectangle( Point(), aControlRect.GetSize() ) );
String aLabel( SW_RESSTR ( STR_COMMENTS_LABEL ) );
// Get label and arrow coordinates
Point aLabelPos;
Point aArrowPos;
bool bArrowToRight;
// TODO Discover why it should be 0 instead of CONTROL_BORDER_WIDTH + CONTROL_TOP_OFFSET
aLabelPos.Y() = 0;
aArrowPos.Y() = CONTROL_BORDER_WIDTH + CONTROL_TOP_OFFSET;
if ( !Application::GetSettings().GetLayoutRTL() )
{
// LTR
if ( bIsCollapsed )
{
// It should draw something like | > Comments |
aLabelPos.X() = CONTROL_LEFT_OFFSET + CONTROL_TRIANGLE_WIDTH + CONTROL_TRIANGLE_PAD;
aArrowPos.X() = CONTROL_LEFT_OFFSET;
}
else
{
// It should draw something like | Comments < |
aLabelPos.X() = CONTROL_LEFT_OFFSET;
aArrowPos.X() = aControlRect.GetSize().Width() - 1 - CONTROL_RIGHT_OFFSET - CONTROL_BORDER_WIDTH - CONTROL_TRIANGLE_WIDTH;
}
bArrowToRight = bIsCollapsed;
}
else
{
// RTL
long nLabelWidth = GetTextWidth( aLabel );
if ( bIsCollapsed )
{
// It should draw something like | Comments < |
aArrowPos.X() = aControlRect.GetSize().Width() - 1 - CONTROL_RIGHT_OFFSET - CONTROL_BORDER_WIDTH - CONTROL_TRIANGLE_WIDTH;
aLabelPos.X() = aArrowPos.X() - CONTROL_TRIANGLE_PAD - nLabelWidth;
}
else
{
// It should draw something like | > Comments |
aLabelPos.X() = aControlRect.GetSize().Width() - 1 - CONTROL_RIGHT_OFFSET - CONTROL_BORDER_WIDTH - nLabelWidth;
aArrowPos.X() = CONTROL_LEFT_OFFSET;
}
bArrowToRight = !bIsCollapsed;
}
// Draw label
const Color &rTextColor = mbIsHighlighted ? rStyleSettings.GetButtonTextColor() : rStyleSettings.GetDeactiveTextColor();
maVirDev.SetTextColor( rTextColor );
// FIXME Expected font size?
maVirDev.DrawText( aLabelPos, aLabel );
// Draw arrow
// FIXME consistence of button colors. http://opengrok.libreoffice.org/xref/core/vcl/source/control/button.cxx#785
const Color &rArrowColor = mbIsHighlighted ? Color( COL_BLACK ) : rStyleSettings.GetShadowColor();
ImplDrawArrow ( aArrowPos.X(), aArrowPos.Y(), rArrowColor, bArrowToRight );
// Blit comment control
DrawOutDev( aControlRect.TopLeft(), aControlRect.GetSize(), Point(), aControlRect.GetSize(), maVirDev );
}
void SwCommentRuler::ImplDrawArrow(long nX, long nY, const Color& rColor, bool bPointRight)
{
maVirDev.SetLineColor();
maVirDev.SetFillColor( rColor );
if ( bPointRight )
{
maVirDev.DrawRect( Rectangle( nX+0, nY+0, nX+0, nY+6 ) );
maVirDev.DrawRect( Rectangle( nX+1, nY+1, nX+1, nY+5 ) );
maVirDev.DrawRect( Rectangle( nX+2, nY+2, nX+2, nY+4 ) );
maVirDev.DrawRect( Rectangle( nX+3, nY+3, nX+3, nY+3 ) );
}
else
{
maVirDev.DrawRect( Rectangle( nX+0, nY+3, nX+0, nY+3 ) );
maVirDev.DrawRect( Rectangle( nX+1, nY+2, nX+1, nY+4 ) );
maVirDev.DrawRect( Rectangle( nX+2, nY+1, nX+2, nY+5 ) );
maVirDev.DrawRect( Rectangle( nX+3, nY+0, nX+3, nY+6 ) );
}
}
// Just accept double-click outside comment control
void SwCommentRuler::Command( const CommandEvent& rCEvt )
{
Point aMousePos = rCEvt.GetMousePosPixel();
// Ignore command request if it is inside Comment Control
if ( !mpViewShell->GetPostItMgr()
|| !mpViewShell->GetPostItMgr()->HasNotes()
|| !GetCommentControlRegion().IsInside( aMousePos ) )
SvxRuler::Command( rCEvt );
}
void SwCommentRuler::MouseMove(const MouseEvent& rMEvt)
{
SvxRuler::MouseMove(rMEvt);
if ( ! mpViewShell->GetPostItMgr() || ! mpViewShell->GetPostItMgr()->HasNotes() )
return;
// TODO Delay 0.1s to highlight and 0.2s to "lowlight"
Point aMousePos = rMEvt.GetPosPixel();
bool bWasHighlighted = mbIsHighlighted;
mbIsHighlighted = GetCommentControlRegion().IsInside( aMousePos );
if ( mbIsHighlighted != bWasHighlighted )
{
// Repaint for highlight changes make effect
Invalidate();
// Set proper help text
if ( mbIsHighlighted )
{
// Mouse over comment control
UpdateCommentHelpText();
}
else
{
// Mouse out of comment control
// FIXME Should remember previous tooltip text?
SetQuickHelpText( String() );
}
}
}
void SwCommentRuler::MouseButtonDown( const MouseEvent& rMEvt )
{
Point aMousePos = rMEvt.GetPosPixel();
if ( !rMEvt.IsLeft() || IsTracking() || !GetCommentControlRegion().IsInside( aMousePos ) )
{
SvxRuler::MouseButtonDown(rMEvt);
return;
}
// Toggle notes visibility
SwView &rView = mpSwWin->GetView();
SfxRequest aRequest( rView.GetViewFrame(), FN_VIEW_NOTES );
rView.ExecViewOptions( aRequest );
// It is inside comment control, so update help text
UpdateCommentHelpText();
Invalidate();
}
void SwCommentRuler::Update()
{
Rectangle aPreviousControlRect = GetCommentControlRegion();
SvxRuler::Update();
if (aPreviousControlRect != GetCommentControlRegion())
Invalidate();
}
void SwCommentRuler::UpdateCommentHelpText()
{
int nTooltipResId;
if ( mpViewShell->GetPostItMgr()->ShowNotes() )
nTooltipResId = STR_HIDE_COMMENTS;
else
nTooltipResId = STR_SHOW_COMMENTS;
SetQuickHelpText( OUString( SW_RESSTR( nTooltipResId ) ) );
}
// NOTE: If sometime ahead SwSidebar moves from page right side due RTL layout,
// change how this rectangle is used by callers
// TODO Make Ruler return its central rectangle instead of margins.
Rectangle SwCommentRuler::GetCommentControlRegion()
{
long nLeft = 0;
SwPostItMgr *pPostItMgr = mpViewShell->GetPostItMgr();
//rhbz#1006850 When the SwPostItMgr ctor is called from SwView::SwView it
//triggers an update of the uiview, but the result of the ctor hasn't been
//set into the mpViewShell yet, so GetPostItMgr is temporarily still NULL
if (!pPostItMgr)
return Rectangle();
//FIXME When the page width is larger then screen, the ruler is misplaced by one pixel
if (GetTextRTL())
nLeft = GetPageOffset() - pPostItMgr->GetSidebarWidth(true) + GetBorderOffset();
else
nLeft = GetWinOffset() + GetPageOffset() + mpSwWin->LogicToPixel(Size(GetPageWidth(), 0)).Width();
long nTop = 0 + 4; // Ruler::ImplDraw uses RULER_OFF (value: 3px) as offset, and Ruler::ImplFormat adds one extra pixel
// Somehow pPostItMgr->GetSidebarBorderWidth() returns border width already doubled
long nRight = nLeft+ pPostItMgr->GetSidebarWidth(true) + pPostItMgr->GetSidebarBorderWidth(true);
long nBottom = nTop + GetRulerVirHeight() - 3;
Rectangle aRect(nLeft, nTop, nRight, nBottom);
return aRect;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
