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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
|
/* -*- 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/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include "DeckLayouter.hxx"
#include <sfx2/sidebar/Theme.hxx>
#include "Panel.hxx"
#include "PanelTitleBar.hxx"
#include "Deck.hxx"
#include <vcl/window.hxx>
#include <vcl/scrbar.hxx>
using namespace css;
using namespace css::uno;
namespace sfx2 { namespace sidebar {
namespace {
static const sal_Int32 MinimalPanelHeight (25);
enum LayoutMode
{
MinimumOrLarger,
PreferredOrLarger,
Preferred
};
class LayoutItem
{
public:
SharedPanel mpPanel;
css::ui::LayoutSize maLayoutSize;
sal_Int32 mnDistributedHeight;
sal_Int32 mnWeight;
sal_Int32 mnPanelIndex;
bool mbShowTitleBar;
LayoutItem (void)
: mpPanel(),maLayoutSize(0,0,0),mnDistributedHeight(0),mnWeight(0),mnPanelIndex(0),mbShowTitleBar(true)
{}
};
Rectangle LayoutPanels (
const Rectangle aContentArea,
sal_Int32& rMinimalWidth,
::std::vector<LayoutItem>& rLayoutItems,
vcl::Window& rScrollClipWindow,
vcl::Window& rScrollContainer,
ScrollBar& pVerticalScrollBar,
const bool bShowVerticalScrollBar);
void GetRequestedSizes (
::std::vector<LayoutItem>& rLayoutItem,
sal_Int32& rAvailableHeight,
sal_Int32& rMinimalWidth,
const Rectangle& rContentBox);
void DistributeHeights (
::std::vector<LayoutItem>& rLayoutItems,
const sal_Int32 nHeightToDistribute,
const sal_Int32 nContainerHeight,
const bool bMinimumHeightIsBase);
sal_Int32 PlacePanels (
::std::vector<LayoutItem>& rLayoutItems,
const sal_Int32 nWidth,
const LayoutMode eMode,
vcl::Window& rScrollContainer);
Rectangle PlaceDeckTitle (
vcl::Window& rTittleBar,
const Rectangle& rAvailableSpace);
Rectangle PlaceVerticalScrollBar (
ScrollBar& rVerticalScrollBar,
const Rectangle& rAvailableSpace,
const bool bShowVerticalScrollBar);
void SetupVerticalScrollBar(
ScrollBar& rVerticalScrollBar,
const sal_Int32 nContentHeight,
const sal_Int32 nVisibleHeight);
void UpdateFiller (
vcl::Window& rFiller,
const Rectangle& rBox);
}
#define IterateLayoutItems(iterator_name,container) \
for(::std::vector<LayoutItem>::iterator \
iterator_name(container.begin()), \
iEnd(container.end()); \
iterator_name!=iEnd; \
++iterator_name)
void DeckLayouter::LayoutDeck (
const Rectangle aContentArea,
sal_Int32& rMinimalWidth,
SharedPanelContainer& rPanels,
vcl::Window& rDeckTitleBar,
vcl::Window& rScrollClipWindow,
vcl::Window& rScrollContainer,
vcl::Window& rFiller,
ScrollBar& rVerticalScrollBar)
{
if (aContentArea.GetWidth()<=0 || aContentArea.GetHeight()<=0)
return;
Rectangle aBox (PlaceDeckTitle(rDeckTitleBar, aContentArea));
if ( ! rPanels.empty())
{
// Prepare the layout item container.
::std::vector<LayoutItem> aLayoutItems;
aLayoutItems.resize(rPanels.size());
for (sal_Int32 nIndex(0),nCount(rPanels.size()); nIndex<nCount; ++nIndex)
{
aLayoutItems[nIndex].mpPanel = rPanels[nIndex];
aLayoutItems[nIndex].mnPanelIndex = nIndex;
}
aBox = LayoutPanels(
aBox,
rMinimalWidth,
aLayoutItems,
rScrollClipWindow,
rScrollContainer,
rVerticalScrollBar,
false);
}
UpdateFiller(rFiller, aBox);
}
namespace {
Rectangle LayoutPanels (
const Rectangle aContentArea,
sal_Int32& rMinimalWidth,
::std::vector<LayoutItem>& rLayoutItems,
vcl::Window& rScrollClipWindow,
vcl::Window& rScrollContainer,
ScrollBar& rVerticalScrollBar,
const bool bShowVerticalScrollBar)
{
Rectangle aBox (PlaceVerticalScrollBar(rVerticalScrollBar, aContentArea, bShowVerticalScrollBar));
const sal_Int32 nWidth (aBox.GetWidth());
// Get the requested heights of the panels and the available
// height that is left when all panel titles and separators are
// taken into account.
sal_Int32 nAvailableHeight (aBox.GetHeight());
GetRequestedSizes(rLayoutItems, nAvailableHeight, rMinimalWidth, aBox);
const sal_Int32 nTotalDecorationHeight (aBox.GetHeight() - nAvailableHeight);
// Analyze the requested heights.
// Determine the height that is available for panel content
// and count the different layouts.
sal_Int32 nTotalPreferredHeight (0);
sal_Int32 nTotalMinimumHeight (0);
IterateLayoutItems(iItem,rLayoutItems)
{
nTotalMinimumHeight += iItem->maLayoutSize.Minimum;
nTotalPreferredHeight += iItem->maLayoutSize.Preferred;
}
if (nTotalMinimumHeight > nAvailableHeight
&& ! bShowVerticalScrollBar)
{
// Not enough space, even when all panels are shrunk to their
// minimum height.
// Show a vertical scrollbar.
return LayoutPanels(
aContentArea,
rMinimalWidth,
rLayoutItems,
rScrollClipWindow,
rScrollContainer,
rVerticalScrollBar,
true);
}
// We are now in one of three modes.
// - The preferred height fits into the available size:
// Use the preferred size, distribute the remaining height bei
// enlarging panels.
// - The total minimum height fits into the available size:
// Use the minimum size, distribute the remaining height bei
// enlarging panels.
// - The total minimum height does not fit into the available
// size:
// Use the unmodified preferred height for all panels.
LayoutMode eMode (MinimumOrLarger);
if (bShowVerticalScrollBar)
eMode = Preferred;
else if (nTotalPreferredHeight <= nAvailableHeight)
eMode = PreferredOrLarger;
else
eMode = MinimumOrLarger;
if (eMode != Preferred)
{
const sal_Int32 nTotalHeight (eMode==MinimumOrLarger ? nTotalMinimumHeight : nTotalPreferredHeight);
DistributeHeights(
rLayoutItems,
nAvailableHeight-nTotalHeight,
aBox.GetHeight(),
eMode==MinimumOrLarger);
}
// Set position and size of the mpScrollClipWindow to the available
// size. Its child, the mpScrollContainer, may have a bigger
// height.
rScrollClipWindow.setPosSizePixel(aBox.Left(), aBox.Top(), aBox.GetWidth(), aBox.GetHeight());
const sal_Int32 nContentHeight (
eMode==Preferred
? nTotalPreferredHeight + nTotalDecorationHeight
: aBox.GetHeight());
sal_Int32 nY = rVerticalScrollBar.GetThumbPos();
if (nContentHeight-nY < aBox.GetHeight())
nY = nContentHeight-aBox.GetHeight();
if (nY < 0)
nY = 0;
rScrollContainer.setPosSizePixel(
0,
-nY,
nWidth,
nContentHeight);
if (bShowVerticalScrollBar)
SetupVerticalScrollBar(rVerticalScrollBar, nContentHeight, aBox.GetHeight());
const sal_Int32 nUsedHeight (PlacePanels(rLayoutItems, nWidth, eMode, rScrollContainer));
aBox.Top() += nUsedHeight;
return aBox;
}
sal_Int32 PlacePanels (
::std::vector<LayoutItem>& rLayoutItems,
const sal_Int32 nWidth,
const LayoutMode eMode,
vcl::Window& rScrollContainer)
{
::std::vector<sal_Int32> aSeparators;
const sal_Int32 nDeckSeparatorHeight (Theme::GetInteger(Theme::Int_DeckSeparatorHeight));
sal_Int32 nY (0);
// Assign heights and places.
IterateLayoutItems(iItem,rLayoutItems)
{
if (iItem->mpPanel == 0)
continue;
Panel& rPanel (*iItem->mpPanel);
// Separator above the panel title bar.
aSeparators.push_back(nY);
nY += nDeckSeparatorHeight;
// Place the title bar.
PanelTitleBar* pTitleBar = rPanel.GetTitleBar();
if (pTitleBar != NULL)
{
const sal_Int32 nPanelTitleBarHeight (Theme::GetInteger(Theme::Int_PanelTitleBarHeight) * rPanel.GetDPIScaleFactor());
if (iItem->mbShowTitleBar)
{
pTitleBar->setPosSizePixel(0, nY, nWidth, nPanelTitleBarHeight);
pTitleBar->Show();
nY += nPanelTitleBarHeight;
}
else
{
pTitleBar->Hide();
}
}
if (rPanel.IsExpanded())
{
rPanel.Show();
// Determine the height of the panel depending on layout
// mode and distributed heights.
sal_Int32 nPanelHeight (0);
switch(eMode)
{
case MinimumOrLarger:
nPanelHeight = iItem->maLayoutSize.Minimum + iItem->mnDistributedHeight;
break;
case PreferredOrLarger:
nPanelHeight = iItem->maLayoutSize.Preferred + iItem->mnDistributedHeight;
break;
case Preferred:
nPanelHeight = iItem->maLayoutSize.Preferred;
break;
default:
OSL_ASSERT(false);
break;
}
// Place the panel.
rPanel.setPosSizePixel(0, nY, nWidth, nPanelHeight);
rPanel.Invalidate();
nY += nPanelHeight;
}
else
{
rPanel.Hide();
// Add a separator below the collapsed panel, if it is the
// last panel in the deck.
if (iItem == rLayoutItems.end()-1)
{
// Separator below the panel title bar.
aSeparators.push_back(nY);
nY += nDeckSeparatorHeight;
}
}
}
Deck::ScrollContainerWindow* pScrollContainerWindow
= dynamic_cast<Deck::ScrollContainerWindow*>(&rScrollContainer);
if (pScrollContainerWindow != NULL)
pScrollContainerWindow->SetSeparators(aSeparators);
return nY;
}
void GetRequestedSizes (
::std::vector<LayoutItem>& rLayoutItems,
sal_Int32& rAvailableHeight,
sal_Int32& rMinimalWidth,
const Rectangle& rContentBox)
{
rAvailableHeight = rContentBox.GetHeight();
const sal_Int32 nDeckSeparatorHeight (Theme::GetInteger(Theme::Int_DeckSeparatorHeight));
IterateLayoutItems(iItem,rLayoutItems)
{
ui::LayoutSize aLayoutSize (ui::LayoutSize(0,0,0));
if (iItem->mpPanel != 0)
{
if (rLayoutItems.size() == 1
&& iItem->mpPanel->IsTitleBarOptional())
{
// There is only one panel and its title bar is
// optional => hide it.
rAvailableHeight -= nDeckSeparatorHeight;
iItem->mbShowTitleBar = false;
}
else
{
// Show the title bar and a separator above and below
// the title bar.
const sal_Int32 nPanelTitleBarHeight (Theme::GetInteger(Theme::Int_PanelTitleBarHeight) * iItem->mpPanel->GetDPIScaleFactor());
rAvailableHeight -= nPanelTitleBarHeight;
rAvailableHeight -= nDeckSeparatorHeight;
}
if (iItem->mpPanel->IsExpanded())
{
Reference<ui::XSidebarPanel> xPanel (iItem->mpPanel->GetPanelComponent());
if (xPanel.is())
{
aLayoutSize = xPanel->getHeightForWidth(rContentBox.GetWidth());
sal_Int32 nWidth = xPanel->getMinimalWidth();
if (nWidth > rMinimalWidth)
rMinimalWidth = nWidth;
}
else
aLayoutSize = ui::LayoutSize(MinimalPanelHeight, -1, 0);
}
}
iItem->maLayoutSize = aLayoutSize;
}
}
void DistributeHeights (
::std::vector<LayoutItem>& rLayoutItems,
const sal_Int32 nHeightToDistribute,
const sal_Int32 nContainerHeight,
const bool bMinimumHeightIsBase)
{
if (nHeightToDistribute <= 0)
return;
sal_Int32 nRemainingHeightToDistribute (nHeightToDistribute);
// Compute the weights as difference between panel base height
// (either its minimum or preferred height) and the container height.
sal_Int32 nTotalWeight (0);
sal_Int32 nNoMaximumCount (0);
IterateLayoutItems(iItem,rLayoutItems)
{
if (iItem->maLayoutSize.Maximum == 0)
continue;
if (iItem->maLayoutSize.Maximum < 0)
++nNoMaximumCount;
const sal_Int32 nBaseHeight (
bMinimumHeightIsBase
? iItem->maLayoutSize.Minimum
: iItem->maLayoutSize.Preferred);
if (nBaseHeight < nContainerHeight)
{
iItem->mnWeight = nContainerHeight - nBaseHeight;
nTotalWeight += iItem->mnWeight;
}
}
if (nTotalWeight == 0)
return;
// First pass of height distribution.
IterateLayoutItems(iItem,rLayoutItems)
{
const sal_Int32 nBaseHeight (
bMinimumHeightIsBase
? iItem->maLayoutSize.Minimum
: iItem->maLayoutSize.Preferred);
sal_Int32 nDistributedHeight (iItem->mnWeight * nHeightToDistribute / nTotalWeight);
if (nBaseHeight+nDistributedHeight > iItem->maLayoutSize.Maximum
&& iItem->maLayoutSize.Maximum >= 0)
{
nDistributedHeight = ::std::max<sal_Int32>(0,iItem->maLayoutSize.Maximum - nBaseHeight);
}
iItem->mnDistributedHeight = nDistributedHeight;
nRemainingHeightToDistribute -= nDistributedHeight;
}
if (nRemainingHeightToDistribute == 0)
return;
OSL_ASSERT(nRemainingHeightToDistribute > 0);
// It is possible that not all of the height could be distributed
// because of Maximum heights being smaller than expected.
// Distribute the remaining height between the panels that have no
// Maximum (ie Maximum==-1).
if (nNoMaximumCount == 0)
{
// There are no panels with unrestricted height.
return;
}
const sal_Int32 nAdditionalHeightPerPanel (nRemainingHeightToDistribute / nNoMaximumCount);
// Handle rounding error.
sal_Int32 nAdditionalHeightForFirstPanel (nRemainingHeightToDistribute
- nNoMaximumCount*nAdditionalHeightPerPanel);
IterateLayoutItems(iItem,rLayoutItems)
{
if (iItem->maLayoutSize.Maximum < 0)
{
iItem->mnDistributedHeight += nAdditionalHeightPerPanel + nAdditionalHeightForFirstPanel;
nRemainingHeightToDistribute -= nAdditionalHeightPerPanel + nAdditionalHeightForFirstPanel;
}
}
OSL_ASSERT(nRemainingHeightToDistribute==0);
}
Rectangle PlaceDeckTitle (
vcl::Window& rDeckTitleBar,
const Rectangle& rAvailableSpace)
{
if (static_cast<DockingWindow*>(rDeckTitleBar.GetParent()->GetParent())->IsFloatingMode())
{
// When the side bar is undocked then the outer system window displays the deck title.
rDeckTitleBar.Hide();
return rAvailableSpace;
}
else
{
const sal_Int32 nDeckTitleBarHeight (Theme::GetInteger(Theme::Int_DeckTitleBarHeight) * rDeckTitleBar.GetDPIScaleFactor());
rDeckTitleBar.setPosSizePixel(
rAvailableSpace.Left(),
rAvailableSpace.Top(),
rAvailableSpace.GetWidth(),
nDeckTitleBarHeight);
rDeckTitleBar.Show();
return Rectangle(
rAvailableSpace.Left(),
rAvailableSpace.Top() + nDeckTitleBarHeight,
rAvailableSpace.Right(),
rAvailableSpace.Bottom());
}
}
Rectangle PlaceVerticalScrollBar (
ScrollBar& rVerticalScrollBar,
const Rectangle& rAvailableSpace,
const bool bShowVerticalScrollBar)
{
if (bShowVerticalScrollBar)
{
const sal_Int32 nScrollBarWidth (rVerticalScrollBar.GetSizePixel().Width());
rVerticalScrollBar.setPosSizePixel(
rAvailableSpace.Right() - nScrollBarWidth + 1,
rAvailableSpace.Top(),
nScrollBarWidth,
rAvailableSpace.GetHeight());
rVerticalScrollBar.Show();
return Rectangle(
rAvailableSpace.Left(),
rAvailableSpace.Top(),
rAvailableSpace.Right() - nScrollBarWidth,
rAvailableSpace.Bottom());
}
else
{
rVerticalScrollBar.Hide();
return rAvailableSpace;
}
}
void SetupVerticalScrollBar(
ScrollBar& rVerticalScrollBar,
const sal_Int32 nContentHeight,
const sal_Int32 nVisibleHeight)
{
OSL_ASSERT(nContentHeight > nVisibleHeight);
rVerticalScrollBar.SetRangeMin(0);
rVerticalScrollBar.SetRangeMax(nContentHeight-1);
rVerticalScrollBar.SetVisibleSize(nVisibleHeight);
}
void UpdateFiller (
vcl::Window& rFiller,
const Rectangle& rBox)
{
if (rBox.GetHeight() > 0)
{
// Show the filler.
rFiller.SetBackground(Theme::GetPaint(Theme::Paint_PanelBackground).GetWallpaper());
rFiller.SetPosSizePixel(rBox.TopLeft(), rBox.GetSize());
rFiller.Show();
}
else
{
// Hide the filler.
rFiller.Hide();
}
}
}
} } // end of namespace sfx2::sidebar
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|