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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module frame {
  23
  24 /** describes a feature to be retrieved by a URL that
  25     has to be loaded into a specified frame
  26
  27     <p>
  28     For a normal dispatch calls all needed parameters are separated.
  29     For optimized remote functionality XDispatch::queryDispatches()
  30     it's necessary to pack these parameters in a flat structure which can be used
  31     in a simple manner.
  32     </p>
  33
  34     @see XDispatchProvider::queryDispatches()
  35  */
  36 published struct DispatchDescriptor
  37 {
  38     /** specifies the URL of the resource/function
  39
  40         <p>
  41         Must be a full parsed URL. Use service com::sun::star::util::URLTransformer
  42         for that.
  43         </p>
  44
  45         @see com::sun::star::util::URLTransformer
  46      */
  47     com::sun::star::util::URL FeatureURL;
  48
  49     /** name of the target frame
  50
  51         <p>
  52         Special targets (e.g. "_blank", "_self") or really existing target names can be used.
  53         </p>
  54
  55         @see XDispatchProvider::queryDispatch()
  56      */
  57     string FrameName;
  58
  59     /** describes how the target frame is to be searched
  60
  61         <p>
  62         This optional parameter is used if <var>FrameName</var> isn't a special target only.
  63         </p>
  64
  65         @see FrameSearchFlag
  66      */
  67     long SearchFlags;
  68 };
  69
  70
  71 }; }; }; };
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */