offapi/com/sun/star/frame/DispatchHelper.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: DispatchHelper.idl,v $
  10  * $Revision: 1.7 $
  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_DispatchHelper_idl__
  31 #define __com_sun_star_frame_DispatchHelper_idl__
  32
  33 #ifndef __com_sun_star_frame_XDispatchHelper_idl__
  34 #include <com/sun/star/frame/XDispatchHelper.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module frame {
  40
  41 //=============================================================================
  42 /** provides an easy way to dispatch an URL using one call instead of multiple ones.
  43
  44     <p>
  45     Normaly a complete dispatch is splitted into different parts:
  46     - converting and parsing the URL
  47     - searching for a valid dispatch object available on a dispatch provider
  48     - dispatching of the URL and it's parameters
  49     </p>
  50
  51     @see DispatchProvider
  52
  53     @since OOo 1.1.2
  54  */
  55 published service DispatchHelper
  56 {
  57     //-------------------------------------------------------------------------
  58     /** provides the easy way for dispatch requests.
  59
  60         @see XDispatchProvider
  61         @see XDispatch
  62      */
  63     interface XDispatchHelper;
  64 };
  65
  66 //=============================================================================
  67
  68 }; }; }; };
  69
  70 #endif