path: root/sip/tqt/tqlayout.sip

// This is the SIP interface definition for TQBoxLayout, TQGLayoutIterator,
// TQGridLayout, TQHBoxLayout, TQLayout, TQLayoutItem, TQLayoutIterator,
// TQSpacerItem, TQVBoxLayout and TQWidgetItem.
//
// Copyright (c) 2007
// 	Riverbank Computing Limited <info@riverbankcomputing.co.uk>
// 
// This file is part of PyTQt.
// 
// This copy of PyTQt is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 2, or (at your option) any later
// version.
// 
// PyTQt is supplied 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 General Public License for more
// details.
// 
// You should have received a copy of the GNU General Public License along with
// PyTQt; see the file LICENSE.  If not, write to the Free Software Foundation,
// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


%ExportedDoc
<Sect2><Title>TQLayout</Title>
<Para>
<Literal>TQLayout</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>TQBoxLayout</Title>
<Para>
<Literal>TQBoxLayout</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>TQGLayoutIterator (TQt v2+)</Title>
<Para>
<Literal>TQGLayoutIterator</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>TQGridLayout</Title>
<FuncSynopsis>
	<FuncDef>bool <Function>findWidget</Function></FuncDef>
	<ParamDef>TQWidget *<Parameter>w</Parameter></ParamDef>
	<ParamDef>int *<Parameter>row</Parameter></ParamDef>
	<ParamDef>int *<Parameter>col</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes the <Literal>w</Literal> parameter and returns a tuple containing
the <Literal>bool</Literal> result, <Literal>row</Literal> and
<Literal>col</Literal>. (TQt v2+)
</Para>
</Sect2>

<Sect2><Title>TQHBoxLayout</Title>
<Para>
<Literal>TQHBoxLayout</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>TQLayoutItem (TQt v2+)</Title>
<Para>
<Literal>TQLayoutItem</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>TQLayoutIterator (TQt v2+)</Title>
<FuncSynopsis>
	<FuncDef>TQLayoutItem *<Function>next</Function></FuncDef>
	<ParamDef></ParamDef>
</FuncSynopsis>
<Para>
This is a wrapper around the <Literal>TQLayoutIterator</Literal>
<Literal>++</Literal> operator.
</Para>
</Sect2>

<Sect2><Title>TQSpacerItem (TQt v2+)</Title>
<Para>
<Literal>TQSpacerItem</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>TQVBoxLayout</Title>
<Para>
<Literal>TQVBoxLayout</Literal> is fully implemented.
</Para>
</Sect2>

<Sect2><Title>TQWidgetItem (TQt v2+)</Title>
<Para>
<Literal>TQWidgetItem</Literal> is fully implemented.
</Para>
</Sect2>
%End


class TQGLayoutIterator
{
%TypeHeaderCode
#include <tqabstractlayout.h>
%End

public:
	virtual TQLayoutItem *next() = 0;
	virtual TQLayoutItem *current() = 0;
	virtual TQLayoutItem *takeCurrent() = 0 /TransferBack/;
};


class TQLayoutIterator
{
%TypeHeaderCode
#include <tqabstractlayout.h>
%End

public:
	TQLayoutIterator(TQGLayoutIterator *) /Default/;
	TQLayoutIterator(const TQLayoutIterator &);

	TQLayoutItem *next();
%MethodCode
		Py_BEGIN_ALLOW_THREADS
		sipRes = ++(*sipCpp);
		Py_END_ALLOW_THREADS
%End

	TQLayoutItem *current();
	TQLayoutItem *takeCurrent() /TransferBack/;
	void deleteCurrent();
};


class TQLayoutItem
{
%TypeHeaderCode
#include <tqabstractlayout.h>
%End

public:
	TQLayoutItem(int = 0 );

%ConvertToSubClassCode
    // Note that we let the TQObject sub-class code handle TQLayout and it's
    // sub-classes.
	if (sipCpp->widget())
		sipClass = sipClass_TQWidgetItem;
	else if (sipCpp->spacerItem())
		sipClass = sipClass_TQSpacerItem;
	else
		sipClass = NULL;
%End

	virtual TQSize sizeHint() const = 0;
	virtual TQSize minimumSize() const = 0;
	virtual TQSize maximumSize() const = 0;
	virtual TQSizePolicy::ExpandData expanding() const = 0;
	virtual void setGeometry(const TQRect &) = 0;
	virtual TQRect geometry() const = 0;
	virtual bool isEmpty() const = 0;
	virtual bool hasHeightForWidth() const;
	virtual int heightForWidth(int) const;
	virtual void invalidate();

