offapi/com/sun/star/frame/DispatchInformation.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_DispatchInformation_idl__
  28 #define __com_sun_star_frame_DispatchInformation_idl__
  29
  30 #ifndef __com_sun_star_frame_CommandGroup_idl__
  31 #include <com/sun/star/frame/CommandGroup.idl>
  32 #endif
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module frame {
  37
  38 //=============================================================================
  39 /** provides information about a supported command
  40
  41     @see XDispatchInformationProvider
  42     @see Controller
  43
  44     @since OOo 2.0.0
  45  */
  46 published struct DispatchInformation
  47 {
  48     //-------------------------------------------------------------------------
  49     /** command URL of a supported command.
  50     */
  51     string Command;
  52
  53     //-------------------------------------------------------------------------
  54     /** group identifier to which the supported command belong.
  55
  56         <p>
  57         @see CommandGroup
  58         </p>
  59     */
  60     short GroupId;
  61 };
  62
  63 //=============================================================================
  64
  65 }; }; }; };
  66
  67 #endif