pandemonium_engine/modules/web/html/paginator.h

#ifndef HTML_PAGINATOR_H
#define HTML_PAGINATOR_H

/*************************************************************************/
/*  paginator.h                                                          */
/*************************************************************************/
/*                         This file is part of:                         */
/*                          PANDEMONIUM ENGINE                           */
/*             https://github.com/Relintai/pandemonium_engine            */
/*************************************************************************/
/* Copyright (c) 2022-present Péter Magyar.                              */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md).   */
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur.                 */
/*                                                                       */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the       */
/* "Software"), to deal in the Software without restriction, including   */
/* without limitation the rights to use, copy, modify, merge, publish,   */
/* distribute, sublicense, and/or sell copies of the Software, and to    */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions:                                             */
/*                                                                       */
/* The above copyright notice and this permission notice shall be        */
/* included in all copies or substantial portions of the Software.       */
/*                                                                       */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
/*************************************************************************/

#include "core/containers/vector.h"
#include "core/string/ustring.h"

#include "core/object/reference.h"

class HTMLPaginator : public Reference {
	GDCLASS(HTMLPaginator, Reference);

public:
	//settint the item count will update page count and vice versa
	int get_item_count() const;
	void set_item_count(const int val);

	int get_page_count() const;
	void set_page_count(const int val);

	int get_max_visible_links() const;
	void set_max_visible_links(const int val);

	String get_base_url();
	void set_base_url(const String &val);

	PoolStringArray get_links();
	void set_links(const PoolStringArray &val);

	bool get_use_links_array();
	void set_use_links_array(const bool &val);

	bool get_hide_if_one_page();
	void set_hide_if_one_page(const bool &val);

	String get_class_main_ul();
	void set_class_main_ul(const String &val);

	String get_class_enabled_li();
	void set_class_enabled_li(const String &val);

	String get_class_disabled_li();
	void set_class_disabled_li(const String &val);

	String get_text_next_link();
	void set_text_next_link(const String &val);

	String get_text_prev_link();
	void set_text_prev_link(const String &val);

	Ref<HTMLPaginator> get_renderer();
	void set_renderer(const Ref<HTMLPaginator> &val);

	void start();
	String next();
	String get_current();

	String get_pagination_for_indx(const int page_index);
	String get_pagination_for_num(const int page_num);

	String render_indexed(Ref<HTMLPaginator> target, const int page_index);
	String render_links(Ref<HTMLPaginator> target, const int page_index);

	virtual String _render_indexed(Ref<HTMLPaginator> target, const int page_index);
	virtual String _render_links(Ref<HTMLPaginator> target, const int page_index);

	//Old methods for the time being
	static String get_pagination_old(const String &base_url, const int max, const int current_index, const int max_visible_links = 10);
	static String get_pagination_links_old(const String &base_url, const Vector<String> &links, const int current_index, const int max_visible_links = 10);

	HTMLPaginator();
	~HTMLPaginator();

protected:
	static void _bind_methods();

	String base_url;
	PoolStringArray links;

	bool use_links_array;
	bool hide_if_one_page;

	String class_main_ul;
	String class_enabled_li;
	String class_disabled_li;
	String text_next_link;
	String text_prev_link;

	Ref<HTMLPaginator> renderer;

	int _item_count;
	int _page_count;
	int _max_visible_links;
	int _current_page_index;
};

#endif