ElementInterface.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 ROCKETCONTROLSPYTHONELEMENTINTERFACE_H
00029 #define ROCKETCONTROLSPYTHONELEMENTINTERFACE_H
00030 
00031 #include "SelectOptionProxy.h"
00032 #include "DataGridRowProxy.h"
00033 
00034 namespace Rocket {
00035 namespace Controls {
00036 
00037 class ElementDataGridRow;
00038 class ElementFormControlSelect;
00039 
00040 namespace Python {
00041 
00049 class ElementInterface
00050 {
00051 public:
00053         static void InitialisePythonInterface();
00055         static void InitialiseRocketInterface();
00056 
00057 private:
00058         // Sets the expanded state of a data grid row.
00059         static void SetRowExpanded(ElementDataGridRow* element, bool row_expanded);
00060         // Returns the options proxy for a select element.
00061         static SelectOptionProxy GetOptions(ElementFormControlSelect* element);
00062         // Override for ElementFormControlSelect's Add() without the last parameter.
00063         static int Add(ElementFormControlSelect* element, const Rocket::Core::String& rml, const Rocket::Core::String& value);
00064 
00065         // Default parameter submit for forms
00066         static void Submit(ElementForm* element);
00067 
00068         // Methods for simplyfing access to input element attributes
00069         static bool GetChecked(ElementFormControlInput* element);
00070         static void SetChecked(ElementFormControlInput* element, bool checked);
00071         
00072         static int GetMaxLength(ElementFormControlInput* element);
00073         static void SetMaxLength(ElementFormControlInput* element, int max_length);
00074         
00075         static int GetSize(ElementFormControlInput* element);
00076         static void SetSize(ElementFormControlInput* element, int size);
00077         
00078         static int GetMax(ElementFormControlInput* element);
00079         static void SetMax(ElementFormControlInput* element, int max);
00080         
00081         static int GetMin(ElementFormControlInput* element);
00082         static void SetMin(ElementFormControlInput* element, int min);
00083 
00084         static int GetStep(ElementFormControlInput* element);
00085         static void SetStep(ElementFormControlInput* element, int step);
00086 
00087         static DataGridRowProxy GetRows(ElementDataGrid* element);
00088 };
00089 
00090 }
00091 }
00092 }
00093 
00094 #endif