YTable.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  This library is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) version 3.0 of the License. This library
  is distributed in the hope that it will be useful, but WITHOUT ANY
  WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
  License for more details. You should have received a copy of the GNU
  Lesser General Public License along with this library; if not, write
  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  Floor, Boston, MA 02110-1301 USA
*/


/*-/

  File:     YTable.h

  Author:   Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YTable_h
#define YTable_h

#include "YTypes.h"
#include "YSelectionWidget.h"
#include "YTableItem.h"
#include "YTableHeader.h"

class YTablePrivate;



class YTable : public YSelectionWidget
{
protected:
    YTable( YWidget * parent, YTableHeader * header, bool multiSelection );

public:

    virtual ~YTable();

    virtual const char * widgetClass() const { return "YTable"; }

    int columns() const;

    bool hasColumn( int column ) const;

    std::string header( int column ) const;

    YAlignmentType alignment( int column ) const;

    bool immediateMode() const;

    void setImmediateMode( bool immediateMode = true );

    bool keepSorting() const;

    virtual void setKeepSorting( bool keepSorting );

    bool hasMultiSelection() const;

    YItem * findItem( const std::string & wantedItemLabel, int column ) const;

    YItem * findItem( const std::string & wantedItemLabel,
                      int                 column,
                      YItemConstIterator  begin,
                      YItemConstIterator  end ) const;

    virtual void cellChanged( const YTableCell * cell ) = 0;

    virtual bool setProperty( const std::string    & propertyName,
                  const YPropertyValue & val );

    virtual YPropertyValue getProperty( const std::string & propertyName );

    virtual const YPropertySet & propertySet();


    const char * userInputProperty() { return YUIProperty_CurrentItem; }


protected:

    void setTableHeader( YTableHeader * newHeader );

private:

    ImplPtr<YTablePrivate> priv;
};


#endif // YTable_h