path: root/sip/qt/qmainwindow.sip

// This is the SIP interface definition for QMainWindow.
//
// Copyright (c) 2007
// 	Riverbank Computing Limited <[email protected]>
// 
// This file is part of PyQt.
// 
// This copy of PyQt 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.
// 
// PyQt 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
// PyQt; 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>QMainWindow</Title>
<FuncSynopsis>
	<FuncDef>QTextStream &amp;<Function>operator&lt&lt;</Function></FuncDef>
	<ParamDef>QTextStream &amp;<Parameter></Parameter></ParamDef>
	<ParamDef>const QMainWindow &amp;<Parameter></Parameter></ParamDef>
</FuncSynopsis>
<Para>
This operator is fully implemented.  (Qt v3+)
</Para>

<FuncSynopsis>
	<FuncDef>QTextStream &amp;<Function>operator&gt&gt;</Function></FuncDef>
	<ParamDef>QTextStream &amp;<Parameter></Parameter></ParamDef>
	<ParamDef>QMainWindow &amp;<Parameter></Parameter></ParamDef>
</FuncSynopsis>
<Para>
This operator is fully implemented.  (Qt v3+)
</Para>

<FuncSynopsis>
	<FuncDef>bool <Function>getLocation</Function></FuncDef>
	<ParamDef>QToolBar *<Parameter>tb</Parameter></ParamDef>
	<ParamDef>ToolBarDock &amp;<Parameter>dock</Parameter></ParamDef>
	<ParamDef>int &amp;<Parameter>index</Parameter></ParamDef>
	<ParamDef>bool &amp;<Parameter>nl</Parameter></ParamDef>
	<ParamDef>int &amp;<Parameter>extraOffset</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This takes only the <Literal>tb</Literal> parameter and returns a tuple of the
result, <Literal>dock</Literal>, <Literal>index</Literal>,
<Literal>nl</Literal> and <Literal>extraOffset</Literal> values.  (Qt v2.1.0+)
</Para>

<FuncSynopsis>
	<FuncDef>QList&lt;QToolBar&gt; <Function>toolBars</Function></FuncDef>
	<ParamDef>ToolBarDock <Parameter>dock</Parameter></ParamDef>
</FuncSynopsis>
<Para>
This returns a list of <Literal>QToolBar</Literal> instances.  (Qt v2.1.0+)
</Para>
</Sect2>
%End


class QMainWindow : QWidget
{
%TypeHeaderCode
#include <qmainwindow.h>
%End

public:
%If (- Qt_2_00)
	QMainWindow(QWidget * /TransferThis/ = 0,const char * = 0,WFlags = 0);
%End
%If (Qt_2_00 -)
	QMainWindow(QWidget * /TransferThis/ = 0,const char * = 0,WFlags = WType_TopLevel);
%End

	QMenuBar *menuBar() const;
	QStatusBar *statusBar() const;
	QToolTipGroup *toolTipGroup() const;
	virtual void setCentralWidget(QWidget *);
	QWidget *centralWidget() const;

%If (- Qt_2_1_0)
	enum ToolBarDock {
		Unmanaged,
		TornOff,
		Top,
		Bottom,
		Right,
		Left
	};
%End
%If (Qt_2_1_0 - Qt_3_0_0)
	enum ToolBarDock {
		Unmanaged,
		TornOff,
		Top,
		Bottom,
		Right,
		Left,
		Minimized
	};
%End

%If (- Qt_2_00)
	void setDockEnabled(ToolBarDock,bool);
	void addToolBar(QToolBar *,const char *,ToolBarDock = Top,bool = 0);
%End
%If (Qt_2_00 - Qt_3_0_0)
	virtual void setDockEnabled(ToolBarDock,bool);
	void addToolBar(QToolBar *,ToolBarDock = Top,bool = 0);
	void addToolBar(QToolBar *,const QString &,ToolBarDock = Top,bool = 0);
	void moveToolBar(QToolBar *,ToolBarDock = Top);
%End
%If (Qt_2_1_0 - Qt_3_0_0)
	void setDockEnabled(QToolBar *,ToolBarDock,bool);
	bool isDockEnabled(QToolBar *,ToolBarDock) const;
	void moveToolBar(QToolBar *,ToolBarDock,bool,int,int = -1);
	bool toolBarsMovable() const;
%End
%If (Qt_3_0_0 -)
	virtual void setDockEnabled(Dock,bool);
%End
%If (- Qt_3_0_0)
	bool isDockEnabled(ToolBarDock) const;
	void removeToolBar(QToolBar *);
%End
%If (Qt_3_0_0 -)
	bool isDockEnabled(Dock) const;
	bool isDockEnabled(QDockArea *) const;
	virtual void setDockEnabled(QDockWindow *,Dock,bool);
	bool isDockEnabled(QDockWindow *,Dock) const;
	bool isDockEnabled(QDockWindow *,QDockArea *) const;
 
	virtual void addDockWindow(QDockWindow *,Dock = DockTop,bool = 0);
	virtual void addDockWindow(QDockWindow *,const QString &,
				   Dock = DockTop,bool = 0);
	virtual void moveDockWindow(QDockWindow *,Dock = DockTop);
	virtual void moveDockWindow(QDockWindow *,Dock,bool,int,int = -1);
	virtual void removeDockWindow(QDockWindow *);
%End

	void show();
%If (Qt_3_1_0 -)
	void hide();
%End
%If (Qt_2_1_0 -)
	QSize sizeHint() const;
	QSize minimumSizeHint() const;
%End

	bool rightJustification() const;
	bool usesBigPixmaps() const;
%If (Qt_2_1_0 -)
	bool usesTextLabel() const;
%End
%If (Qt_3_0_0 -)
	bool dockWindowsMovable() const;
%End
%If (Qt_2_1_0 -)
	bool opaqueMoving() const;
%End

	bool eventFilter(QObject *,QEvent *);

%If (Qt_3_0_0 -)
	bool getLocation(QDockWindow *,Dock &,int &,bool &,int &) const;
%End
%If (Qt_2_1_0 - Qt_3_0_0)
	bool getLocation(QToolBar *,ToolBarDock &,int &,bool &,int &) const;
%End
 
%If (Qt_2_1_0 - Qt_3_0_0)
	QList<QToolBar> toolBars(ToolBarDock) const;
%End
%If (Qt_3_0_0 -)
	QPtrList<QDockWindow> dockWindows(Dock) const;
	QPtrList<QDockWindow> dockWindows() const;
	void lineUpDockWindows(bool = 0);
%End

%If (Qt_2_1_0 -)
	void lineUpToolBars(bool = 0);
	bool isDockMenuEnabled() const;
%End

%If (Qt_3_0_0 -)
	bool hasDockWindow(QDockWindow *);
	QPtrList<QToolBar> toolBars(Dock) const;

	// The following one is in Qt3 but not documented.
	//virtual QDockArea *dockingArea(const QPoint &);
	QDockArea *leftDock() const;
	QDockArea *rightDock() const;
	QDockArea *topDock() const;
	QDockArea *bottomDock() const;
 
	virtual bool isCustomizable() const;
 
	bool appropriate(QDockWindow *) const;
 
	enum DockWindows {
		OnlyToolBars,
		NoToolBars,
		AllDockWindows
	};

	QPopupMenu *createDockWindowMenu(DockWindows = AllDockWindows) const;
%End

public slots:
%If (- Qt_2_00)
	void setRightJustification(bool);
	void setUsesBigPixmaps(bool);
%End
%If (Qt_2_00 -)
	virtual void setRightJustification(bool);
	virtual void setUsesBigPixmaps(bool);
%End
%If (Qt_2_1_0 - Qt_3_0_0)
	void setUsesTextLabel(bool);
	void setToolBarsMovable(bool);
	void setOpaqueMoving(bool);
	void setDockMenuEnabled(bool);
%End
%If (Qt_3_0_0 -)
	virtual void setUsesTextLabel(bool);
	virtual void setDockWindowsMovable(bool);
	virtual void setOpaqueMoving(bool);
	virtual void setDockMenuEnabled(bool);
%End
%If (Qt_2_00 - Qt_3_0_0)
	void whatsThis();
%End
%If (Qt_3_0_0 -)
	virtual void whatsThis();
	virtual void setAppropriate(QDockWindow *,bool);
	virtual void customize();
%End

signals:
	void pixmapSizeChanged(bool);
%If (Qt_2_1_0 -)
	void usesTextLabelChanged(bool);
%End
%If (Qt_2_1_0 - Qt_3_0_0)
	void startMovingToolBar(QToolBar *);
	void endMovingToolBar(QToolBar *);
	void toolBarPositionChanged(QToolBar *);
%End
%If (Qt_3_0_0 -)
	void dockWindowPositionChanged(QDockWindow *);
%End

protected slots:
%If (- Qt_2_00)
	void setUpLayout();
%End
%If (Qt_2_00 -)
	virtual void setUpLayout();
%End
%If (Qt_3_0_0 -)
	virtual bool showDockMenu(const QPoint &);
	void menuAboutToShow();
%End

protected:
	void paintEvent(QPaintEvent *);
%If (Qt_2_00 -)
	void childEvent(QChildEvent *);
%End
	bool event(QEvent *);
%If (Qt_2_00 - Qt_3_0_0)
	void resizeEvent(QResizeEvent *);
%End
%If (Qt_2_00 -)
	void styleChange(QStyle &);
%End

private:
%If (Qt_2_00 -)
	QMainWindow(const QMainWindow &);
%End
};