framework/inc/targets.h

   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: targets.h,v $
  10  * $Revision: 1.10 $
  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
  31 #ifndef __FRAMEWORK_TARGETS_H_
  32 #define __FRAMEWORK_TARGETS_H_
  33
  34 //_________________________________________________________________________________________________________________
  35 //      includes
  36 //_________________________________________________________________________________________________________________
  37
  38 #include <macros/generic.hxx>
  39
  40 //_________________________________________________________________________________________________________________
  41 //      namespace
  42 //_________________________________________________________________________________________________________________
  43
  44 namespace framework{
  45
  46 //_________________________________________________________________________________________________________________
  47 //      Values for special frame search ... sTargetFrameName of findFrame() or queryDispatch() or loadComponentFromURL()
  48 //_________________________________________________________________________________________________________________
  49
  50 #define SPECIALTARGET_ASCII_SELF            "_self"                             // The frame himself is searched.
  51 #define SPECIALTARGET_ASCII_PARENT          "_parent"                           // The direct parent frame is searched.
  52 #define SPECIALTARGET_ASCII_TOP             "_top"                              // Search at ouer parents for the first task (if any exist) or a frame without a parent.
  53 #define SPECIALTARGET_ASCII_BLANK           "_blank"                            // Create a new task.
  54 #define SPECIALTARGET_ASCII_DEFAULT         "_default"                          // Create a new task or recycle an existing one
  55 #define SPECIALTARGET_ASCII_BEAMER          "_beamer"                           // special frame in hierarchy
  56 #define SPECIALTARGET_ASCII_MENUBAR         "_menubar"                          // special target for menubars
  57 #define SPECIALTARGET_ASCII_HELPAGENT       "_helpagent"                        // special target for the help agent window
  58 #define SPECIALTARGET_ASCII_HELPTASK        "OFFICE_HELP_TASK"                  // special name for our help task
  59
  60 #define SPECIALTARGET_SELF                  DECLARE_ASCII(SPECIALTARGET_ASCII_SELF       )
  61 #define SPECIALTARGET_PARENT                DECLARE_ASCII(SPECIALTARGET_ASCII_PARENT     )
  62 #define SPECIALTARGET_TOP                   DECLARE_ASCII(SPECIALTARGET_ASCII_TOP        )
  63 #define SPECIALTARGET_BLANK                 DECLARE_ASCII(SPECIALTARGET_ASCII_BLANK      )
  64 #define SPECIALTARGET_DEFAULT               DECLARE_ASCII(SPECIALTARGET_ASCII_DEFAULT    )
  65 #define SPECIALTARGET_BEAMER                DECLARE_ASCII(SPECIALTARGET_ASCII_BEAMER     )
  66 #define SPECIALTARGET_MENUBAR               DECLARE_ASCII(SPECIALTARGET_ASCII_MENUBAR    )
  67 #define SPECIALTARGET_HELPAGENT             DECLARE_ASCII(SPECIALTARGET_ASCII_HELPAGENT  )
  68 #define SPECIALTARGET_HELPTASK              DECLARE_ASCII(SPECIALTARGET_ASCII_HELPTASK   )
  69
  70 }               //      namespace framework
  71
  72 #endif  //      #ifndef __FRAMEWORK_TARGETS_H_