2019-02-28 03:43:50 +03:00
|
|
|
#pragma once
|
|
|
|
|
2019-09-06 16:34:26 +03:00
|
|
|
#include <AK/String.h>
|
2019-02-28 12:57:09 +03:00
|
|
|
#include <AK/Badge.h>
|
|
|
|
#include <AK/Function.h>
|
|
|
|
#include <AK/HashTable.h>
|
2019-06-21 19:58:45 +03:00
|
|
|
#include <AK/RefCounted.h>
|
2019-02-28 03:43:50 +03:00
|
|
|
#include <LibGUI/GModelIndex.h>
|
2019-02-28 18:20:29 +03:00
|
|
|
#include <LibGUI/GVariant.h>
|
2019-07-18 11:15:00 +03:00
|
|
|
#include <LibDraw/TextAlignment.h>
|
2019-02-28 03:43:50 +03:00
|
|
|
|
2019-03-15 19:37:13 +03:00
|
|
|
class Font;
|
2019-03-23 04:04:31 +03:00
|
|
|
class GAbstractView;
|
2019-02-28 12:57:09 +03:00
|
|
|
|
2019-06-07 18:13:23 +03:00
|
|
|
enum class GSortOrder {
|
2019-05-28 12:53:16 +03:00
|
|
|
None,
|
|
|
|
Ascending,
|
|
|
|
Descending
|
|
|
|
};
|
2019-03-09 15:33:52 +03:00
|
|
|
|
2019-06-21 16:29:31 +03:00
|
|
|
class GModel : public RefCounted<GModel> {
|
2019-02-28 03:43:50 +03:00
|
|
|
public:
|
2019-02-28 13:27:04 +03:00
|
|
|
struct ColumnMetadata {
|
|
|
|
int preferred_width { 0 };
|
|
|
|
TextAlignment text_alignment { TextAlignment::CenterLeft };
|
2019-03-15 19:37:13 +03:00
|
|
|
const Font* font { nullptr };
|
2019-08-12 11:46:01 +03:00
|
|
|
enum class Sortable { False, True };
|
|
|
|
Sortable sortable { Sortable::True };
|
2019-02-28 13:27:04 +03:00
|
|
|
};
|
|
|
|
|
2019-06-07 18:13:23 +03:00
|
|
|
enum class Role {
|
2019-05-28 12:53:16 +03:00
|
|
|
Display,
|
|
|
|
Sort,
|
|
|
|
Custom,
|
|
|
|
ForegroundColor,
|
|
|
|
BackgroundColor,
|
2019-10-22 22:38:04 +03:00
|
|
|
Icon,
|
|
|
|
Font,
|
2019-05-28 12:53:16 +03:00
|
|
|
};
|
2019-03-09 16:24:34 +03:00
|
|
|
|
2019-03-23 03:42:49 +03:00
|
|
|
virtual ~GModel();
|
2019-02-28 03:43:50 +03:00
|
|
|
|
2019-03-29 05:27:03 +03:00
|
|
|
virtual int row_count(const GModelIndex& = GModelIndex()) const = 0;
|
|
|
|
virtual int column_count(const GModelIndex& = GModelIndex()) const = 0;
|
2019-05-28 12:53:16 +03:00
|
|
|
virtual String row_name(int) const { return {}; }
|
|
|
|
virtual String column_name(int) const { return {}; }
|
|
|
|
virtual ColumnMetadata column_metadata(int) const { return {}; }
|
2019-03-09 16:24:34 +03:00
|
|
|
virtual GVariant data(const GModelIndex&, Role = Role::Display) const = 0;
|
2019-02-28 03:43:50 +03:00
|
|
|
virtual void update() = 0;
|
2019-05-28 12:53:16 +03:00
|
|
|
virtual GModelIndex parent_index(const GModelIndex&) const { return {}; }
|
2019-03-29 19:03:30 +03:00
|
|
|
virtual GModelIndex index(int row, int column = 0, const GModelIndex& = GModelIndex()) const { return create_index(row, column); }
|
2019-03-29 21:48:15 +03:00
|
|
|
virtual GModelIndex sibling(int row, int column, const GModelIndex& parent) const;
|
2019-04-18 23:27:14 +03:00
|
|
|
virtual bool is_editable(const GModelIndex&) const { return false; }
|
2019-05-28 12:53:16 +03:00
|
|
|
virtual void set_data(const GModelIndex&, const GVariant&) {}
|
2019-02-28 12:20:04 +03:00
|
|
|
|
2019-03-06 21:56:47 +03:00
|
|
|
bool is_valid(const GModelIndex& index) const
|
2019-02-28 12:20:04 +03:00
|
|
|
{
|
|
|
|
return index.row() >= 0 && index.row() < row_count() && index.column() >= 0 && index.column() < column_count();
|
|
|
|
}
|
2019-02-28 12:57:09 +03:00
|
|
|
|
2019-03-09 15:33:52 +03:00
|
|
|
virtual int key_column() const { return -1; }
|
|
|
|
virtual GSortOrder sort_order() const { return GSortOrder::None; }
|
2019-05-28 12:53:16 +03:00
|
|
|
virtual void set_key_column_and_sort_order(int, GSortOrder) {}
|
2019-03-09 15:33:52 +03:00
|
|
|
|
2019-03-23 04:04:31 +03:00
|
|
|
void register_view(Badge<GAbstractView>, GAbstractView&);
|
|
|
|
void unregister_view(Badge<GAbstractView>, GAbstractView&);
|
2019-02-28 12:57:09 +03:00
|
|
|
|
2019-08-20 20:45:08 +03:00
|
|
|
Function<void()> on_update;
|
2019-03-09 15:33:52 +03:00
|
|
|
|
2019-02-28 12:57:09 +03:00
|
|
|
protected:
|
2019-03-23 03:42:49 +03:00
|
|
|
GModel();
|
2019-02-28 12:57:09 +03:00
|
|
|
|
2019-03-23 04:04:31 +03:00
|
|
|
void for_each_view(Function<void(GAbstractView&)>);
|
2019-02-28 12:57:09 +03:00
|
|
|
void did_update();
|
|
|
|
|
2019-08-18 11:14:53 +03:00
|
|
|
GModelIndex create_index(int row, int column, const void* data = nullptr) const;
|
2019-03-29 06:58:15 +03:00
|
|
|
|
2019-02-28 12:57:09 +03:00
|
|
|
private:
|
2019-03-23 04:04:31 +03:00
|
|
|
HashTable<GAbstractView*> m_views;
|
2019-02-28 03:43:50 +03:00
|
|
|
};
|
2019-03-29 16:46:53 +03:00
|
|
|
|
|
|
|
inline GModelIndex GModelIndex::parent() const
|
|
|
|
{
|
|
|
|
return m_model ? m_model->parent_index(*this) : GModelIndex();
|
|
|
|
}
|