	virtual TQWidget *widget();
	virtual TQLayoutIterator iterator();
	virtual TQLayout *layout();
	virtual TQSpacerItem *spacerItem();

	int alignment() const;
	virtual void setAlignment(int);
};


class TQSpacerItem : TQLayoutItem
{
%TypeHeaderCode
#include <tqabstractlayout.h>
%End

public:
	TQSpacerItem(int,int,TQSizePolicy::SizeType = TQSizePolicy::Minimum,
		    TQSizePolicy::SizeType = TQSizePolicy::Minimum);

	void changeSize(int,int,TQSizePolicy::SizeType = TQSizePolicy::Minimum,
			TQSizePolicy::SizeType = TQSizePolicy::Minimum);
	TQSize sizeHint() const;
	TQSize minimumSize() const;
	TQSize maximumSize() const;
	TQSizePolicy::ExpandData expanding() const;
	bool isEmpty() const;
	void setGeometry(const TQRect &);
	TQRect geometry() const;
	TQSpacerItem *spacerItem();
};
 
 
class TQWidgetItem : TQLayoutItem
{
%TypeHeaderCode
#include <tqabstractlayout.h>
%End

public:
	TQWidgetItem(TQWidget *);

	TQSize sizeHint() const;
	TQSize minimumSize() const;
	TQSize maximumSize() const;
	TQSizePolicy::ExpandData expanding() const;
	bool isEmpty() const;
	void setGeometry(const TQRect &) ;
	TQRect geometry() const;
	virtual TQWidget *widget();

	bool hasHeightForWidth() const;
	int heightForWidth(int) const;
};


class TQLayout : TQObject, TQLayoutItem
{
%TypeHeaderCode
#include <tqabstractlayout.h>
%End

public:
	enum ResizeMode {
		FreeResize,
		Minimum,
		Fixed,
		Auto
	};

	TQLayout(TQWidget * /TransferThis/,int = 0,int = -1,const char * = 0);
	TQLayout(TQLayout * /TransferThis/,int = -1,const char * = 0);
	TQLayout(int = -1,const char * = 0);

	int margin() const;
	int spacing() const;

	virtual void setMargin(int);
	virtual void setSpacing(int);

	int defaultBorder() const;
	void freeze(int,int);
	void freeze();

	void setResizeMode(ResizeMode);
	ResizeMode resizeMode() const;

	virtual void setMenuBar(TQMenuBar *);
	TQMenuBar *menuBar() const;

	TQWidget *mainWidget();
	bool isTopLevel() const;

	virtual void setAutoAdd(bool);
	bool autoAdd() const;

	void invalidate();
	TQRect geometry() const;
	bool activate();

	void add(TQWidget *);
	virtual void addItem(TQLayoutItem * /Transfer/) = 0;

	void remove(TQWidget *);
	void removeItem(TQLayoutItem * /TransferBack/);

	TQSizePolicy::ExpandData expanding() const;
	TQSize minimumSize() const;
	TQSize maximumSize() const;
	virtual void setGeometry(const TQRect &) = 0;
	virtual TQLayoutIterator iterator() = 0;
	bool isEmpty() const;

	int totalHeightForWidth(int) const;
	TQSize totalMinimumSize() const;
	TQSize totalMaximumSize() const;
	TQSize totalSizeHint() const;
	TQLayout *layout();

	bool supportsMargin() const;

	void setEnabled(bool);
	bool isEnabled() const;

protected:
	bool eventFilter(TQObject *,TQEvent *);
	void childEvent(TQChildEvent *);
	void addChildLayout(TQLayout *);
	void deleteAllItems();

	void setSupportsMargin(bool);
	TQRect alignmentRect(const TQRect &) const;

private:
	TQLayout(const TQLayout &);
};


class TQGridLayout : TQLayout
{
%TypeHeaderCode
#include <tqlayout.h>
%End

public:
	TQGridLayout(TQWidget * /TransferThis/,int = 1,int = 1,int = 0,int = -1,const char * = 0);
	TQGridLayout(int = 1,int = 1,int = -1,const char * = 0);
	TQGridLayout(TQLayout * /TransferThis/,int = 1,int = 1,int = -1,const char * = 0);

