add content_wrapping

Author: igagis

src/ruis/util/content_wrapping.cpp

@@ -0,0 +1,28 @@
+/*
+ruis - GUI framework
+
+Copyright (C) 2012-2025  Ivan Gagis <[email protected]>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/* ================ LICENSE END ================ */
+
+#include "content_wrapping.hpp"
+
+using namespace ruis;
+
+content_wrapping::content_wrapping(utki::shared_ref<container> content_container) :
+	content_container(std::move(content_container))
+{}

src/ruis/util/content_wrapping.hpp

@@ -0,0 +1,62 @@
+/*
+ruis - GUI framework
+
+Copyright (C) 2012-2025  Ivan Gagis <[email protected]>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 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 General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/* ================ LICENSE END ================ */
+
+#pragma once
+
+#include "../widget/container.hpp"
+
+namespace ruis {
+
+/**
+ * @brief Content wrapping widget base.
+ * The base class for widgets which are essentially containers,
+ * but enchancing functionality of simple container widget,
+ * for example, by adding padding to the contents or adding
+ * some special control widgets on top of the content.
+ */
+class content_wrapping
+{
+protected:
+	const utki::shared_ref<ruis::container> content_container;
+
+	content_wrapping(utki::shared_ref<container> content_container);
+
+public:
+	/**
+	 * @brief Get content container.
+	 * @return The content container. This is where the child widgets are stored.
+	 */
+	container& content()
+	{
+		return this->content_container.get();
+	}
+
+	/**
+	 * @brief Get content container.
+	 * @return The content container. This is where the child widgets are stored.
+	 */
+	const container& content() const
+	{
+		return this->content_container.get();
+	}
+};
+
+} // namespace ruis

src/ruis/widget/group/collapse_area.cpp

@@ -51,6 +51,17 @@ collapse_area::collapse_area(
 		std::move(params.layout_params),
 		std::move(params.widget_params)
 	),
+	content_wrapping(
+		m::container(
+			this->context,
+			// clang-format off
+			{
+				.container_params = std::move(params.container_params)
+			},
+			// clang-format on
+			std::move(contents)
+		)
+	),
 	// clang-format off
 	container(
 		this->context,
@@ -127,25 +138,16 @@ collapse_area::collapse_area(
 					)
 				}
 			),
-			m::container(this->context,
-				{
-					.widget_params{
-						.id = "ruis_content"s
-					},
-					.container_params = std::move(params.container_params)
-				},
-				std::move(contents)
-			)
+			this->content_container
 		}
 	),
 	// clang-format on
