Back to index

lightning-sunbird  0.9+nobinonly
nsISVGValue.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is the Mozilla SVG project.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Crocodile Clips Ltd..
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Alex Fritze <alex.fritze@crocodile-clips.com> (original author)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 
00040 #ifndef __NS_ISVGVALUE_H__
00041 #define __NS_ISVGVALUE_H__
00042 
00043 #include "nsISupports.h"
00044 #include "nsString.h"
00045 
00046 class nsISVGValueObserver;
00047 
00049 // nsISVGValue: private interface for svg values
00050 
00051 /* This interface is implemented by all value-types (e.g. coords,
00052   pointlists, matrices) that can be parsed from/to strings. This is
00053   used for element-properties that are also XML attributes. E.g. the
00054   'polyline'-element has a 'points'-attribute and a property
00055   'animatedPoints' in the DOM.
00056 
00057   XXX Observers
00058 */
00059 
00060 // {d8299a5e-af9a-4bad-9845-fb1b6e2eed19}
00061 #define NS_ISVGVALUE_IID \
00062 { 0xd8299a5e, 0xaf9a, 0x4bad, { 0x98, 0x45, 0xfb, 0x1b, 0x6e, 0x2e, 0xed, 0x19 } }
00063 
00064 
00065 class nsISVGValue : public nsISupports
00066 {
00067 public:
00068   enum modificationType {
00069     mod_other = 0,
00070     mod_context,
00071     mod_die
00072   };
00073 
00074   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISVGVALUE_IID)
00075 
00076   NS_IMETHOD SetValueString(const nsAString& aValue)=0;
00077   NS_IMETHOD GetValueString(nsAString& aValue)=0;
00078 
00079   NS_IMETHOD AddObserver(nsISVGValueObserver* observer)=0;
00080   NS_IMETHOD RemoveObserver(nsISVGValueObserver* observer)=0;
00081 
00082   NS_IMETHOD BeginBatchUpdate()=0;
00083   NS_IMETHOD EndBatchUpdate()=0;
00084 };
00085 
00086 nsresult
00087 NS_CreateSVGGenericStringValue(const nsAString& aValue, nsISVGValue** aResult);
00088 
00089 nsresult
00090 NS_CreateSVGStringProxyValue(nsISVGValue* proxiedValue, nsISVGValue** aResult);
00091 
00092 #endif // __NS_ISVGVALUE_H__
00093