	TQSize sizeHint() const;
	TQSize minimumSize() const;
	TQSize maximumSize() const;

	virtual void setRowStretch(int,int);
	virtual void setColStretch(int,int);
	int rowStretch(int) const;
	int colStretch(int) const;

	void setRowSpacing(int,int);
	void setColSpacing(int,int);
	int rowSpacing(int) const;
	int colSpacing(int) const;

	int numRows() const;
	int numCols() const;
	TQRect cellGeometry(int,int) const;

	bool hasHeightForWidth() const;
	int heightForWidth(int) const;
	int minimumHeightForWidth(int) const;

	TQSizePolicy::ExpandData expanding() const;
	void invalidate();

	void addItem(TQLayoutItem * /Transfer/);
	void addItem(TQLayoutItem * /Transfer/,int,int);
	void addMultiCell(TQLayoutItem * /Transfer/,int,int,int,int,int = 0);

	void addWidget(TQWidget *,int,int,int = 0);
	void addMultiCellWidget(TQWidget *,int,int,int,int,int = 0);
	void addLayout(TQLayout * /Transfer/,int,int);
	void addMultiCellLayout(TQLayout * /Transfer/,int,int,int,int,int = 0);
	void addRowSpacing(int,int);
	void addColSpacing(int,int);
	void expand(int,int);

	enum Corner {
		TopLeft,
		TopRight,
		BottomLeft,
		BottomRight
	};

	void setOrigin(Corner);
	Corner origin() const;
	TQLayoutIterator iterator();
	void setGeometry(const TQRect &);

protected:
	bool findWidget(TQWidget *,int *,int *);
	void add(TQLayoutItem * /Transfer/,int,int);

private:
	TQGridLayout(const TQGridLayout &);
};


class TQBoxLayout : TQLayout
{
%TypeHeaderCode
#include <tqlayout.h>
%End

public:
	enum Direction {
		LeftToRight,
		RightToLeft,
		TopToBottom,
		BottomToTop,
		Down = TopToBottom,
		Up = BottomToTop
	};

	TQBoxLayout(TQWidget * /TransferThis/,Direction,int = 0,int = -1,const char * = 0);
	TQBoxLayout(TQLayout * /TransferThis/,Direction,int = -1,const char * = 0);
	TQBoxLayout(Direction,int = -1,const char * = 0);

	Direction direction() const;
	void setDirection(Direction);
	void addSpacing(int);
	void addStretch(int = 0);
	void addLayout(TQLayout * /Transfer/,int = 0);
	void addStrut(int);
	void addItem(TQLayoutItem * /Transfer/);
	void addWidget(TQWidget *,int = 0,int = 0);
	void insertSpacing(int,int);
	void insertStretch(int,int = 0);
	void insertWidget(int,TQWidget *,int = 0,int = 0);
	void insertLayout(int,TQLayout * /Transfer/,int = 0);
	int findWidget(TQWidget *);
	bool setStretchFactor(TQWidget *,int);
	TQSize sizeHint() const;
	TQSize minimumSize() const;
	TQSize maximumSize() const;
	bool hasHeightForWidth() const;
	int heightForWidth(int) const;
	int minimumHeightForWidth(int) const;

	TQSizePolicy::ExpandData expanding() const;
	void invalidate();
	TQLayoutIterator iterator();
	void setGeometry(const TQRect &);

protected:
	void insertItem(int,TQLayoutItem * /Transfer/);

private:
	TQBoxLayout(const TQBoxLayout &);
};


class TQHBoxLayout : TQBoxLayout
{
%TypeHeaderCode
#include <tqlayout.h>
%End

public:
	TQHBoxLayout(TQWidget * /TransferThis/,int = 0,int = -1,const char * = 0);
	TQHBoxLayout(TQLayout * /TransferThis/,int = -1,const char * = 0);
	TQHBoxLayout(int = -1,const char * = 0);

private:
	TQHBoxLayout(const TQHBoxLayout &);
};


class TQVBoxLayout : TQBoxLayout
{
%TypeHeaderCode
#include <tqlayout.h>
%End

public:
	TQVBoxLayout(TQWidget * /TransferThis/,int = 0,int = -1,const char * = 0);
	TQVBoxLayout(TQLayout * /TransferThis/,int = -1,const char * = 0);
	TQVBoxLayout(int = -1,const char * = 0);

private:
	TQVBoxLayout(const TQVBoxLayout &);
};