DataSource.h

00001 /*
00002  * This source file is part of libRocket, the HTML/CSS Interface Middleware
00003  *
00004  * For the latest information, see http://www.librocket.com
00005  *
00006  * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
00007  *
00008  * Permission is hereby granted, free of charge, to any person obtaining a copy
00009  * of this software and associated documentation files (the "Software"), to deal
00010  * in the Software without restriction, including without limitation the rights
00011  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012  * copies of the Software, and to permit persons to whom the Software is
00013  * furnished to do so, subject to the following conditions:
00014  *
00015  * The above copyright notice and this permission notice shall be included in
00016  * all copies or substantial portions of the Software.
00017  * 
00018  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024  * THE SOFTWARE.
00025  *
00026  */
00027 
00028 #ifndef ROCKETCONTROLSDATASOURCE_H
00029 #define ROCKETCONTROLSDATASOURCE_H
00030 
00031 #include <Rocket/Controls/Header.h>
00032 #include <Rocket/Core/String.h>
00033 #include <list>
00034 #include <map>
00035 
00036 namespace Rocket {
00037 namespace Controls {
00038 
00039 class DataSourceListener;
00040 
00046 class ROCKETCONTROLS_API DataSource
00047 {
00048         public:
00049                 DataSource(const Rocket::Core::String& name = "");
00050                 virtual ~DataSource();
00051 
00052                 const Rocket::Core::String& GetDataSourceName();
00053                 static DataSource* GetDataSource(const Rocket::Core::String& data_source_name);
00054 
00060                 virtual void GetRow(Rocket::Core::StringList& row, const Rocket::Core::String& table, int row_index, const Rocket::Core::StringList& columns) = 0;
00064                 virtual int GetNumRows(const Rocket::Core::String& table) = 0;
00065 
00066                 void AttachListener(DataSourceListener* listener);
00067                 void DetachListener(DataSourceListener* listener);
00068 
00069                 virtual void* GetScriptObject() const;
00070 
00071                 static const Rocket::Core::String CHILD_SOURCE;
00072                 static const Rocket::Core::String DEPTH;
00073                 static const Rocket::Core::String NUM_CHILDREN;
00074 
00075         protected:
00080                 void NotifyRowAdd(const Rocket::Core::String& table, int first_row_added, int num_rows_added);
00081 
00086                 void NotifyRowRemove(const Rocket::Core::String& table, int first_row_removed, int num_rows_removed);
00087 
00092                 void NotifyRowChange(const Rocket::Core::String& table, int first_row_changed, int num_rows_changed);
00093 
00096                 void NotifyRowChange(const Rocket::Core::String& table);
00097 
00099                 typedef std::map< Rocket::Core::String, Rocket::Core::String > RowMap;
00100                 void BuildRowEntries(Rocket::Core::StringList& row, const RowMap& row_map, const Rocket::Core::StringList& columns);
00101 
00102         private:
00103                 Core::String name;
00104 
00105                 typedef std::list< DataSourceListener* > ListenerList;
00106                 ListenerList listeners;
00107 };
00108 
00109 }
00110 }
00111 
00112 #endif // ROCKETCONTROLSDATASOURCE_H
00113