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

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