lookupfieldschema.h

/* This file is part of the KDE project
   Copyright (C) 2006-2007 Jaroslaw Staniek <js@iidea.pl>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   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
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */
 
#ifndef KEXIDB_LOOKUPFIELDSCHEMA_H
#define KEXIDB_LOOKUPFIELDSCHEMA_H
 
#include <tqvaluelist.h>
#include <tqstringlist.h>
 
class TQDomElement;
class TQDomDocument;
class TQVariant;
 
namespace KexiDB {

#define KEXIDB_LOOKUP_FIELD_DEFAULT_HEADERS_VISIBLE false

#define KEXIDB_LOOKUP_FIELD_DEFAULT_LIST_ROWS 8

#define KEXIDB_LOOKUP_FIELD_MAX_LIST_ROWS 100

#define KEXIDB_LOOKUP_FIELD_DEFAULT_LIMIT_TO_LIST true

#define KEXIDB_LOOKUP_FIELD_DEFAULT_DISPLAY_WIDGET KexiDB::LookupFieldSchema::ComboBox
 


class KEXI_DB_EXPORT LookupFieldSchema
{
    public:

        class KEXI_DB_EXPORT RowSource {
            public:
                enum Type {
                    NoType,         
                    Table,        
                    Query,        
                    SQLStatement, 
                    ValueList,    
                    FieldList     
                };
 
                RowSource();
                ~RowSource();

                Type type() const { return m_type; }

                void setType(Type type) { m_type = type; }

                TQString typeName() const;

                void setTypeByName( const TQString& typeName );

                TQString name() const { return m_name; }

                void setName(const TQString& name);

                TQStringList values() const;

                void setValues(const TQStringList& values);

                TQString debugString() const;
 
                void debug() const;
            private:
                Type m_type;
                TQString m_name;
                TQStringList *m_values;
        };
 
        LookupFieldSchema();
 
        ~LookupFieldSchema();

        RowSource& rowSource() { return m_rowSource; }

        void setRowSource(const RowSource& rowSource) { m_rowSource = rowSource; }

        int boundColumn() const { return m_boundColumn; }

        void setBoundColumn(int column) { m_boundColumn = column>=0 ? column : -1; }

        TQValueList<uint> visibleColumns() const { return m_visibleColumns; }

        void setVisibleColumns(const TQValueList<uint>& list) { m_visibleColumns = list; }

        inline int visibleColumn(uint fieldsCount) const {
            if (m_visibleColumns.count()==1)
                return (m_visibleColumns.first() < fieldsCount) 
                    ? (int)m_visibleColumns.first() : -1;
            if (m_visibleColumns.isEmpty())
                return -1;
            return fieldsCount - 1;
        }

        const TQValueList<int> columnWidths() const { return m_columnWidths; }

        void setColumnWidths(const TQValueList<int>& widths) { m_columnWidths = widths; }

        bool columnHeadersVisible() const { return m_columnHeadersVisible; }

        void setColumnHeadersVisible(bool set) { m_columnHeadersVisible = set; }

        uint maximumListRows() const { return m_maximumListRows; }

        void setMaximumListRows(uint rows);

        bool limitToList() const { return m_limitToList; }

        void setLimitToList(bool set) { m_limitToList = set; }

        enum DisplayWidget {
            ComboBox = 0, 
            ListBox = 1   
        };

        DisplayWidget displayWidget() const { return m_displayWidget; }

        void setDisplayWidget(DisplayWidget widget) { m_displayWidget = widget; }

        TQString debugString() const;
 
        void debug() const;

        static LookupFieldSchema* loadFromDom(const TQDomElement& lookupEl);

        static void saveToDom(LookupFieldSchema& lookupSchema, TQDomDocument& doc, TQDomElement& parentEl);

        static bool setProperty( 
            LookupFieldSchema& lookup, const TQCString& propertyName, const TQVariant& value );
 
    protected:
        RowSource m_rowSource;
        int m_boundColumn;
        TQValueList<uint> m_visibleColumns;
        TQValueList<int> m_columnWidths;
        uint m_maximumListRows;
        DisplayWidget m_displayWidget;
        bool m_columnHeadersVisible : 1;
        bool m_limitToList : 1;
};
 
} //namespace KexiDB
 
#endif