1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/*
* This source file is part of libRocket, the HTML/CSS Interface Middleware
*
* For the latest information, see http://www.librocket.com
*
* Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
*
* 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.
*
*/
#ifndef ROCKETCONTROLSDATASOURCE_H
#define ROCKETCONTROLSDATASOURCE_H
#include "Header.h"
#include "../Core/String.h"
#include <list>
#include <map>
namespace Rocket {
namespace Controls {
class DataSourceListener;
/**
Generic object that provides a database-like interface for requesting rows from a table.
@author Robert Curry
*/
class ROCKETCONTROLS_API DataSource
{
public:
DataSource(const Rocket::Core::String& name = "");
virtual ~DataSource();
const Rocket::Core::String& GetDataSourceName();
static DataSource* GetDataSource(const Rocket::Core::String& data_source_name);
/// Fetches the contents of one row of a table within the data source.
/// @param[out] row The list of values in the table.
/// @param[in] table The name of the table to query.
/// @param[in] row_index The index of the desired row.
/// @param[in] columns The list of desired columns within the row.
virtual void GetRow(Rocket::Core::StringList& row, const Rocket::Core::String& table, int row_index, const Rocket::Core::StringList& columns) = 0;
/// Fetches the number of rows within one of this data source's tables.
/// @param[in] table The name of the table to query.
/// @return The number of rows within the specified table.
virtual int GetNumRows(const Rocket::Core::String& table) = 0;
void AttachListener(DataSourceListener* listener);
void DetachListener(DataSourceListener* listener);
virtual void* GetScriptObject() const;
static const Rocket::Core::String CHILD_SOURCE;
static const Rocket::Core::String DEPTH;
static const Rocket::Core::String NUM_CHILDREN;
protected:
/// Tells all attached listeners that one or more rows have been added to the data source.
/// @param[in] table The name of the table to have rows added to it.
/// @param[in] first_row_added The index of the first row added.
/// @param[in] num_rows_added The number of rows added (including the first row).
void NotifyRowAdd(const Rocket::Core::String& table, int first_row_added, int num_rows_added);
/// Tells all attached listeners that one or more rows have been removed from the data source.
/// @param[in] table The name of the table to have rows removed from it.
/// @param[in] first_row_removed The index of the first row removed.
/// @param[in] num_rows_removed The number of rows removed (including the first row).
void NotifyRowRemove(const Rocket::Core::String& table, int first_row_removed, int num_rows_removed);
/// Tells all attached listeners that one or more rows have been changed in the data source.
/// @param[in] table The name of the table to have rows changed in it.
/// @param[in] first_row_changed The index of the first row changed.
/// @param[in] num_rows_changed The number of rows changed (including the first row).
void NotifyRowChange(const Rocket::Core::String& table, int first_row_changed, int num_rows_changed);
/// Tells all attached listeners that the row structure has completely changed in the data source.
/// @param[in] table The name of the table to have rows changed in it.
void NotifyRowChange(const Rocket::Core::String& table);
/// Helper function for building a result set.
typedef std::map< Rocket::Core::String, Rocket::Core::String > RowMap;
void BuildRowEntries(Rocket::Core::StringList& row, const RowMap& row_map, const Rocket::Core::StringList& columns);
private:
Core::String name;
typedef std::list< DataSourceListener* > ListenerList;
ListenerList listeners;
};
}
}
#endif // ROCKETCONTROLSDATASOURCE_H
|
