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

FXMatrix.h

00001 /********************************************************************************
00002 *                                                                               *
00003 *                   M a t r i x   C o n t a i n e r   W i d g e t               *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 1997,2002 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: FXMatrix.h,v 1.12 2002/01/18 22:42:53 jeroen Exp $                       *
00023 ********************************************************************************/
00024 #ifndef FXMATRIX_H
00025 #define FXMATRIX_H
00026 
00027 #ifndef FXPACKER_H
00028 #include "FXPacker.h"
00029 #endif
00030 
00031 
00032 
00033 /// Matrix packing options
00034 enum {
00035   MATRIX_BY_ROWS        = 0,              /// Fixed number of rows, add columns as needed
00036   MATRIX_BY_COLUMNS     = 0x00020000      /// Fixed number of columns, adding rows as needed
00037   };
00038 
00039 
00040 
00041 /**
00042 * The Matrix layout manager automatically arranges its child windows
00043 * in rows and columns.  If the matrix style is MATRIX_BY_ROWS, then
00044 * the matrix will have the given number of rows and the number of columns
00045 * grows as more child windows are added; if the matrix style is MATRIX_BY_COLUMNS,
00046 * then the number of columns is fixed and the number of rows grows as more children
00047 * are added.
00048 * If all children in a row (column) have the LAYOUT_FILL_ROW (LAYOUT_FILL_COLUMN)
00049 * hint set, then the row (column) will be stretchable as the matrix layout manager
00050 * itself is resized.  If more than one row (column) is stretchable, the space is
00051 * apportioned to each stretchable row (column) proportionally.
00052 * Within each cell of the matrix, all other layout hints are observed.
00053 * For example, a child having LAYOUT_CENTER_Y and LAYOUT_FILL_X hints will
00054 * be centered in the Y-direction, while being stretched in the X-direction.
00055 * Empty cells can be obtained by simply placing a borderless FXFrame widget
00056 * as a space-holder.
00057 */
00058 class FXAPI FXMatrix : public FXPacker {
00059   FXDECLARE(FXMatrix)
00060 protected:
00061   FXint  num;
00062 protected:
00063   FXMatrix(){}
00064   virtual void layout();
00065 private:
00066   FXMatrix(const FXMatrix&);
00067   FXMatrix &operator=(const FXMatrix&);
00068 public:
00069   long onFocusUp(FXObject*,FXSelector,void*);
00070   long onFocusDown(FXObject*,FXSelector,void*);
00071   long onFocusLeft(FXObject*,FXSelector,void*);
00072   long onFocusRight(FXObject*,FXSelector,void*);
00073 public:
00074 
00075   /// Construct a matrix layout manager with n rows or columns
00076   FXMatrix(FXComposite *p,FXint n=1,FXuint opts=MATRIX_BY_ROWS,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);
00077 
00078   /// Return default width
00079   virtual FXint getDefaultWidth();
00080 
00081   /// Return default height
00082   virtual FXint getDefaultHeight();
00083 
00084   /// Obtain the child placed at a certain row and column
00085   FXWindow* childAtRowCol(FXint r,FXint c) const;
00086 
00087   /// Return the row in which the given child is placed
00088   FXint rowOfChild(FXWindow* child) const;
00089 
00090   /// Return the column in which the given child is placed
00091   FXint colOfChild(FXWindow* child) const;
00092 
00093   /// Change the matrix style
00094   void setMatrixStyle(FXuint ph);
00095 
00096   /// Return the current matrix style
00097   FXuint getMatrixStyle() const;
00098 
00099   /// Change the number of rows
00100   void setNumRows(FXint nr);
00101 
00102   /// Return the number of rows
00103   FXint getNumRows() const;
00104 
00105   /// Change the number of columns
00106   void setNumColumns(FXint nc);
00107 
00108   /// Return the number of columns
00109   FXint getNumColumns() const;
00110   };
00111 
00112 
00113 #endif