-	content_area(this->get_widget_as<container>("ruis_content")), //
 	title_v(this->get_widget_as<container>("ruis_title"))
 {
 	{
 		auto& sw = this->get_widget_as<toggle_button>("ruis_switch");
 		sw.pressed_change_handler = [this](button& tb) {
-			auto& lp = this->content_area.get_layout_params();
+			auto& lp = this->content().get_layout_params();
 			if (tb.is_pressed()) {
 				using namespace length_literals;
 				lp.dims.y() = 0_px;

src/ruis/widget/group/collapse_area.hpp

@@ -21,20 +21,17 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 #pragma once
 
+#include "../../util/content_wrapping.hpp"
 #include "../container.hpp"
-#include "../widget.hpp"
 
 namespace ruis {
 
-// TODO: derive from padding?
 // NOLINTNEXTLINE(bugprone-incorrect-enable-shared-from-this, "std::shared_from_this is public via widget")
 class collapse_area :
 	virtual public widget, //
+	public content_wrapping,
 	private container
 {
-	// TODO: use shared_ref
-	// NOLINTNEXTLINE(clang-analyzer-webkit.NoUncountedMemberChecker, "false-positive")
-	container& content_area;
 	// TODO: use shared_ref
 	// NOLINTNEXTLINE(clang-analyzer-webkit.NoUncountedMemberChecker, "false-positive")
 	container& title_v;
@@ -53,11 +50,6 @@ class collapse_area :
 		widget_list contents
 	);
 
-	container& content() noexcept
-	{
-		return this->content_area;
-	}
-
 	container& title() noexcept
 	{
 		return this->title_v;

src/ruis/widget/group/scroll_area.hpp

@@ -41,7 +41,7 @@ class scroll_area : public container
 	// offset from top left corner
 	vector2 cur_scroll_pos = vector2(0);
 
-	// cached dimensions of the invisible contnets part, which goes beyond right and bottom edge of the scroll_area
+	// cached dimensions of the invisible contents part, which goes beyond right and bottom edge of the scroll_area
 	vector2 invisible_dims;
 
 	// cached scroll factor

src/ruis/widget/group/tiling_area.cpp

@@ -155,14 +155,21 @@ tiling_area::tiling_area(
 		std::move(params.widget_params) //
 	),
 	ruis::oriented({.vertical = false}),
-	ruis::container(this->context, {}, {}),
-	content_container(
+	ruis::content_wrapping(
 		ruis::make::container(
 			this->context,
 			{},
 			std::move(children) //
 		)
 	),
+	// clang-format off
+	ruis::container(this->context,
+		{},
+		{
+			this->content_container
+		}
+	),
+	// clang-format on
 	min_tile_size(this->context.get().units.pp_to_px(minimal_tile_size_pp)),
 	dragger_size(this->context.get().units.pp_to_px(dragger_size_pp)),
 	params([&]() {
@@ -174,8 +181,7 @@ tiling_area::tiling_area(
 		return std::move(params.tiling_area_params);
 	}())
 {
-	this->ruis::container::push_back(this->content_container);
-	this->content_container.get().move_to({0, 0});
+	this->content().move_to({0, 0});
 }
 
 void tiling_area::on_lay_out()

src/ruis/widget/group/tiling_area.hpp

@@ -21,6 +21,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 #pragma once
 
+#include "../../util/content_wrapping.hpp"
 #include "../../util/oriented.hpp"
 #include "../container.hpp"
 
@@ -33,11 +34,9 @@ Common borders of the contained tiles are draggable with mouse pointer.
 class tiling_area :
 	virtual public widget, //
 	public ruis::oriented,
+	public content_wrapping,
 	private ruis::container
 {
-	// TODO: refactor: e.g. padding also has content container. Add some 'content_wrapping_widget' base class.
-	utki::shared_ref<ruis::container> content_container;
-
 public:
 	const ruis::real min_tile_size;
 	const ruis::real dragger_size;
@@ -62,16 +61,6 @@ class tiling_area :
 		ruis::widget_list children
 	);
 
-	ruis::container& content()
-	{
-		return this->content_container.get();
-	}
-
-	const ruis::container& content() const
-	{
-		return this->content_container.get();
-	}
-
 	void on_lay_out() override;
 
 	ruis::vector2 measure(const ruis::vector2& quotum) const override;

src/ruis/widget/label/padding.cpp

@@ -39,9 +39,14 @@ padding::padding(
 	all_parameters params,
 	widget_list children
 ) :
-	padding(
-		// clang-format off
-		m::container(std::move(context),
+	widget( //
+		std::move(context),
+		std::move(params.layout_params),
+		std::move(params.widget_params)
+	),
+	content_wrapping(
+		m::container(this->context,
+			// clang-format off
 			{
 				.container_params = [&](){
 					// pile layout by default
@@ -51,37 +56,20 @@ padding::padding(
 					return std::move(params.container_params);
 				}()
 			},
+			// clang-format on
 			std::move(children)
-		),
-		// clang-format on
-		std::move(params.layout_params),
-		std::move(params.widget_params),
-		std::move(params.padding_params)
-	)
-{}
-
-padding::padding(
-	utki::shared_ref<container> content_container,
-	layout_parameters layout_params,
-	widget::parameters widget_params,
-	parameters padding_params
-):
-	widget( //
-		content_container.get().context,
-		std::move(layout_params),
-		std::move(widget_params)
+		)
 	),
 	// clang-format off
 	container(
 		this->context,
 		{},
 		{
-			content_container
+			this->content_container
 		}
 	),
 	// clang-format on
-	params(std::move(padding_params)),
-	inner_content(std::move(content_container))
+	params(std::move(params.padding_params))
 {}
 
 sides<real> padding::get_min_borders() const noexcept

src/ruis/widget/label/padding.hpp

@@ -21,6 +21,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
 
 #pragma once
 
+#include "../../util/content_wrapping.hpp"
 #include "../container.hpp"
 
 namespace ruis {
@@ -30,6 +31,7 @@ namespace ruis {
 // NOLINTNEXTLINE(bugprone-incorrect-enable-shared-from-this, "false-positive")
 class padding :
 	public virtual widget, //
+	public content_wrapping,
 	protected container
 {
 public:
@@ -40,8 +42,6 @@ class padding :
 private:
 	parameters params;
 
-	utki::shared_ref<container> inner_content;
-
 public:
 	struct all_parameters {
 		layout_parameters layout_params;
@@ -56,32 +56,10 @@ class padding :
 		widget_list children
 	);
 
-private:
-	padding(
-		utki::shared_ref<container> content_container,
-		layout_parameters layout_params,
-		widget::parameters widget_params,
-		parameters padding_params
-	);
-
 public:
 	vec2 measure(const vec2& quotum) const override;
 	void on_lay_out() override;
 
-	/**
-	 * @brief Get content container.
-	 * @return The content container. This is where the child widgets are stored.
-	 */
-	container& content()
-	{
-		return this->inner_content.get();
-	}
-
-	const container& content() const
-	{
-		return this->inner_content.get();
-	}
-
 	/**
 	 * @brief Set border settings.
 	 * @param borders - border values to set.