office-gobmx/include/vcl/InterimItemWindow.hxx
Patrick Luby 8339bb40b2 Related: tdf#155266 Eliminate delayed scrollbar redrawing when swiping
By default, the layout idle timer in the InterimWindowItem
class is set to TaskPriority::RESIZE. That is too high of
a priority as it appears that other timers are drawing
after the scrollbar has been redrawn.

As a result, when swiping, the content moves fluidly but
the scrollbar thumb does not move until after swiping
stops or pauses. Then, after a short lag, the scrollbar
thumb finally "jumps" to the expected position.

So, to fix this scrollbar "stickiness" when swiping,
setting the priority to TaskPriority::POST_PAINT causes
the scrollbar to be redrawn after any competing timers.

Change-Id: I8c0772fc40ddc690ee59c6267c1c50971f4ff238
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/161184
Tested-by: Jenkins
Reviewed-by: Michael Weghorn <m.weghorn@posteo.de>
Reviewed-by: Patrick Luby <plubius@libreoffice.org>
2023-12-22 21:28:21 +01:00

78 lines
2.9 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
* 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/.
*/
#pragma once
#include <vcl/dllapi.h>
#include <vcl/ctrl.hxx>
#include <vcl/idle.hxx>
#include <vcl/weld.hxx>
class VCL_DLLPUBLIC InterimItemWindow : public Control
{
public:
virtual ~InterimItemWindow() override;
virtual void dispose() override;
virtual void Resize() override;
virtual Size GetOptimalSize() const override;
// throw away cached size request of child so GetOptimalSize will
// fetch it anew
void InvalidateChildSizeCache();
virtual void StateChanged(StateChangedType nStateChange) override;
virtual void queue_resize(StateChangedType eReason = StateChangedType::Layout) override;
virtual void GetFocus() override;
bool ControlHasFocus() const;
virtual void Draw(OutputDevice* pDevice, const Point& rPos,
SystemTextColorFlags nFlags) override;
void SetPriority(TaskPriority nPriority);
protected:
// bAllowCycleFocusOut of true allows focus to be moved out of the Control
// via tab key into a parent window or sibling window, false means focus
// remains inside the InterimItemWindow and cycles back to the first child
// of this control on reaching pass the last child. This is suitable when
// the Control is the toplevel control and has no siblings or parent
InterimItemWindow(vcl::Window* pParent, const OUString& rUIXMLDescription, const OUString& rID,
bool bAllowCycleFocusOut = true, sal_uInt64 nLOKWindowId = 0);
void InitControlBase(weld::Widget* pWidget);
// pass keystrokes from our child window through this to handle focus changes correctly
// returns true if keystroke is consumed
bool ChildKeyInput(const KeyEvent& rKEvt);
virtual void Layout();
// unclip a "SysObj" which is a native window element hosted in a vcl::Window
// if the SysObj is logically "visible" in the vcl::Window::IsVisible sense but
// is partially or wholly clipped out due to being overlapped or scrolled out
// of view. The clip state is flagged as dirty after this and vcl will restore
// the clip state the next time it evaluates the clip status
void UnclipVisibleSysObj();
std::unique_ptr<weld::Builder> m_xBuilder;
VclPtr<vcl::Window> m_xVclContentArea;
std::unique_ptr<weld::Container> m_xContainer;
weld::Widget* m_pWidget;
private:
Idle m_aLayoutIdle;
void StartIdleLayout();
DECL_DLLPRIVATE_LINK(DoLayout, Timer*, void);
virtual void ImplPaintToDevice(::OutputDevice* pTargetOutDev, const Point& rPos) override;
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */