include/pwlib/mdiframe.h

   1 /*
   2  * mdiframe.h
   3  *
   4  * Multiple Document Interface Frame Window.
   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.22  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.21  1999/03/10 03:49:52  robertj
  35  * More documentation adjustments.
  36  *
  37  * Revision 1.20  1999/03/09 08:01:48  robertj
  38  * Changed comments for doc++ support (more to come).
  39  *
  40  * Revision 1.19  1999/02/16 08:08:45  robertj
  41  * MSVC 6.0 compatibility changes.
  42  *
  43  * Revision 1.18  1998/12/01 12:55:54  robertj
  44  * new directory structure.
  45  *
  46  * Revision 1.17  1998/09/23 06:24:15  robertj
  47  * Added open source copyright license.
  48  *
  49  * Revision 1.16  1996/04/30 12:33:40  robertj
  50  * Changed "inPixels" boolean to enum for three coordinate systems.
  51  *
  52  * Revision 1.15  1996/01/02 13:15:35  robertj
  53  * Mac OS compatibility.
  54  *
  55  * Revision 1.14  1995/11/09 12:15:49  robertj
  56  * Removed redundent function in MDI frame.
  57  *
  58  * Revision 1.13  1995/03/14 12:41:44  robertj
  59  * Updated documentation to use HTML codes.
  60  *
  61  * Revision 1.12  1995/02/19  04:10:07  robertj
  62  * Documentation.
  63  *
  64  * Revision 1.11  1995/01/03  09:36:13  robertj
  65  * Documentation.
  66  *
  67  * Revision 1.10  1994/08/23  11:32:52  robertj
  68  * Oops
  69  *
  70  * Revision 1.9  1994/08/22  00:46:48  robertj
  71  * Added pragma fro GNU C++ compiler.
  72  *
  73  * Revision 1.8  1994/07/25  03:35:10  robertj
  74  * Added ability to change area in which MDI children are limited.
  75  *
  76  * Revision 1.7  1994/07/21  23:49:31  robertj
  77  * Removed redundent destructors.
  78  *
  79  * Revision 1.6  1994/07/17  10:46:06  robertj
  80  * Added more functionality, esp ability to get at Window menu.
  81  *
  82  * Revision 1.5  1994/06/25  11:55:15  robertj
  83  * Unix version synchronisation.
  84  *
  85  * Revision 1.4  1994/03/07  07:38:19  robertj
  86  * Major enhancementsacross the board.
  87  *
  88  * Revision 1.3  1994/01/03  04:42:23  robertj
  89  * Mass changes to common container classes and interactors etc etc etc.
  90  *
  91  * Revision 1.2  1993/07/14  12:49:16  robertj
  92  * Fixed RCS keywords.
  93  *
  94  */
  95
  96
  97 #define _PMDIFRAMEWINDOW
  98
  99 #ifdef __GNUC__
 100 #pragma interface
 101 #endif
 102
 103
 104 class PMDIDocWindow;
 105
 106
 107 /**A class representing a top level window "frame" for Multiple Document
 108    Interface child windows. This is the "main" window that the application
 109    creates when an MDI is required. On some platforms, eg MS-Windows variants,
 110    this encloses the MDI child windows. On
 111  */
 112 class PMDIFrameWindow : public PTopLevelWindow
 113 {
 114   PCLASSINFO(PMDIFrameWindow, PTopLevelWindow);
 115
 116   public:
 117    /**Construct a new MDI style top level window.
 118      */
 119     PMDIFrameWindow(
 120       unsigned CanDo=CanClose|CanGrow|CanIconify|CanZoom  /// Titled window flags.
 121     );
 122
 123
 124   /**@name New functions for class */
 125    /**Get the MDI document window that is the frontmost or "target" MDI child
 126        window.
 127
 128        @return
 129        pointer to active MDI child or NULL if there is none.
 130      */
 131     PMDIDocWindow * GetActiveDocument();
 132
 133       /** Reposition and resize all child documents in a cascading fashion. */
 134     virtual void CascadeDocuments();
 135
 136    /**Reposition and resize all child documents in a tiled fashion. The
 137        parameter indicates the preference for tiling multiple windows.
 138      */
 139     virtual void TileDocuments(
 140       BOOL vertically = FALSE   /// Tiling orientation.
 141     );
 142
 143       /** Reposition all child documents that are currently iconic. */
 144     virtual void ArrangeIcons();
 145
 146    /**Set the area in the frames client area that child document windows are
 147        limited to.
 148
 149        These bounds are used if areas of the frame are not to be obscured by
 150        the document child windows, eg when tool bars are used. The tiling and
 151        cascading, as well as maximising the child, are limited to this area.
 152
 153        If this rectangle is empty then the document area is the entire frame
 154        window.
 155      */
 156     void SetDocumentArea(
 157       const PRect & rect,     /// Bounds for child windows.
 158       CoordinateSystem coords /// Coordinate system to use.
 159     );
 160
 161    /**Get the area in the frames client area that child document windows are
 162        limited to.
 163
 164        These bounds are used if areas of the frame are not to be obscured by
 165        the document child windows, eg when tool bars are used. The tiling and
 166        cascading, as well as maximising the child, are limited to this area.
 167
 168        If this rectangle is empty then the document area is the entire frame
 169        window.
 170
 171        @return
 172        bounds area for MDI child windows.
 173      */
 174     PRect GetDocumentArea(
 175       CoordinateSystem coords /// Coordinate system to use.
 176     ) const;
 177
 178    /**Get the standard "Window" sub-menu which contains a list of all the
 179        active child windows as well as the standard Cascade, Tile and Arrange
 180        Icons menu items.
 181
 182        @return
 183        reference to a sub-menu for the the MDI "Windows" menu.
 184      */
 185     PSubMenu & GetWindowMenu();
 186
 187
 188   protected:
 189   // Member variables
 190       /** Area within the MDI frame that MDI child windows may exist. */
 191     PRect documentArea;
 192
 193
 194 // Include platform dependent part of class
 195 #include <pwlib/mdiframe.h>
 196 };
 197
 198
 199 // End Of File ///////////////////////////////////////////////////////////////