ElementReference.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 ROCKETCOREELEMENTREFERENCE_H
00029 #define ROCKETCOREELEMENTREFERENCE_H
00030 
00031 namespace Rocket {
00032 namespace Core {
00033 
00034 class Element;
00035 
00042 class ElementReference
00043 {
00044 public:
00045         ElementReference(Element* element = NULL);
00046         ElementReference(const ElementReference& copy);
00047         ~ElementReference();
00048 
00051         operator bool() const;
00052 
00056         ElementReference& operator=(Element* element);
00060         ElementReference& operator=(const ElementReference& element_reference);
00061 
00064         Element* operator*();
00067         Element* operator->();
00068 
00072         bool operator==(const ElementReference& rhs) const;
00076         bool operator==(const Element* rhs) const;
00077 
00081         bool operator<(const ElementReference& rhs) const;
00082 
00086         bool operator!=(const ElementReference& rhs) const;
00090         bool operator!=(const Element* rhs) const;
00091 
00092 private:
00093         Element* element;
00094 };
00095 
00096 }
00097 }
00098 
00099 #endif