minetest/src/gui/guiScrollContainer.cpp
SmallJoker 13f533d490
scrollcontainer: Add automatic scrollbar calculation (#14623)
New parameter 'content padding'. When specified, the scrollbar
max value is calculated automatically. This aims to reduce manual
calculation functions.
2024-10-08 21:45:27 +02:00

126 lines
3.9 KiB
C++

/*
Minetest
Copyright (C) 2020 DS
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include "guiScrollContainer.h"
GUIScrollContainer::GUIScrollContainer(gui::IGUIEnvironment *env,
gui::IGUIElement *parent, s32 id, const core::rect<s32> &rectangle,
const std::string &orientation, f32 scrollfactor) :
gui::IGUIElement(gui::EGUIET_ELEMENT, env, parent, id, rectangle),
m_scrollbar(nullptr), m_scrollfactor(scrollfactor)
{
if (orientation == "vertical")
m_orientation = VERTICAL;
else if (orientation == "horizontal")
m_orientation = HORIZONTAL;
else
m_orientation = UNDEFINED;
}
bool GUIScrollContainer::OnEvent(const SEvent &event)
{
if (event.EventType == EET_MOUSE_INPUT_EVENT &&
event.MouseInput.Event == EMIE_MOUSE_WHEEL &&
!event.MouseInput.isLeftPressed() && m_scrollbar) {
Environment->setFocus(m_scrollbar);
bool retval = m_scrollbar->OnEvent(event);
// a hacky fix for updating the hovering and co.
IGUIElement *hovered_elem = getElementFromPoint(core::position2d<s32>(
event.MouseInput.X, event.MouseInput.Y));
SEvent mov_event = event;
mov_event.MouseInput.Event = EMIE_MOUSE_MOVED;
Environment->postEventFromUser(mov_event);
if (hovered_elem)
hovered_elem->OnEvent(mov_event);
return retval;
}
return IGUIElement::OnEvent(event);
}
void GUIScrollContainer::draw()
{
if (isVisible()) {
for (auto child : Children)
if (child->isNotClipped() ||
AbsoluteClippingRect.isRectCollided(
child->getAbsolutePosition()))
child->draw();
}
}
void GUIScrollContainer::setScrollBar(GUIScrollBar *scrollbar)
{
m_scrollbar = scrollbar;
if (m_scrollbar && m_content_padding_px.has_value() && m_scrollfactor != 0.0f) {
// Set the scrollbar max value based on the content size.
// Get content size based on elements
core::rect<s32> size;
for (gui::IGUIElement *e : Children) {
core::rect<s32> abs_rect = e->getAbsolutePosition();
size.addInternalPoint(abs_rect.LowerRightCorner);
}
s32 visible_content_px = (
m_orientation == VERTICAL
? AbsoluteClippingRect.getHeight()
: AbsoluteClippingRect.getWidth()
);
s32 total_content_px = *m_content_padding_px + (
m_orientation == VERTICAL
? (size.LowerRightCorner.Y - AbsoluteClippingRect.UpperLeftCorner.Y)
: (size.LowerRightCorner.X - AbsoluteClippingRect.UpperLeftCorner.X)
);
s32 hidden_content_px = std::max<s32>(0, total_content_px - visible_content_px);
m_scrollbar->setMin(0);
m_scrollbar->setMax(std::ceil(hidden_content_px / std::fabs(m_scrollfactor)));
// Note: generally, the scrollbar has the same size as the scroll container.
// However, in case it isn't, proportional adjustments are needed.
s32 scrollbar_px = (
m_scrollbar->isHorizontal()
? m_scrollbar->getRelativePosition().getWidth()
: m_scrollbar->getRelativePosition().getHeight()
);
m_scrollbar->setPageSize((total_content_px * scrollbar_px) / visible_content_px);
}
updateScrolling();
}
void GUIScrollContainer::updateScrolling()
{
s32 pos = m_scrollbar->getPos();
core::rect<s32> rect = getRelativePosition();
if (m_orientation == VERTICAL)
rect.UpperLeftCorner.Y = pos * m_scrollfactor;
else if (m_orientation == HORIZONTAL)
rect.UpperLeftCorner.X = pos * m_scrollfactor;
setRelativePosition(rect);
}