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

FXMatrix.h

Go to the documentation of this file.
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,2009 by Jeroen van der Zijp.   All Rights Reserved.        *
00007 *********************************************************************************
00008 * This library is free software; you can redistribute it and/or modify          *
00009 * it under the terms of the GNU Lesser General Public License as published by   *
00010 * the Free Software Foundation; either version 3 of the License, or             *
00011 * (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                 *
00016 * GNU Lesser General Public License for more details.                           *
00017 *                                                                               *
00018 * You should have received a copy of the GNU Lesser General Public License      *
00019 * along with this program.  If not, see <http://www.gnu.org/licenses/>          *
00020 *********************************************************************************
00021 * $Id: FXMatrix.h,v 1.23 2009/01/06 13:07:25 fox Exp $                          *
00022 ********************************************************************************/
00023 #ifndef FXMATRIX_H
00024 #define FXMATRIX_H
00025 
00026 #ifndef FXPACKER_H
00027 #include "FXPacker.h"
00028 #endif
00029 
00030 namespace FX {
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 private:
00065   FXMatrix(const FXMatrix&);
00066   FXMatrix &operator=(const FXMatrix&);
00067 public:
00068   long onFocusUp(FXObject*,FXSelector,void*);
00069   long onFocusDown(FXObject*,FXSelector,void*);
00070   long onFocusLeft(FXObject*,FXSelector,void*);
00071   long onFocusRight(FXObject*,FXSelector,void*);
00072 public:
00073 
00074   /// Construct a matrix layout manager with n rows or columns
00075   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);
00076 
00077   /// Perform layout
00078   virtual void layout();
00079 
00080   /// Return default width
00081   virtual FXint getDefaultWidth();
00082 
00083   /// Return default height
00084   virtual FXint getDefaultHeight();
00085 
00086   /// Obtain the child placed at a certain row and column
00087   FXWindow* childAtRowCol(FXint r,FXint c) const;
00088 
00089   /// Return the row in which the given child is placed
00090   FXint rowOfChild(const FXWindow* child) const;
00091 
00092   /// Return the column in which the given child is placed
00093   FXint colOfChild(const FXWindow* child) const;
00094 
00095   /// Change the matrix style
00096   void setMatrixStyle(FXuint ph);
00097 
00098   /// Return the current matrix style
00099   FXuint getMatrixStyle() const;
00100 
00101   /// Change the number of rows
00102   void setNumRows(FXint nr);
00103 
00104   /// Return the number of rows
00105   FXint getNumRows() const;
00106 
00107   /// Change the number of columns
00108   void setNumColumns(FXint nc);
00109 
00110   /// Return the number of columns
00111   FXint getNumColumns() const;
00112   };
00113 
00114 }
00115 
00116 #endif

Copyright © 1997-2009 Jeroen van der Zijp