1 // Copyright 2014 The PDFium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #include "xfa/fwl/cfwl_scrollbar.h"
8
9 #include <algorithm>
10 #include <memory>
11 #include <utility>
12
13 #include "xfa/fwl/cfwl_app.h"
14 #include "xfa/fwl/cfwl_messagemouse.h"
15 #include "xfa/fwl/cfwl_messagemousewheel.h"
16 #include "xfa/fwl/cfwl_notedriver.h"
17 #include "xfa/fwl/cfwl_themebackground.h"
18 #include "xfa/fwl/cfwl_themepart.h"
19 #include "xfa/fwl/ifwl_themeprovider.h"
20
21 namespace pdfium {
22
23 namespace {
24
25 constexpr int kScrollbarElapsedMsecs = 500;
26 constexpr float kMinThumbSize = 5.0f;
27
28 } // namespace
29
CFWL_ScrollBar(CFWL_App * app,const Properties & properties,CFWL_Widget * pOuter)30 CFWL_ScrollBar::CFWL_ScrollBar(CFWL_App* app,
31 const Properties& properties,
32 CFWL_Widget* pOuter)
33 : CFWL_Widget(app, properties, pOuter) {}
34
35 CFWL_ScrollBar::~CFWL_ScrollBar() = default;
36
GetClassID() const37 FWL_Type CFWL_ScrollBar::GetClassID() const {
38 return FWL_Type::ScrollBar;
39 }
40
Update()41 void CFWL_ScrollBar::Update() {
42 if (IsLocked())
43 return;
44
45 Layout();
46 }
47
DrawWidget(CFGAS_GEGraphics * pGraphics,const CFX_Matrix & matrix)48 void CFWL_ScrollBar::DrawWidget(CFGAS_GEGraphics* pGraphics,
49 const CFX_Matrix& matrix) {
50 if (!pGraphics)
51 return;
52
53 if (HasBorder())
54 DrawBorder(pGraphics, CFWL_ThemePart::Part::kBorder, matrix);
55
56 DrawLowerTrack(pGraphics, matrix);
57 DrawUpperTrack(pGraphics, matrix);
58 DrawMinArrowBtn(pGraphics, matrix);
59 DrawMaxArrowBtn(pGraphics, matrix);
60 DrawThumb(pGraphics, matrix);
61 }
62
SetTrackPos(float fTrackPos)63 void CFWL_ScrollBar::SetTrackPos(float fTrackPos) {
64 m_fTrackPos = fTrackPos;
65 m_ThumbRect = CalcThumbButtonRect(m_ThumbRect);
66 m_MinTrackRect = CalcMinTrackRect(m_MinTrackRect);
67 m_MaxTrackRect = CalcMaxTrackRect(m_MaxTrackRect);
68 }
69
DoScroll(CFWL_EventScroll::Code dwCode,float fPos)70 bool CFWL_ScrollBar::DoScroll(CFWL_EventScroll::Code dwCode, float fPos) {
71 if (dwCode == CFWL_EventScroll::Code::None)
72 return false;
73 return OnScroll(dwCode, fPos);
74 }
75
DrawUpperTrack(CFGAS_GEGraphics * pGraphics,const CFX_Matrix & mtMatrix)76 void CFWL_ScrollBar::DrawUpperTrack(CFGAS_GEGraphics* pGraphics,
77 const CFX_Matrix& mtMatrix) {
78 CFWL_ThemeBackground param(CFWL_ThemePart::Part::kUpperTrack, this,
79 pGraphics);
80 param.m_dwStates = (m_Properties.m_dwStates & FWL_STATE_WGT_Disabled)
81 ? CFWL_PartState::kDisabled
82 : m_iMaxTrackState;
83 param.m_matrix = mtMatrix;
84 param.m_PartRect = m_MaxTrackRect;
85 GetThemeProvider()->DrawBackground(param);
86 }
87
DrawLowerTrack(CFGAS_GEGraphics * pGraphics,const CFX_Matrix & mtMatrix)88 void CFWL_ScrollBar::DrawLowerTrack(CFGAS_GEGraphics* pGraphics,
89 const CFX_Matrix& mtMatrix) {
90 CFWL_ThemeBackground param(CFWL_ThemePart::Part::kLowerTrack, this,
91 pGraphics);
92 param.m_dwStates = (m_Properties.m_dwStates & FWL_STATE_WGT_Disabled)
93 ? CFWL_PartState::kDisabled
94 : m_iMinTrackState;
95 param.m_matrix = mtMatrix;
96 param.m_PartRect = m_MinTrackRect;
97 GetThemeProvider()->DrawBackground(param);
98 }
99
DrawMaxArrowBtn(CFGAS_GEGraphics * pGraphics,const CFX_Matrix & mtMatrix)100 void CFWL_ScrollBar::DrawMaxArrowBtn(CFGAS_GEGraphics* pGraphics,
101 const CFX_Matrix& mtMatrix) {
102 CFWL_ThemeBackground param(CFWL_ThemePart::Part::kBackArrow, this, pGraphics);
103 param.m_dwStates = (m_Properties.m_dwStates & FWL_STATE_WGT_Disabled)
104 ? CFWL_PartState::kDisabled
105 : m_iMaxButtonState;
106 param.m_matrix = mtMatrix;
107 param.m_PartRect = m_MaxBtnRect;
108 if (param.m_PartRect.height > 0 && param.m_PartRect.width > 0)
109 GetThemeProvider()->DrawBackground(param);
110 }
111
DrawMinArrowBtn(CFGAS_GEGraphics * pGraphics,const CFX_Matrix & mtMatrix)112 void CFWL_ScrollBar::DrawMinArrowBtn(CFGAS_GEGraphics* pGraphics,
113 const CFX_Matrix& mtMatrix) {
114 CFWL_ThemeBackground param(CFWL_ThemePart::Part::kForeArrow, this, pGraphics);
115 param.m_dwStates = (m_Properties.m_dwStates & FWL_STATE_WGT_Disabled)
116 ? CFWL_PartState::kDisabled
117 : m_iMinButtonState;
118 param.m_matrix = mtMatrix;
119 param.m_PartRect = m_MinBtnRect;
120 if (param.m_PartRect.height > 0 && param.m_PartRect.width > 0)
121 GetThemeProvider()->DrawBackground(param);
122 }
123
DrawThumb(CFGAS_GEGraphics * pGraphics,const CFX_Matrix & mtMatrix)124 void CFWL_ScrollBar::DrawThumb(CFGAS_GEGraphics* pGraphics,
125 const CFX_Matrix& mtMatrix) {
126 CFWL_ThemeBackground param(CFWL_ThemePart::Part::kThumb, this, pGraphics);
127 param.m_dwStates = (m_Properties.m_dwStates & FWL_STATE_WGT_Disabled)
128 ? CFWL_PartState::kDisabled
129 : m_iThumbButtonState;
130 param.m_matrix = mtMatrix;
131 param.m_PartRect = m_ThumbRect;
132 GetThemeProvider()->DrawBackground(param);
133 }
134
Layout()135 void CFWL_ScrollBar::Layout() {
136 m_ClientRect = GetClientRect();
137
138 CalcButtonLen();
139 m_MinBtnRect = CalcMinButtonRect();
140 m_MaxBtnRect = CalcMaxButtonRect();
141 m_ThumbRect = CalcThumbButtonRect(m_ThumbRect);
142 m_MinTrackRect = CalcMinTrackRect(m_MinTrackRect);
143 m_MaxTrackRect = CalcMaxTrackRect(m_MaxTrackRect);
144 }
145
CalcButtonLen()146 void CFWL_ScrollBar::CalcButtonLen() {
147 m_fButtonLen = IsVertical() ? m_ClientRect.width : m_ClientRect.height;
148 float fLength = IsVertical() ? m_ClientRect.height : m_ClientRect.width;
149 if (fLength < m_fButtonLen * 2) {
150 m_fButtonLen = fLength / 2;
151 m_bMinSize = true;
152 } else {
153 m_bMinSize = false;
154 }
155 }
156
CalcMinButtonRect()157 CFX_RectF CFWL_ScrollBar::CalcMinButtonRect() {
158 if (IsVertical())
159 return CFX_RectF(m_ClientRect.TopLeft(), m_ClientRect.width, m_fButtonLen);
160 return CFX_RectF(m_ClientRect.TopLeft(), m_fButtonLen, m_ClientRect.height);
161 }
162
CalcMaxButtonRect()163 CFX_RectF CFWL_ScrollBar::CalcMaxButtonRect() {
164 if (IsVertical()) {
165 return CFX_RectF(m_ClientRect.left, m_ClientRect.bottom() - m_fButtonLen,
166 m_ClientRect.width, m_fButtonLen);
167 }
168 return CFX_RectF(m_ClientRect.right() - m_fButtonLen, m_ClientRect.top,
169 m_fButtonLen, m_ClientRect.height);
170 }
171
CalcThumbButtonRect(const CFX_RectF & rtThumb)172 CFX_RectF CFWL_ScrollBar::CalcThumbButtonRect(const CFX_RectF& rtThumb) {
173 CFX_RectF rect;
174 if (!IsEnabled())
175 return rect;
176
177 if (m_bMinSize) {
178 rect.left = rtThumb.left;
179 rect.top = rtThumb.top;
180 return rect;
181 }
182
183 float fRange = m_fRangeMax - m_fRangeMin;
184 if (fRange < 0) {
185 if (IsVertical()) {
186 return CFX_RectF(m_ClientRect.left, m_MaxBtnRect.bottom(),
187 m_ClientRect.width, 0);
188 }
189 return CFX_RectF(m_MaxBtnRect.right(), m_ClientRect.top, 0,
190 m_ClientRect.height);
191 }
192
193 CFX_RectF rtClient = m_ClientRect;
194 float fLength = IsVertical() ? rtClient.height : rtClient.width;
195 float fSize = m_fButtonLen;
196 fLength -= fSize * 2.0f;
197 if (fLength < fSize)
198 fLength = 0.0f;
199
200 float fThumbSize = fLength * fLength / (fRange + fLength);
201 fThumbSize = std::max(fThumbSize, kMinThumbSize);
202
203 float fDiff = std::max(fLength - fThumbSize, 0.0f);
204 float fTrackPos = std::clamp(m_fTrackPos, m_fRangeMin, m_fRangeMax);
205 if (!fRange)
206 return rect;
207
208 float iPos = fSize + fDiff * (fTrackPos - m_fRangeMin) / fRange;
209 rect.left = rtClient.left;
210 rect.top = rtClient.top;
211 if (IsVertical()) {
212 rect.top += iPos;
213 rect.width = rtClient.width;
214 rect.height = fThumbSize;
215 } else {
216 rect.left += iPos;
217 rect.width = fThumbSize;
218 rect.height = rtClient.height;
219 }
220 return rect;
221 }
222
CalcMinTrackRect(const CFX_RectF & rtMinRect)223 CFX_RectF CFWL_ScrollBar::CalcMinTrackRect(const CFX_RectF& rtMinRect) {
224 CFX_RectF rect;
225 if (m_bMinSize) {
226 rect.left = rtMinRect.left;
227 rect.top = rtMinRect.top;
228 return rect;
229 }
230
231 rect.left = m_ClientRect.left;
232 rect.top = m_ClientRect.top;
233 if (IsVertical()) {
234 rect.width = m_ClientRect.width;
235 rect.height = (m_ThumbRect.top + m_ThumbRect.bottom()) / 2;
236 } else {
237 rect.width = (m_ThumbRect.left + m_ThumbRect.right()) / 2;
238 rect.height = m_ClientRect.height;
239 }
240 return rect;
241 }
242
CalcMaxTrackRect(const CFX_RectF & rtMaxRect)243 CFX_RectF CFWL_ScrollBar::CalcMaxTrackRect(const CFX_RectF& rtMaxRect) {
244 if (m_bMinSize)
245 return CFX_RectF(rtMaxRect.TopLeft(), 0, 0);
246
247 if (IsVertical()) {
248 float iy = (m_ThumbRect.top + m_ThumbRect.bottom()) / 2;
249 return CFX_RectF(m_ClientRect.left, iy, m_ClientRect.width,
250 m_ClientRect.bottom() - iy);
251 }
252
253 float ix = (m_ThumbRect.left + m_ThumbRect.right()) / 2;
254 return CFX_RectF(ix, m_ClientRect.top, m_ClientRect.height - ix,
255 m_ClientRect.height);
256 }
257
GetTrackPointPos(const CFX_PointF & point)258 float CFWL_ScrollBar::GetTrackPointPos(const CFX_PointF& point) {
259 CFX_PointF diff = point - m_cpTrackPoint;
260 float fRange = m_fRangeMax - m_fRangeMin;
261 float fPos;
262
263 if (IsVertical()) {
264 fPos = fRange * diff.y /
265 (m_MaxBtnRect.top - m_MinBtnRect.bottom() - m_ThumbRect.height);
266 } else {
267 fPos = fRange * diff.x /
268 (m_MaxBtnRect.left - m_MinBtnRect.right() - m_ThumbRect.width);
269 }
270
271 fPos += m_fLastTrackPos;
272 return std::clamp(fPos, m_fRangeMin, m_fRangeMax);
273 }
274
SendEvent()275 bool CFWL_ScrollBar::SendEvent() {
276 if (m_iMinButtonState == CFWL_PartState::kPressed) {
277 DoScroll(CFWL_EventScroll::Code::StepBackward, m_fTrackPos);
278 return false;
279 }
280 if (m_iMaxButtonState == CFWL_PartState::kPressed) {
281 DoScroll(CFWL_EventScroll::Code::StepForward, m_fTrackPos);
282 return false;
283 }
284 if (m_iMinTrackState == CFWL_PartState::kPressed) {
285 DoScroll(CFWL_EventScroll::Code::PageBackward, m_fTrackPos);
286 return m_ThumbRect.Contains(m_cpTrackPoint);
287 }
288 if (m_iMaxTrackState == CFWL_PartState::kPressed) {
289 DoScroll(CFWL_EventScroll::Code::PageForward, m_fTrackPos);
290 return m_ThumbRect.Contains(m_cpTrackPoint);
291 }
292 if (m_iMouseWheel) {
293 CFWL_EventScroll::Code dwCode = m_iMouseWheel < 0
294 ? CFWL_EventScroll::Code::StepForward
295 : CFWL_EventScroll::Code::StepBackward;
296 DoScroll(dwCode, m_fTrackPos);
297 }
298 return true;
299 }
300
OnScroll(CFWL_EventScroll::Code dwCode,float fPos)301 bool CFWL_ScrollBar::OnScroll(CFWL_EventScroll::Code dwCode, float fPos) {
302 CFWL_EventScroll ev(this, dwCode, fPos);
303 DispatchEvent(&ev);
304 return true;
305 }
306
OnProcessMessage(CFWL_Message * pMessage)307 void CFWL_ScrollBar::OnProcessMessage(CFWL_Message* pMessage) {
308 CFWL_Message::Type type = pMessage->GetType();
309 if (type == CFWL_Message::Type::kMouse) {
310 CFWL_MessageMouse* pMsg = static_cast<CFWL_MessageMouse*>(pMessage);
311 switch (pMsg->m_dwCmd) {
312 case CFWL_MessageMouse::MouseCommand::kLeftButtonDown:
313 OnLButtonDown(pMsg->m_pos);
314 break;
315 case CFWL_MessageMouse::MouseCommand::kLeftButtonUp:
316 OnLButtonUp(pMsg->m_pos);
317 break;
318 case CFWL_MessageMouse::MouseCommand::kMove:
319 OnMouseMove(pMsg->m_pos);
320 break;
321 case CFWL_MessageMouse::MouseCommand::kLeave:
322 OnMouseLeave();
323 break;
324 default:
325 break;
326 }
327 } else if (type == CFWL_Message::Type::kMouseWheel) {
328 auto* pMsg = static_cast<CFWL_MessageMouseWheel*>(pMessage);
329 OnMouseWheel(pMsg->delta());
330 }
331 }
332
OnDrawWidget(CFGAS_GEGraphics * pGraphics,const CFX_Matrix & matrix)333 void CFWL_ScrollBar::OnDrawWidget(CFGAS_GEGraphics* pGraphics,
334 const CFX_Matrix& matrix) {
335 DrawWidget(pGraphics, matrix);
336 }
337
OnLButtonDown(const CFX_PointF & point)338 void CFWL_ScrollBar::OnLButtonDown(const CFX_PointF& point) {
339 if (!IsEnabled())
340 return;
341
342 m_bMouseDown = true;
343 SetGrab(true);
344
345 m_cpTrackPoint = point;
346 m_fLastTrackPos = m_fTrackPos;
347 if (m_MinBtnRect.Contains(point))
348 DoMouseDown(0, m_MinBtnRect, &m_iMinButtonState, point);
349 else if (m_ThumbRect.Contains(point))
350 DoMouseDown(1, m_ThumbRect, &m_iThumbButtonState, point);
351 else if (m_MaxBtnRect.Contains(point))
352 DoMouseDown(2, m_MaxBtnRect, &m_iMaxButtonState, point);
353 else if (m_MinTrackRect.Contains(point))
354 DoMouseDown(3, m_MinTrackRect, &m_iMinTrackState, point);
355 else
356 DoMouseDown(4, m_MaxTrackRect, &m_iMaxTrackState, point);
357
358 if (!SendEvent()) {
359 m_pTimer = std::make_unique<CFX_Timer>(GetFWLApp()->GetTimerHandler(), this,
360 kScrollbarElapsedMsecs);
361 }
362 }
363
OnLButtonUp(const CFX_PointF & point)364 void CFWL_ScrollBar::OnLButtonUp(const CFX_PointF& point) {
365 m_pTimer.reset();
366 m_bMouseDown = false;
367 DoMouseUp(0, m_MinBtnRect, &m_iMinButtonState, point);
368 DoMouseUp(1, m_ThumbRect, &m_iThumbButtonState, point);
369 DoMouseUp(2, m_MaxBtnRect, &m_iMaxButtonState, point);
370 DoMouseUp(3, m_MinTrackRect, &m_iMinTrackState, point);
371 DoMouseUp(4, m_MaxTrackRect, &m_iMaxTrackState, point);
372 SetGrab(false);
373 }
374
OnMouseMove(const CFX_PointF & point)375 void CFWL_ScrollBar::OnMouseMove(const CFX_PointF& point) {
376 DoMouseMove(0, m_MinBtnRect, &m_iMinButtonState, point);
377 DoMouseMove(1, m_ThumbRect, &m_iThumbButtonState, point);
378 DoMouseMove(2, m_MaxBtnRect, &m_iMaxButtonState, point);
379 DoMouseMove(3, m_MinTrackRect, &m_iMinTrackState, point);
380 DoMouseMove(4, m_MaxTrackRect, &m_iMaxTrackState, point);
381 }
382
OnMouseLeave()383 void CFWL_ScrollBar::OnMouseLeave() {
384 DoMouseLeave(0, m_MinBtnRect, &m_iMinButtonState);
385 DoMouseLeave(1, m_ThumbRect, &m_iThumbButtonState);
386 DoMouseLeave(2, m_MaxBtnRect, &m_iMaxButtonState);
387 DoMouseLeave(3, m_MinTrackRect, &m_iMinTrackState);
388 DoMouseLeave(4, m_MaxTrackRect, &m_iMaxTrackState);
389 }
390
OnMouseWheel(const CFX_Vector & delta)391 void CFWL_ScrollBar::OnMouseWheel(const CFX_Vector& delta) {
392 m_iMouseWheel = delta.y;
393 SendEvent();
394 m_iMouseWheel = 0;
395 }
396
DoMouseDown(int32_t iItem,const CFX_RectF & rtItem,CFWL_PartState * pState,const CFX_PointF & point)397 void CFWL_ScrollBar::DoMouseDown(int32_t iItem,
398 const CFX_RectF& rtItem,
399 CFWL_PartState* pState,
400 const CFX_PointF& point) {
401 if (!rtItem.Contains(point))
402 return;
403 if (*pState == CFWL_PartState::kPressed)
404 return;
405
406 *pState = CFWL_PartState::kPressed;
407 RepaintRect(rtItem);
408 }
409
DoMouseUp(int32_t iItem,const CFX_RectF & rtItem,CFWL_PartState * pState,const CFX_PointF & point)410 void CFWL_ScrollBar::DoMouseUp(int32_t iItem,
411 const CFX_RectF& rtItem,
412 CFWL_PartState* pState,
413 const CFX_PointF& point) {
414 CFWL_PartState iNewState = rtItem.Contains(point) ? CFWL_PartState::kHovered
415 : CFWL_PartState::kNormal;
416 if (*pState == iNewState)
417 return;
418
419 *pState = iNewState;
420 RepaintRect(rtItem);
421 OnScroll(CFWL_EventScroll::Code::EndScroll, m_fTrackPos);
422 }
423
DoMouseMove(int32_t iItem,const CFX_RectF & rtItem,CFWL_PartState * pState,const CFX_PointF & point)424 void CFWL_ScrollBar::DoMouseMove(int32_t iItem,
425 const CFX_RectF& rtItem,
426 CFWL_PartState* pState,
427 const CFX_PointF& point) {
428 if (!m_bMouseDown) {
429 CFWL_PartState iNewState = rtItem.Contains(point) ? CFWL_PartState::kHovered
430 : CFWL_PartState::kNormal;
431 if (*pState == iNewState)
432 return;
433
434 *pState = iNewState;
435 RepaintRect(rtItem);
436 } else if ((2 == iItem) &&
437 (m_iThumbButtonState == CFWL_PartState::kPressed)) {
438 m_fTrackPos = GetTrackPointPos(point);
439 OnScroll(CFWL_EventScroll::Code::TrackPos, m_fTrackPos);
440 }
441 }
442
DoMouseLeave(int32_t iItem,const CFX_RectF & rtItem,CFWL_PartState * pState)443 void CFWL_ScrollBar::DoMouseLeave(int32_t iItem,
444 const CFX_RectF& rtItem,
445 CFWL_PartState* pState) {
446 if (*pState == CFWL_PartState::kNormal)
447 return;
448
449 *pState = CFWL_PartState::kNormal;
450 RepaintRect(rtItem);
451 }
452
DoMouseHover(int32_t iItem,const CFX_RectF & rtItem,CFWL_PartState * pState)453 void CFWL_ScrollBar::DoMouseHover(int32_t iItem,
454 const CFX_RectF& rtItem,
455 CFWL_PartState* pState) {
456 if (*pState == CFWL_PartState::kHovered)
457 return;
458
459 *pState = CFWL_PartState::kHovered;
460 RepaintRect(rtItem);
461 }
462
OnTimerFired()463 void CFWL_ScrollBar::OnTimerFired() {
464 m_pTimer.reset();
465 if (!SendEvent()) {
466 m_pTimer =
467 std::make_unique<CFX_Timer>(GetFWLApp()->GetTimerHandler(), this, 0);
468 }
469 }
470
471 } // namespace pdfium
472