offapi/com/sun/star/frame/DispatchDescriptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_frame_DispatchDescriptor_idl__
  28 #define __com_sun_star_frame_DispatchDescriptor_idl__
  29
  30 #ifndef __com_sun_star_util_URL_idl__
  31 #include <com/sun/star/util/URL.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module frame {
  38
  39 //=============================================================================
  40 /** describes a feature to be retrieved by a URL that
  41     has to be loaded into a specified frame
  42
  43     <p>
  44     For a normal dispatch calls all needed parameters are seperated.
  45     For optimized remote functionality <member>XDispatch::queryDispatches()</member>
  46     it's neccessary to pack these parameters in a flat structure wich can be used
  47     in a simple manner.
  48     </p>
  49
  50     @see XDispatchProvider::queryDispatches()
  51  */
  52 published struct DispatchDescriptor
  53 {
  54     //-------------------------------------------------------------------------
  55     /** specifies the URL of the resource/function
  56
  57         <p>
  58         Must be a full parsed URL. Use service <type scope="com::sun::star::util">URLTransformer</type>
  59         for that.
  60         </p>
  61
  62         @see com::sun::star::util::URLTransformer
  63      */
  64     com::sun::star::util::URL FeatureURL;
  65
  66     //-------------------------------------------------------------------------
  67     /** name of the target frame
  68
  69         <p>
  70         Special targets (e.g. "_blank", "_self") or realy existing target names can be used.
  71         </p>
  72
  73         @see XDispatchProvider::queryDispatch()
  74      */
  75     string FrameName;
  76
  77     //-------------------------------------------------------------------------
  78     /** describes how the target frame is to be searched
  79
  80         <p>
  81         This optional parameter is used if <var>FrameName</var> isn't a special target only.
  82         </p>
  83
  84         @see FrameSearchFlag
  85      */
  86     long SearchFlags;
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif