summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/frame/FeatureStateEvent.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/frame/FeatureStateEvent.idl')
-rw-r--r--offapi/com/sun/star/frame/FeatureStateEvent.idl154
1 files changed, 154 insertions, 0 deletions
diff --git a/offapi/com/sun/star/frame/FeatureStateEvent.idl b/offapi/com/sun/star/frame/FeatureStateEvent.idl
new file mode 100644
index 000000000000..bfb8ade1bf3a
--- /dev/null
+++ b/offapi/com/sun/star/frame/FeatureStateEvent.idl
@@ -0,0 +1,154 @@
+/*************************************************************************
+ *
+ * $RCSfile: FeatureStateEvent.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: mi $ $Date: 2000-11-06 09:21:43 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 by Sun Microsystems, Inc.
+ * 901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software Foundation.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (the "License"); You may not use this file
+ * except in compliance with the License. You may obtain a copy of the
+ * License at http://www.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_frame_FeatureStateEvent_idl__
+#define __com_sun_star_frame_FeatureStateEvent_idl__
+
+#ifndef __com_sun_star_lang_EventObject_idl__
+#include <com/sun/star/lang/EventObject.idl>
+#endif
+
+#ifndef __com_sun_star_util_URL_idl__
+#include <com/sun/star/util/URL.idl>
+#endif
+
+
+//=============================================================================
+
+ module com { module sun { module star { module frame {
+
+//=============================================================================
+
+// DocMerge from xml: struct com::sun::star::frame::FeatureStateEvent
+/** This event is broadcasted by a <type>Controller</type> whenever the state of
+ the feature changes.@see interface XController
+ @see interface XStatusListener
+ */
+struct FeatureStateEvent: com::sun::star::lang::EventObject
+{
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::FeatureURL
+ /** contains the URL of the feature.
+ */
+ com::sun::star::util::URL FeatureURL;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::FeatureDescriptor
+ /** contains a descriptor of the feature for the user interface.
+ */
+ string FeatureDescriptor;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::IsEnabled
+ /** specifies whether the feature is currently enabled or disabled.
+ */
+ boolean IsEnabled;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::Requery
+ /** specifies whether the <type>XDispatch</type> has to be requeried.
+ */
+ boolean Requery;
+
+ //-------------------------------------------------------------------------
+
+ // DocMerge from xml: field com::sun::star::frame::FeatureStateEvent::State
+ /** contains the state of the feature in this dispatch.
+
+
+
+ <p>This can be, for example, simply <true></true> for a boolean feature like
+ underline on/off. Some simple types like <code>string</code> or
+ <atom>boolean</atom> are useful here for generic UI elements, like
+ a checkmark in a menu.</p>
+ */
+ any State;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+ $Log: not supported by cvs2svn $
+ Revision 1.1.1.1 2000/09/18 23:35:20 hjs
+ initial import
+
+ Revision 1.7 2000/09/11 11:52:27 mi
+ documentation merged from XML
+
+ Revision 1.3 2000/02/23 14:49:55 mi
+ missing documentations
+
+ Revision 1.2 2000/01/31 09:44:58 mi
+ XML syntax for documentation
+
+ Revision 1.1.1.1 1999/11/11 09:48:43 jsc
+ new
+
+
+=============================================================================*/
+#endif