toolbox.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
// ObjectWindows
// Copyright (c) 1992, 1996 by Borland International, All Rights Reserved
//
/// \file
/// Definition of class TToolBox.
//----------------------------------------------------------------------------
 
#if !defined(OWL_TOOLBOX_H)
#define OWL_TOOLBOX_H
 
#include <owl/private/defs.h>
#if defined(BI_HAS_PRAGMA_ONCE)
# pragma once
#endif
 
#include <owl/defs.h>
#include <owl/gadgetwi.h>
 
 
namespace owl {
 
#include <owl/preclass.h>
 
/// \addtogroup gadgets
/// @{
//
/// \class TToolBox
// ~~~~~ ~~~~~~~~
/// Arranges its gadgets in a matrix. All columns are the same width (as wide
/// as the widest gadget) and all rows are the same height (as high as the
/// heighest gadget)
//
/// You specify the number of rows and columns you want. You can specify
/// AS_MANY_AS_NEEDED in which case the toolbox figures out how many rows or
/// columns are needed based on the opposite dimension (e.g. if there are
/// 20 gadgets and you requested 4 columns then you would get 5 rows)
//
 
const int AS_MANY_AS_NEEDED = -1;
 
class _OWLCLASS TToolBox : public TGadgetWindow {
  public:
    TToolBox(TWindow*        parent,
             int             numColumns = 2,
             int             numRows = AS_MANY_AS_NEEDED,
             TTileDirection  direction = Horizontal,  // Row Major
             TModule*        module = 0);
 
    void  GetDesiredSize(TSize& size);
    void  LayoutSession();
 
    /// Override Insert member function and tell the button to not notch
    /// its corners
    //
    void  Insert(TGadget& gadget, TPlacement = After, TGadget* sibling = 0);
 
    virtual void  SetDirection(TTileDirection direction);
 
  protected:
    TRect TileGadgets();
 
    int   GetNumRows() const;
    int   GetNumColumns() const;
 
  protected_data:
    int   NumRows;    ///< Contains the number of rows for the toolbox.
    int   NumColumns; ///< Contains the number of columns for the toolbox.
 
  private:
    void  ComputeNumRowsColumns(int& numRows, int& numColumns);
    void  ComputeCellSize(TSize& size);
 
  DECLARE_CASTABLE;
};
 
/// @}
 
#include <owl/posclass.h>
 
 
//----------------------------------------------------------------------------
// Inline implementation
//
 
//
/// Returns the number of rows the tool box is using.
//
inline int TToolBox::GetNumRows() const
{
  return NumRows;
}
 
//
/// Returns the number of columns the tool box is using.
//
inline int TToolBox::GetNumColumns() const
{
  return NumColumns;
}
 
} // OWL namespace
 
 
#endif  // OWL_TOOLBOX_H