include/pwlib/menusep.h

   1 /*
   2  * menusep.h
   3  *
   4  * Menu Separator class.
   5  *
   6  * Portable Windows Library
   7  *
   8  * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
   9  *
  10  * The contents of this file are subject to the Mozilla Public License
  11  * Version 1.0 (the "License"); you may not use this file except in
  12  * compliance with the License. You may obtain a copy of the License at
  13  * http://www.mozilla.org/MPL/
  14  *
  15  * Software distributed under the License is distributed on an "AS IS"
  16  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  17  * the License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * The Original Code is Portable Windows Library.
  21  *
  22  * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
  23  *
  24  * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
  25  * All Rights Reserved.
  26  *
  27  * Contributor(s): ______________________________________.
  28  *
  29  * $Log$
  30  * Revision 1.14  2001/05/22 12:49:33  robertj
  31  * Did some seriously wierd rewrite of platform headers to eliminate the
  32  *   stupid GNU compiler warning about braces not matching.
  33  *
  34  * Revision 1.13  1999/03/10 03:49:52  robertj
  35  * More documentation adjustments.
  36  *
  37  * Revision 1.12  1999/03/09 08:01:49  robertj
  38  * Changed comments for doc++ support (more to come).
  39  *
  40  * Revision 1.11  1999/02/16 08:08:46  robertj
  41  * MSVC 6.0 compatibility changes.
  42  *
  43  * Revision 1.10  1998/09/23 06:24:23  robertj
  44  * Added open source copyright license.
  45  *
  46  * Revision 1.9  1995/03/14 12:41:48  robertj
  47  * Updated documentation to use HTML codes.
  48  *
  49  * Revision 1.8  1995/01/03  09:36:17  robertj
  50  * Documentation.
  51  *
  52  * Revision 1.7  1994/08/23  11:32:52  robertj
  53  * Oops
  54  *
  55  * Revision 1.6  1994/08/22  00:46:48  robertj
  56  * Added pragma fro GNU C++ compiler.
  57  *
  58  * Revision 1.5  1994/06/25  11:55:15  robertj
  59  * Unix version synchronisation.
  60  *
  61  * Revision 1.4  1994/01/03  04:42:23  robertj
  62  * Mass changes to common container classes and interactors etc etc etc.
  63  *
  64  * Revision 1.3  1993/08/21  01:50:33  robertj
  65  * Made Clone() function optional, default will assert if called.
  66  *
  67  * Revision 1.2  1993/07/14  12:49:16  robertj
  68  * Fixed RCS keywords.
  69  *
  70  */
  71
  72
  73 #define _PMENUSEPARATOR
  74
  75 #ifdef __GNUC__
  76 #pragma interface
  77 #endif
  78
  79
  80 /**A class representing a menu item separator. This may be inserted into a
  81    menu to place a platform dependent separator between menu items.
  82  */
  83 class PMenuSeparator : public PMenuEntry
  84 {
  85   PCLASSINFO(PMenuSeparator, PMenuEntry);
  86
  87   friend class PSubMenu;
  88
  89   public:
  90     /** Create a single line menu separator as a menu entry in the menu. */
  91     PMenuSeparator(
  92       PSubMenu & menu,      /// Menu into which the new entry is to be placed.
  93       PMenuEntry * before = NULL
  94      /**Menu entry before which the entry is to be inserted. If this is NULL
  95          then the menu entry is appended to the end of the menu.
  96        */
  97     );
  98
  99
 100   /**@name New functions for class */
 101     /** Set the string name of the menu entry. This function does nothing. */
 102     virtual void SetString(
 103       const PString & str   /// New string for the menu entry.
 104     );
 105
 106    /**Get the current string name of the menu entry.
 107
 108        @return
 109        empty string.
 110      */
 111     virtual PString GetString() const;
 112
 113
 114 // Include platform dependent part of class
 115 #include <pwlib/menusep.h>
 116 };
 117
 118
 119 // End Of File ///////////////////////////////////////////////////////////////