Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FXSpring.h

Go to the documentation of this file.
00001 /********************************************************************************
00002 *                                                                               *
00003 *                S p r i n g   C o n t a i n e r   W i d g e t                  *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 2003,2006 by Jeroen van der Zijp.   All Rights Reserved.        *
00007 *********************************************************************************
00008 * This library is free software; you can redistribute it and/or                 *
00009 * modify it under the terms of the GNU Lesser General Public                    *
00010 * License as published by the Free Software Foundation; either                  *
00011 * version 2.1 of the License, or (at your option) any later version.            *
00012 *                                                                               *
00013 * This library is distributed in the hope that it will be useful,               *
00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of                *
00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU             *
00016 * Lesser General Public License for more details.                               *
00017 *                                                                               *
00018 * You should have received a copy of the GNU Lesser General Public              *
00019 * License along with this library; if not, write to the Free Software           *
00020 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
00021 *********************************************************************************
00022 * $Id: FXSpring.h,v 1.8 2006/01/22 17:58:10 fox Exp $                           *
00023 ********************************************************************************/
00024 #ifndef FXSPRING_H
00025 #define FXSPRING_H
00026 
00027 #ifndef FXPACKER_H
00028 #include "FXPacker.h"
00029 #endif
00030 
00031 namespace FX {
00032 
00033 
00034 /**
00035 * The spring widgets, when properly embedded side by side in a horizontal
00036 * frame or vertical frame widget, behave like a set of connected springs
00037 * of various lengths (hence the name!).  The parameters relw (or relh)
00038 * determines the length of the spring.  The actual length is not really
00039 * important; the only thing that counts is the relative length of one
00040 * spring widget to that of another, although the length does determine
00041 * the default size.  The special value zero may be given for relw (or relh)
00042 * to cause the spring to calculate its default width (height) normally,
00043 * just like the Packer base class does.
00044 * In a typical scenario, either the relative width or height is set to
00045 * zero, an the flag LAYOUT_FILL_X or LAYOUT_FILL_Y is passed. When
00046 * placed inside a horizontal frame, the LAYOUT_FILL_X together with
00047 * the relative widths of the springs will cause a fixed width-ratio
00048 * between the springs.
00049 * You also can mix normal controls and springs together in a horizontal
00050 * or vertical frames to provide arbitrary stretchable spacing between
00051 * widgets; in this case, the springs do not need to have any children.
00052 * Since the spring widget is derived from the packer layout manager,
00053 * it provides the same layout behavior as packer.
00054 */
00055 class FXAPI FXSpring : public FXPacker {
00056   FXDECLARE(FXSpring)
00057 protected:
00058   FXint   relWidth;     // Relative width
00059   FXint   relHeight;    // Relative height
00060 protected:
00061   FXSpring(){}
00062 private:
00063   FXSpring(const FXSpring&);
00064   FXSpring &operator=(const FXSpring&);
00065 public:
00066 
00067   /// Construct packer layout manager
00068   FXSpring(FXComposite *p,FXuint opts=0,FXint relw=0,FXint relh=0,FXint x=0,FXint y=0,FXint w=0,FXint h=0,FXint pl=DEFAULT_SPACING,FXint pr=DEFAULT_SPACING,FXint pt=DEFAULT_SPACING,FXint pb=DEFAULT_SPACING,FXint hs=DEFAULT_SPACING,FXint vs=DEFAULT_SPACING);
00069 
00070   /// Return default width
00071   virtual FXint getDefaultWidth();
00072 
00073   /// Return default height
00074   virtual FXint getDefaultHeight();
00075 
00076   /// Change relative width
00077   void setRelativeWidth(FXint relw);
00078 
00079   /// Return relative width
00080   FXint  getRelativeWidth() const { return relWidth; }
00081 
00082   /// Change relative height
00083   void setRelativeHeight(FXint relh);
00084 
00085   /// Return relative height
00086   FXint getRelativeHeight() const { return relHeight; }
00087 
00088   /// Save to stream
00089   virtual void save(FXStream& store) const;
00090 
00091   /// Load from stream
00092   virtual void load(FXStream& store);
00093   };
00094 
00095 }
00096 
00097 #endif

Copyright © 1997-2005 Jeroen van der Zijp