Qyoto  4.0.6
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Properties
QtGui.QWizard Class Reference

The QWizard class provides a framework for wizards. More...

Inheritance diagram for QtGui.QWizard:
Collaboration diagram for QtGui.QWizard:

Public Types

enum  WizardButton {
  BackButton = 0, CancelButton = 4, CommitButton = 2, CustomButton1 = 6,
  CustomButton2 = 7, CustomButton3 = 8, FinishButton = 3, HelpButton = 5,
  NButtons = 9, NStandardButtons = 6, NextButton = 1, NoButton = -1,
  Stretch = 9
}
  More...
 
enum  WizardOption {
  CancelButtonOnLeft = 1024, DisabledBackButtonOnLastPage = 64, ExtendedWatermarkPixmap = 4, HaveCustomButton1 = 8192,
  HaveCustomButton2 = 16384, HaveCustomButton3 = 32768, HaveFinishButtonOnEarlyPages = 256, HaveHelpButton = 2048,
  HaveNextButtonOnLastPage = 128, HelpButtonOnRight = 4096, IgnoreSubTitles = 2, IndependentPages = 1,
  NoBackButtonOnLastPage = 32, NoBackButtonOnStartPage = 16, NoCancelButton = 512, NoDefaultButton = 8
}
  More...
 
enum  WizardPixmap {
  BackgroundPixmap = 3, BannerPixmap = 2, LogoPixmap = 1, NPixmaps = 4,
  WatermarkPixmap = 0
}
  More...
 
enum  WizardStyle {
  AeroStyle = 3, ClassicStyle = 0, MacStyle = 2, ModernStyle = 1,
  NStyles = 4
}
  More...
 
- Public Types inherited from QtGui.QDialog
enum  DialogCode { Accepted = 1, Rejected = 0 }
  More...
 
- Public Types inherited from QtGui.QWidget
enum  RenderFlag { DrawChildren = 2, DrawWindowBackground = 1, IgnoreMask = 4 }
  More...
 

Public Member Functions

 QWizard (QWidget parent=null, Qt.WindowType flags=0)
 
 
override void CreateProxy ()
 
new int AddPage (QWizardPage page)
 
 
new void Back ()
 
 
new QAbstractButton Button (QWizard.WizardButton which)
 
 
new string ButtonText (QWizard.WizardButton which)
 
 
override void Done (int result)
 
 
override bool OnEvent (QEvent @event)
 
 
new object Field (string name)
 
 
new bool HasVisitedPage (int id)
 
 
new void Next ()
 
 
new QWizardPage Page (int id)
 
 
new QPixmap Pixmap (QWizard.WizardPixmap which)
 
 
new void RemovePage (int id)
 
 
new void Restart ()
 
 
new void SetButton (QWizard.WizardButton which, QAbstractButton button)
 
 
new void SetButtonLayout (System.Collections.Generic.List< QWizard.WizardButton > layout)
 
 
new void SetButtonText (QWizard.WizardButton which, string text)
 
 
new void SetDefaultProperty (string className, string property, string changedSignal)
 
 
new void SetField (string name, object value)
 
 
new void SetOption (QWizard.WizardOption option, bool on=true)
 
 
new void SetPage (int id, QWizardPage page)
 
 
new void SetPixmap (QWizard.WizardPixmap which, QPixmap pixmap)
 
 
new bool TestOption (QWizard.WizardOption option)
 
 
virtual bool ValidateCurrentPage ()
 
 
new void Dispose ()
 
- Public Member Functions inherited from QtGui.QDialog
 QDialog (QWidget parent=null, Qt.WindowType f=0)
 
 
virtual void Accept ()
 
 
override bool EventFilter (QObject o, QEvent e)
 
 
new int Exec ()
 
 
new void Open ()
 
 
virtual void Reject ()
 
 
new void ShowExtension (bool showIt)
 
 
new void Dispose ()
 
- Public Member Functions inherited from QtGui.QWidget
 QWidget (QWidget parent=null, Qt.WindowType f=0)
 
 
new void ActivateWindow ()
 
 
new void AddAction (QAction action)
 
 
new void AddActions (System.Collections.Generic.List< QAction > actions)
 
 
new void AdjustSize ()
 
 
new QWidget ChildAt (QPoint p)
 
 
new QWidget ChildAt (int x, int y)
 
 
new void ClearFocus ()
 
 
new void ClearMask ()
 
 
new bool Close ()
 
 
new void CreateWinId ()
 
new void EnsurePolished ()
 
 
override bool OnEvent (QEvent @event)
 
 
new void GetContentsMargins (ref int left, ref int top, ref int right, ref int bottom)
 
 
new void GrabGesture (Qt.GestureType type, Qt.GestureFlag flags=0)
 
 
new void GrabKeyboard ()
 
 
new void GrabMouse ()
 
 
new void GrabMouse (QCursor cursor)
 
 
new int GrabShortcut (QKeySequence key, Qt.ShortcutContext context=Qt.ShortcutContext.WindowShortcut)
 
 
virtual int HeightForWidth (int w)
 
 
new void Hide ()
 
 
virtual object InputMethodQuery (Qt.InputMethodQuery query)
 
 
new void InsertAction (QAction before, QAction action)
 
 
new void InsertActions (QAction before, System.Collections.Generic.List< QAction > actions)
 
 
new bool IsAncestorOf (QWidget child)
 
 
new bool IsEnabledTo (QWidget ancestor)
 
 
new bool IsVisibleTo (QWidget ancestor)
 
 
new void Lower ()
 
 
new QPoint MapFrom (QWidget parent, QPoint pos)
 
 
new QPoint MapFromGlobal (QPoint pos)
 
 
new QPoint MapFromParent (QPoint pos)
 
 
new QPoint MapTo (QWidget parent, QPoint pos)
 
 
new QPoint MapToGlobal (QPoint pos)
 
 
new QPoint MapToParent (QPoint pos)
 
 
new void Move (int x, int y)
 
new void OverrideWindowFlags (Qt.WindowType type)
 
 
new void OverrideWindowState (Qt.WindowState state)
 
new void Raise ()
 
 
virtual void ReleaseDC (System.IntPtr hdc)
 
 
new void ReleaseKeyboard ()
 
 
new void ReleaseMouse ()
 
 
new void ReleaseShortcut (int id)
 
 
new void RemoveAction (QAction action)
 
 
new void Render (IQPaintDevice target)
 
 
new void Render (QPainter painter)
 
 
new void Render (IQPaintDevice target, QPoint targetOffset)
 
 
new void Render (QPainter painter, QPoint targetOffset)
 
 
new void Render (IQPaintDevice target, QPoint targetOffset, QRegion sourceRegion, QWidget.RenderFlag renderFlags=QWidget.RenderFlag.DrawWindowBackground|QWidget.RenderFlag.DrawChildren)
 
 
new void Render (QPainter painter, QPoint targetOffset, QRegion sourceRegion, QWidget.RenderFlag renderFlags=QWidget.RenderFlag.DrawWindowBackground|QWidget.RenderFlag.DrawChildren)
 
 
new void Repaint ()
 
 
new void Repaint (QRect rect)
 
 
new void Repaint (QRegion rgn)
 
 
new void Repaint (int x, int y, int w, int h)
 
 
new void Resize (int w, int h)
 
new bool RestoreGeometry (QByteArray geometry)
 
 
new void Scroll (int dx, int dy)
 
 
new void Scroll (int dx, int dy, QRect r)
 
 
new void SetAttribute (Qt.WidgetAttribute attribute, bool on=true)
 
 
new void SetBaseSize (int basew, int baseh)
 
new void SetContentsMargins (int left, int top, int right, int bottom)
 
 
new void SetDisabled (bool disable)
 
 
new void SetFixedHeight (int h)
 
 
new void SetFixedSize (QSize s)
 
 
new void SetFixedSize (int w, int h)
 
 
new void SetFixedWidth (int w)
 
 
new void SetFocus ()
 
 
new void SetFocus (Qt.FocusReason reason)
 
 
new void SetGeometry (int x, int y, int w, int h)
 
new void SetHidden (bool hidden)
 
 
new void SetMask (QBitmap bitmap)
 
 
new void SetMaximumSize (int maxw, int maxh)
 
new void SetMinimumSize (int minw, int minh)
 
new void SetParent (QWidget parent)
 
 
new void SetParent (QWidget parent, Qt.WindowType f)
 
 
new void SetShortcutAutoRepeat (int id, bool enable=true)
 
 
new void SetShortcutEnabled (int id, bool enable=true)
 
 
new void SetShown (bool shown)
 
 
new void SetSizeIncrement (int w, int h)
 
new void SetSizePolicy (QSizePolicy.Policy horizontal, QSizePolicy.Policy vertical)
 
new void Show ()
 
 
new void ShowFullScreen ()
 
 
new void ShowMaximized ()
 
 
new void ShowMinimized ()
 
 
new void ShowNormal ()
 
 
new void StackUnder (QWidget w)
 
 
new bool TestAttribute (Qt.WidgetAttribute attribute)
 
 
new void UngrabGesture (Qt.GestureType type)
 
 
new void UnsetCursor ()
 
new void UnsetLayoutDirection ()
 
new void UnsetLocale ()
 
new void Update ()
 
 
new void Update (QRect rect)
 
 
new void Update (QRegion rgn)
 
 
new void Update (int x, int y, int w, int h)
 
 
new void UpdateGeometry ()
 
 
new void Dispose ()
 
- Public Member Functions inherited from QtCore.QObject
 QObject (QObject parent=null)
 
 
new bool BlockSignals (bool b)
 
 
new bool Connect (QObject sender, string signal, string member, Qt.ConnectionType type=Qt.ConnectionType.AutoConnection)
 
 
new void DeleteLater ()
 
 
new bool Disconnect (QObject receiver, string member=null)
 
 
new bool Disconnect (string signal=null, QObject receiver=null, string member=null)
 
 
new void DumpObjectInfo ()
 
 
new void DumpObjectTree ()
 
 
virtual bool OnEvent (QEvent e)
 
 
virtual bool EventFilter (QObject watched, QEvent @event)
 
 
new bool Inherits (string classname)
 
 
new void InstallEventFilter (QObject filterObj)
 
 
new void KillTimer (int id)
 
 
new object Property (string name)
 
 
new void RemoveEventFilter (QObject obj)
 
 
new bool SetProperty (string name, object value)
 
 
new void SetUserData (uint id, QObjectUserData data)
 
new int StartTimer (int interval)
 
 
new QObjectUserData UserData (uint id)
 
new void Dispose ()
 
- Public Member Functions inherited from QtCore.Qt
delegate QTextStream FuncQTextStreamQTextStream (QTextStream qTextStream)
 
delegate void ActionQtMsgTypeString (QtMsgType qtMsgType, string @string)
 
delegate QObject FuncQObject ()
 
delegate string FuncStringQByteArray (QByteArray qByteArray)
 
delegate QByteArray FuncQByteArrayString (string @string)
 
- Public Member Functions inherited from QtGui.IQPaintDevice
void ReleaseDC (System.IntPtr hdc)
 

Static Public Member Functions

static string Tr (string s, string c=null)
 
static string Tr (string s, string c, int n)
 
static string TrUtf8 (string s, string c=null)
 
static string TrUtf8 (string s, string c, int n)
 
- Static Public Member Functions inherited from QtGui.QDialog
static string Tr (string s, string c=null)
 
static string Tr (string s, string c, int n)
 
static string TrUtf8 (string s, string c=null)
 
static string TrUtf8 (string s, string c, int n)
 
- Static Public Member Functions inherited from QtGui.QWidget
static QWidget Find (NativeULong id)
 
 
static void SetTabOrder (QWidget first, QWidget second)
 
 
static string Tr (string s, string c=null)
 
static string Tr (string s, string c, int n)
 
static string TrUtf8 (string s, string c=null)
 
static string TrUtf8 (string s, string c, int n)
 
- Static Public Member Functions inherited from QtCore.QObject
static bool Connect (QObject sender, QMetaMethod signal, QObject receiver, QMetaMethod method, Qt.ConnectionType type=Qt.ConnectionType.AutoConnection)
 
 
static bool Connect (QObject sender, string signal, QObject receiver, string member, Qt.ConnectionType type=Qt.ConnectionType.AutoConnection)
 
 
static bool Disconnect (QObject sender, QMetaMethod signal, QObject receiver, QMetaMethod member)
 
 
static bool Disconnect (QObject sender, string signal, QObject receiver, string member)
 
 
static string Tr (string s, string c=null)
 
 
static string Tr (string s, string c, int n)
 
 
static string TrUtf8 (string s, string c=null)
 
 
static string TrUtf8 (string s, string c, int n)
 
 
- Static Public Member Functions inherited from QtCore.Qt
static QDataStream Write (QDataStream s, object p)
 
static QDataStream Write (QDataStream stream, QSizeF size)
 
 
static QDataStream Write (QDataStream stream, QPoint point)
 
 
static QTextStream Write (QTextStream s, Qt.FuncQTextStreamQTextStream f)
 
static QDataStream Write (QDataStream stream, QLineF line)
 
 
static QDataStream Write (QDataStream stream, QPointF point)
 
 
static QDataStream Write (QDataStream @out, QChar chr)
 
 
static QDataStream Write (QDataStream @out, QByteArray ba)
 
 
static QDataStream Write (QDataStream stream, QEasingCurve easing)
 
 
static QDataStream Write (QDataStream stream, QRectF rectangle)
 
 
static QDataStream Write (QDataStream @out, QDateTime dateTime)
 
 
static QDataStream Write (QDataStream @out, QUrl url)
 
 
static QDataStream Write (QDataStream @out, QTime time)
 
 
static QDataStream Write (QDataStream arg1, QLocale arg2)
 
static QDataStream Write (QDataStream @out, QBitArray ba)
 
 
static QDataStream Write (QDataStream s, QUuid id)
 
 
static QDataStream Write (QDataStream stream, QLine line)
 
 
static QDataStream Write (QDataStream @out, QDate date)
 
 
static QDataStream Write (QDataStream @out, QRegExp regExp)
 
 
static QDataStream Write (QDataStream stream, QRect rectangle)
 
 
static QDataStream Write (QDataStream stream, QSize size)
 
 
static QDataStream Write (QDataStream s, QVariant.Type p)
 
static QDataStream Write (QDataStream arg1, string arg2)
 
static QDataStream Write (QDataStream @out, System.Collections.Generic.List< string > list)
 
 
static QDataStream Read (QDataStream @in, QChar chr)
 
 
static QDataStream Read (QDataStream arg1, QLocale arg2)
 
static QDataStream Read (QDataStream stream, QRect rectangle)
 
 
static QDataStream Read (QDataStream arg1, QEasingCurve arg2)
 
static QDataStream Read (QDataStream @in, QDate date)
 
 
static QDataStream Read (QDataStream @in, QUrl url)
 
 
static QDataStream Read (QDataStream s, QUuid id)
 
 
static QTextStream Read (QTextStream s, Qt.FuncQTextStreamQTextStream f)
 
static QDataStream Read (QDataStream stream, QLineF line)
 
 
static QDataStream Read (QDataStream stream, QRectF rectangle)
 
 
static QDataStream Read (QDataStream stream, QPointF point)
 
 
static QDataStream Read (QDataStream stream, QLine line)
 
 
static QDataStream Read (QDataStream @in, QBitArray ba)
 
 
static QDataStream Read (QDataStream stream, QSize size)
 
 
static QDataStream Read (QDataStream @in, QDateTime dateTime)
 
 
static QDataStream Read (QDataStream @in, QTime time)
 
 
static QDataStream Read (QDataStream stream, QPoint point)
 
 
static QDataStream Read (QDataStream @in, QRegExp regExp)
 
 
static QDataStream Read (QDataStream s, object p)
 
static QDataStream Read (QDataStream @in, QByteArray ba)
 
 
static QDataStream Read (QDataStream stream, QSizeF size)
 
 
static QDataStream Read (QDataStream arg1, string arg2)
 
static QDataStream Read (QDataStream s, QVariant.Type p)
 
static QDataStream Read (QDataStream @in, System.Collections.Generic.List< string > list)
 
 
static double QAcos (double v)
 
 
static void QAddPostRoutine (System.Action ptr)
 
 
static double QAsin (double v)
 
 
static double QAtan (double v)
 
 
static double QAtan2 (double x, double y)
 
 
static void QBadAlloc ()
 
static int QCeil (double v)
 
 
static ushort QChecksum (string s, uint len)
 
 
static QByteArray QCompress (QByteArray data, int compressionLevel=-1)
 
 
static QByteArray QCompress (Pointer< byte > data, int nbytes, int compressionLevel=-1)
 
 
static double QCos (double v)
 
 
static double QExp (double v)
 
 
static double QFabs (double v)
 
static double QFastCos (double x)
 
static double QFastSin (double x)
 
static string QFlagLocation (string method)
 
static int QFloor (double v)
 
 
static bool QFuzzyCompare (double p1, double p2)
 
static bool QFuzzyCompare (float p1, float p2)
 
static bool QFuzzyIsNull (double d)
 
static bool QFuzzyIsNull (float f)
 
static uint QHash (QBitArray key)
 
 
static uint QHash (QChar key)
 
 
static uint QHash (QStringRef key)
 
static uint QHash (QUrl url)
 
 
static uint QHash (QPersistentModelIndex index)
 
static uint QHash (QByteArray key)
 
 
static uint QHash (QModelIndex index)
 
static uint QHash (uint key)
 
 
static uint QHash (char key)
 
 
static uint QHash (byte key)
 
 
static uint QHash (short key)
 
 
static uint QHash (NativeLong key)
 
 
static uint QHash (ushort key)
 
 
static uint QHash (long key)
 
 
static uint QHash (ulong key)
 
 
static uint QHash (int key)
 
 
static uint QHash (string key)
 
 
static uint QHash (NativeULong key)
 
 
static Qt.ActionQtMsgTypeString QInstallMsgHandler (Qt.ActionQtMsgTypeString arg1)
 
static int QIntCast (float f)
 
static int QIntCast (double f)
 
static bool QIsFinite (double d)
 
static bool QIsFinite (float f)
 
static bool QIsInf (float f)
 
static bool QIsInf (double d)
 
static bool QIsNaN (float f)
 
static bool QIsNaN (double d)
 
static bool QIsNull (float f)
 
static bool QIsNull (double d)
 
static double QLn (double v)
 
 
static double QPow (double x, double y)
 
 
static void QRegisterStaticPluginInstanceFunction (Qt.FuncQObject function)
 
 
static void QRemovePostRoutine (System.Action arg1)
 
static int QRound (double d)
 
static long QRound64 (double d)
 
static double QSin (double v)
 
 
static double QSqrt (double v)
 
 
static bool QStringComparisonHelper (QStringRef s1, string s2)
 
static double QTan (double v)
 
 
static QByteArray QUncompress (QByteArray data)
 
 
static QByteArray QUncompress (Pointer< byte > data, int nbytes)
 
 
static void Qbswap_helper (Pointer< byte > src, Pointer< byte > dest, int size)
 
static QByteArray Qgetenv (string varName)
 
static bool Qputenv (string varName, QByteArray value)
 
static void Qsrand (uint seed)
 
static int Qstrcmp (QByteArray str1, QByteArray str2)
 
static int Qstrcmp (QByteArray str1, string str2)
 
static int Qstrcmp (string str1, QByteArray str2)
 
static int Qstrcmp (string str1, string str2)
 
 
static Pointer< sbyte > Qstrcpy (Pointer< sbyte > dst, string src)
 
 
static Pointer< sbyte > Qstrdup (string src)
 
 
static int Qstricmp (string str1, string str2)
 
 
static uint Qstrlen (string str)
 
 
static int Qstrncmp (string str1, string str2, uint len)
 
 
static Pointer< sbyte > Qstrncpy (Pointer< sbyte > dst, string src, uint len)
 
 
static int Qstrnicmp (string str1, string str2, uint len)
 
 
static uint Qstrnlen (string str, uint maxlen)
 
 
static string QtTrId (string id, int n=-1)
 

Protected Member Functions

 QWizard (System.Type dummy)
 
virtual void CleanupPage (int id)
 
 
new void OnCurrentIdChanged (int id)
 
 
new void OnCustomButtonClicked (int which)
 
 
new void OnHelpRequested ()
 
 
virtual void InitializePage (int id)
 
 
new void OnPageAdded (int id)
 
 
new void OnPageRemoved (int id)
 
 
override void OnPaintEvent (QPaintEvent @event)
 
 
override void OnResizeEvent (QResizeEvent @event)
 
 
- Protected Member Functions inherited from QtGui.QDialog
 QDialog (System.Type dummy)
 
new void OnAccepted ()
 
 
new void AdjustPosition (QWidget arg1)
 
override void OnCloseEvent (QCloseEvent e)
 
 
override void OnContextMenuEvent (QContextMenuEvent e)
 
 
new void OnFinished (int result)
 
 
override void OnKeyPressEvent (QKeyEvent e)
 
 
new void OnRejected ()
 
 
override void OnShowEvent (QShowEvent @event)
 
 
- Protected Member Functions inherited from QtGui.QWidget
 QWidget (System.Type dummy)
 
virtual void OnActionEvent (QActionEvent @event)
 
 
virtual void OnChangeEvent (QEvent @event)
 
 
virtual void OnCloseEvent (QCloseEvent @event)
 
 
virtual void OnContextMenuEvent (QContextMenuEvent @event)
 
 
new void Create ()
 
 
new void Create (NativeULong window, bool initializeWindow=true, bool destroyOldWindow=true)
 
 
new void OnCustomContextMenuRequested (QPoint pos)
 
 
new void Destroy (bool destroyWindow=true, bool destroySubWindows=true)
 
 
virtual void OnDragEnterEvent (QDragEnterEvent @event)
 
 
virtual void OnDragLeaveEvent (QDragLeaveEvent @event)
 
 
virtual void OnDragMoveEvent (QDragMoveEvent @event)
 
 
virtual void OnDropEvent (QDropEvent @event)
 
 
virtual void EnabledChange (bool arg1)
 
virtual void OnEnterEvent (QEvent @event)
 
 
virtual void OnFocusInEvent (QFocusEvent @event)
 
 
virtual bool FocusNextPrevChild (bool next)
 
 
virtual void OnFocusOutEvent (QFocusEvent @event)
 
 
virtual void FontChange (QFont arg1)
 
virtual void OnHideEvent (QHideEvent @event)
 
 
virtual void OnInputMethodEvent (QInputMethodEvent @event)
 
 
virtual void OnKeyPressEvent (QKeyEvent @event)
 
 
virtual void OnKeyReleaseEvent (QKeyEvent @event)
 
 
virtual void LanguageChange ()
 
 
virtual void OnLeaveEvent (QEvent @event)
 
 
virtual int Metric (QPaintDevice.PaintDeviceMetric m)
 
 
virtual void OnMouseDoubleClickEvent (QMouseEvent @event)
 
 
virtual void OnMouseMoveEvent (QMouseEvent @event)
 
 
virtual void OnMousePressEvent (QMouseEvent @event)
 
 
virtual void OnMouseReleaseEvent (QMouseEvent @event)
 
 
virtual void OnMoveEvent (QMoveEvent @event)
 
 
virtual void PaletteChange (QPalette arg1)
 
new void ResetInputContext ()
 
 
virtual void StyleChange (QStyle arg1)
 
virtual void OnTabletEvent (QTabletEvent @event)
 
 
new void UpdateMicroFocus ()
 
 
virtual void OnWheelEvent (QWheelEvent @event)
 
 
virtual void WindowActivationChange (bool arg1)
 
- Protected Member Functions inherited from QtCore.QObject
 QObject (System.Type dummy)
 
virtual void OnChildEvent (QChildEvent @event)
 
 
virtual void ConnectNotify (string signal)
 
 
virtual void OnCustomEvent (QEvent @event)
 
 
new void OnDestroyed (QObject obj=null)
 
 
virtual void DisconnectNotify (string signal)
 
 
new int Receivers (string signal)
 
 
virtual void OnTimerEvent (QTimerEvent @event)
 
 

Properties

Slot< System.Int32 > CurrentIdChanged
 
 
Slot HelpRequested
 
 
Slot< System.Int32 > CustomButtonClicked
 
 
Slot< System.Int32 > PageAdded
 
 
Slot< System.Int32 > PageRemoved
 
 
QWidget SideWidget [get, set]
 
 
override bool Visible [get, set]
 
 
override QSize SizeHint [get]
 
 
QWizardPage CurrentPage [get]
 
 
virtual int NextId [get]
 
 
System.Collections.Generic.List
< System.Int32 > 
PageIds [get]
 
 
System.Collections.Generic.List
< System.Int32 > 
VisitedPages [get]
 
 
new WizardStyle wizardStyle [get, set]
 
 
new QWizard.WizardOption Options [get, set]
 
 
new Qt.TextFormat TitleFormat [get, set]
 
 
new Qt.TextFormat SubTitleFormat [get, set]
 
 
new int StartId [get, set]
 
 
new int CurrentId [get]
 
 
static new QMetaObject StaticMetaObject [get]
 
new IQWizardSignals Emit [get]
 
- Properties inherited from QtGui.QDialog
Slot< System.Int32 > Finished
 
 
Slot Accepted
 
 
Slot Rejected
 
 
QWidget Extension [get, set]
 
 
Qt.Orientation Orientation [get, set]
 
 
int Result [get, set]
 
 
override bool Visible [get, set]
 
 
override QSize MinimumSizeHint [get]
 
 
override QSize SizeHint [get]
 
 
new bool SizeGripEnabled [get, set]
 
 
static new QMetaObject StaticMetaObject [get]
 
new IQDialogSignals Emit [get]
 
- Properties inherited from QtGui.QWidget
virtual EventHandler
< QEventArgs< QActionEvent > > 
ActionEvent
 
 
virtual EventHandler
< QEventArgs< QEvent > > 
ChangeEvent
 
 
virtual EventHandler
< QEventArgs< QCloseEvent > > 
CloseEvent
 
 
virtual EventHandler
< QEventArgs
< QContextMenuEvent > > 
ContextMenuEvent
 
 
virtual EventHandler
< QEventArgs< QDragEnterEvent > > 
DragEnterEvent
 
 
virtual EventHandler
< QEventArgs< QDragLeaveEvent > > 
DragLeaveEvent
 
 
virtual EventHandler
< QEventArgs< QDragMoveEvent > > 
DragMoveEvent
 
 
virtual EventHandler
< QEventArgs< QDropEvent > > 
DropEvent
 
 
virtual EventHandler
< QEventArgs< QEvent > > 
EnterEvent
 
 
virtual EventHandler
< QEventArgs< QFocusEvent > > 
FocusInEvent
 
 
virtual EventHandler
< QEventArgs< QFocusEvent > > 
FocusOutEvent
 
 
virtual EventHandler
< QEventArgs< QHideEvent > > 
HideEvent
 
 
virtual EventHandler
< QEventArgs
< QInputMethodEvent > > 
InputMethodEvent
 
 
virtual EventHandler
< QEventArgs< QKeyEvent > > 
KeyPressEvent
 
 
virtual EventHandler
< QEventArgs< QKeyEvent > > 
KeyReleaseEvent
 
 
virtual EventHandler
< QEventArgs< QEvent > > 
LeaveEvent
 
 
virtual EventHandler
< QEventArgs< QMouseEvent > > 
MouseDoubleClickEvent
 
 
virtual EventHandler
< QEventArgs< QMouseEvent > > 
MouseMoveEvent
 
 
virtual EventHandler
< QEventArgs< QMouseEvent > > 
MousePressEvent
 
 
virtual EventHandler
< QEventArgs< QMouseEvent > > 
MouseReleaseEvent
 
 
virtual EventHandler
< QEventArgs< QMoveEvent > > 
MoveEvent
 
 
virtual EventHandler
< QEventArgs< QPaintEvent > > 
PaintEvent
 
 
virtual EventHandler
< QEventArgs< QResizeEvent > > 
ResizeEvent
 
 
virtual EventHandler
< QEventArgs< QShowEvent > > 
ShowEvent
 
 
virtual EventHandler
< QEventArgs< QTabletEvent > > 
TabletEvent
 
 
virtual EventHandler
< QEventArgs< QWheelEvent > > 
WheelEvent
 
 
Slot< QPointCustomContextMenuRequested
 
 
QPalette.ColorRole BackgroundRole [get, set]
 
 
QMargins ContentsMargins [get, set]
 
 
QWidget FocusProxy [get, set]
 
 
QPalette.ColorRole ForegroundRole [get, set]
 
 
QGraphicsEffect GraphicsEffect [get, set]
 
 
QInputContext InputContext [get, set]
 
 
QLayout Layout [get, set]
 
 
QRegion Mask [get, set]
 
 
QStyle Style [get, set]
 
 
Qt.WindowType WindowFlags [get, set]
 
string WindowRole [get, set]
 
 
Qt.WindowState WindowState [get, set]
 
 
virtual int DevType [get]
 
virtual System.IntPtr GetDC [get]
 
 
virtual QPaintEngine PaintEngine [get]
 
 
int ColorCount [get]
 
int Depth [get]
 
int HeightMM [get]
 
int LogicalDpiX [get]
 
int LogicalDpiY [get]
 
int NumColors [get]
 
bool PaintingActive [get]
 
int PhysicalDpiX [get]
 
int PhysicalDpiY [get]
 
int WidthMM [get]
 
System.Collections.Generic.List
< QAction
Actions [get]
 
 
QRect ContentsRect [get]
 
 
NativeULong EffectiveWinId [get]
 
 
bool FocusNextChild [get]
 
 
bool FocusPreviousChild [get]
 
 
QWidget FocusWidget [get]
 
 
QFontInfo FontInfo [get]
 
 
QFontMetrics FontMetrics [get]
 
 
QGraphicsProxyWidget GraphicsProxyWidget [get]
 
 
NativeULong InternalWinId [get]
 
bool IsEnabledToTLW [get]
 
 
bool IsHidden [get]
 
 
bool IsLeftToRight [get]
 
bool IsRightToLeft [get]
 
bool IsTopLevel [get]
 
 
bool IsWindow [get]
 
 
static QWidget KeyboardGrabber [get]
 
 
virtual QSize MinimumSizeHint [get]
 
static QWidget MouseGrabber [get]
 
 
QWidget NativeParentWidget [get]
 
 
QWidget NextInFocusChain [get]
 
 
QWidget ParentWidget [get]
 
 
QWidget PreviousInFocusChain [get]
 
 
QByteArray SaveGeometry [get]
 
 
virtual QSize SizeHint [get]
 
QWidget TopLevelWidget [get]
 
 
bool UnderMouse [get]
 
 
QRegion VisibleRegion [get]
 
 
NativeULong WinId [get]
 
 
QWidget Window [get]
 
 
Qt.WindowType WindowType [get]
 
 
new bool Modal [get]
 
 
new Qt.WindowModality WindowModality [get, set]
 
 
new bool Enabled [get, set]
 
 
new QRect Geometry [get, set]
 
 
new QRect FrameGeometry [get]
 
 
new QRect NormalGeometry [get]
 
 
new int X [get]
 
 
new int Y [get]
 
 
new QPoint Pos [get, set]
 
 
new QSize FrameSize [get]
 
 
new QSize Size [get, set]
 
 
new int Width [get]
 
 
new int Height [get]
 
 
new QRect Rect [get]
 
 
new QRect ChildrenRect [get]
 
 
new QRegion ChildrenRegion [get]
 
 
new QSizePolicy SizePolicy [get, set]
 
 
new QSize MinimumSize [get, set]
 
 
new QSize MaximumSize [get, set]
 
 
new int MinimumWidth [get, set]
 
 
new int MinimumHeight [get, set]
 
 
new int MaximumWidth [get, set]
 
 
new int MaximumHeight [get, set]
 
 
new QSize SizeIncrement [get, set]
 
 
new QSize BaseSize [get, set]
 
 
new QPalette Palette [get, set]
 
 
new QFont Font [get, set]
 
 
new QCursor Cursor [get, set]
 
 
new bool MouseTracking [get, set]
 
 
new bool IsActiveWindow [get]
 
 
new Qt.FocusPolicy FocusPolicy [get, set]
 
 
new bool Focus [get]
 
 
new Qt.ContextMenuPolicy ContextMenuPolicy [get, set]
 
 
new bool UpdatesEnabled [get, set]
 
 
virtual new bool Visible [get, set]
 
 
new bool Minimized [get]
 
 
new bool Maximized [get]
 
 
new bool FullScreen [get]
 
 
new bool AcceptDrops [get, set]
 
 
new string WindowTitle [get, set]
 
 
new QIcon WindowIcon [get, set]
 
 
new string WindowIconText [get, set]
 
 
new double WindowOpacity [get, set]
 
 
new bool WindowModified [get, set]
 
 
new string ToolTip [get, set]
 
 
new string StatusTip [get, set]
 
 
new string WhatsThis [get, set]
 
 
new string AccessibleName [get, set]
 
 
new string AccessibleDescription [get, set]
 
 
new Qt.LayoutDirection LayoutDirection [get, set]
 
 
new bool AutoFillBackground [get, set]
 
 
new string StyleSheet [get, set]
 
 
new QLocale Locale [get, set]
 
 
new string WindowFilePath [get, set]
 
 
new Qt.InputMethodHint InputMethodHints [get, set]
 
 
static new QMetaObject StaticMetaObject [get]
 
new ushort Painters [get, set]
 
new IQWidgetSignals Emit [get]
 
- Properties inherited from QtCore.QObject
virtual EventHandler
< QEventArgs< QChildEvent > > 
ChildEvent
 
 
virtual EventHandler
< QEventArgs< QEvent > > 
CustomEvent
 
 
virtual EventHandler
< QEventArgs< QEvent > > 
Event
 
 
virtual EventHandler
< QEventArgs< QTimerEvent > > 
TimerEvent
 
 
Slot< QObjectDestroyedQObject
 
Slot Destroyed
 
 
QObject Parent [get, set]
 
 
System.Collections.Generic.List
< QObject
Children [get]
 
 
System.Collections.Generic.List
< QByteArray
DynamicPropertyNames [get]
 
 
bool IsWidgetType [get]
 
 
static uint RegisterUserData [get]
 
QObject Sender [get]
 
 
int SenderSignalIndex [get]
 
 
bool SignalsBlocked [get]
 
 
virtual System.IntPtr SmokeObject [get, set]
 
new string ObjectName [get, set]
 
 
static new QMetaObject StaticMetaObject [get]
 
 
static new QMetaObject StaticQtMetaObject [get]
 
new IQObjectSignals Emit [get]
 
- Properties inherited from QtCore.Qt
static string QAppName [get]
 
static double QInf [get]
 
static double QQNaN [get]
 
static double QSNaN [get]
 
static bool QSharedBuild [get]
 
static string QVersion [get]
 
static int Qrand [get]
 
- Properties inherited from QtGui.IQPaintDevice
System.Int32 ColorCount [get]
 
 
System.Int32 Depth [get]
 
 
System.Int32 DevType [get]
 
System.IntPtr GetDC [get]
 
System.Int32 Height [get]
 
 
System.Int32 HeightMM [get]
 
 
System.Int32 LogicalDpiX [get]
 
 
System.Int32 LogicalDpiY [get]
 
 
System.Int32 NumColors [get]
 
 
QPaintEngine PaintEngine [get]
 
 
System.Boolean PaintingActive [get]
 
 
System.Int32 PhysicalDpiX [get]
 
 
System.Int32 PhysicalDpiY [get]
 
 
System.Int32 Width [get]
 
 
System.Int32 WidthMM [get]
 
 

Additional Inherited Members

- Protected Attributes inherited from QtCore.QObject
object Q_EMIT = null
 
SmokeInvocation interceptor
 
readonly List< QEventHandler > eventFilters = new List<QEventHandler>()
 

Detailed Description

The QWizard class provides a framework for wizards.

A wizard (also called an assistant on Mac OS X) is a special type of input dialog that consists of a sequence of pages. A wizard's purpose is to guide the user through a process step by step. Wizards are useful for complex or infrequent tasks that users may find difficult to learn.

QWizard inherits QDialog and represents a wizard. Each page is a QWizardPage (a QWidget subclass). To create your own wizards, you can use these classes directly, or you can subclass them for more control.

Topics:

A Trivial Example

The following example illustrates how to create wizard pages and add them to a wizard. For more advanced examples, see Class Wizard and License Wizard.

QWizardPage createIntroPage()

{

QWizardPage *page = new QWizardPage;

page->setTitle("Introduction");

QLabel *label = new QLabel("This wizard will help you register your copy "

"of Super Product Two.");

label->setWordWrap(true);

QVBoxLayout *layout = new QVBoxLayout;

layout->addWidget(label);

page->setLayout(layout);

return page;

}

QWizardPage *createRegistrationPage()

{

...

}

QWizardPage *createConclusionPage()

{

...

}

int main(int argc, char *argv[])

{

QApplication app(argc, argv);

QString translatorFileName = QLatin1String("qt_");

translatorFileName += QLocale::system().name();

QTranslator *translator = new QTranslator(&app);

if (translator->load(translatorFileName, QLibraryInfo::location(QLibraryInfo::TranslationsPath)))

app.installTranslator(translator);

QWizard wizard;

wizard.addPage(createIntroPage());

wizard.addPage(createRegistrationPage());

wizard.addPage(createConclusionPage());

wizard.setWindowTitle("Trivial Wizard");

#ifdef Q_OS_SYMBIAN

wizard.showMaximized();

else

wizard.show();

#endif

return app.exec();

}

Wizard Look and Feel

QWizard supports four wizard looks:

ClassicStyle

ModernStyle

MacStyle

AeroStyle

You can explicitly set the look to use using setWizardStyle() (e.g., if you want the same look on all platforms).

ClassicStyleModernStyleMacStyleAeroStyle

Note: AeroStyle has effect only on a Windows Vista system with alpha compositing enabled. ModernStyle is used as a fallback when this condition is not met.

In addition to the wizard style, there are several options that control the look and feel of the wizard. These can be set using setOption() or setOptions(). For example, HaveHelpButton makes QWizard show a Help button along with the other wizard buttons.

You can even change the order of the wizard buttons to any arbitrary order using setButtonLayout(), and you can add up to three custom buttons (e.g., a Print button) to the button row. This is achieved by calling setButton() or setButtonText() with CustomButton1, CustomButton2, or CustomButton3 to set up the button, and by enabling the HaveCustomButton1, HaveCustomButton2, or HaveCustomButton3 options. Whenever the user clicks a custom button, customButtonClicked() is emitted. For example:

wizard()->setButtonText(QWizard::CustomButton1, tr("&Print"));

wizard()->setOption(QWizard::HaveCustomButton1, true);

connect(wizard(), SIGNAL(customButtonClicked(int)),

this, SLOT(printButtonClicked()));

Elements of a Wizard Page

Wizards consist of a sequence of QWizardPages. At any time, only one page is shown. A page has the following attributes:

A title.

A subTitle.

A set of pixmaps, which may or may not be honored, depending on the wizard's style:

WatermarkPixmap (used by ClassicStyle and ModernStyle)

BannerPixmap (used by ModernStyle)

LogoPixmap (used by ClassicStyle and ModernStyle)

BackgroundPixmap (used by MacStyle)

The diagram belows shows how QWizard renders these attributes, assuming they are all present and ModernStyle is used:

When a subTitle is set, QWizard displays it in a header, in which case it also uses the BannerPixmap and the LogoPixmap to decorate the header. The WatermarkPixmap is displayed on the left side, below the header. At the bottom, there is a row of buttons allowing the user to navigate through the pages.

The page itself (the QWizardPage widget) occupies the area between the header, the watermark, and the button row. Typically, the page is a QWizardPage on which a QGridLayout is installed, with standard child widgets (QLabels, QLineEdits, etc.).

If the wizard's style is MacStyle, the page looks radically different:

The watermark, banner, and logo pixmaps are ignored by the MacStyle. If the BackgroundPixmap is set, it is used as the background for the wizard; otherwise, a default "assistant" image is used.

The title and subtitle are set by calling QWizardPage::setTitle() and QWizardPage::setSubTitle() on the individual pages. They may be plain text or HTML (see titleFormat and subTitleFormat). The pixmaps can be set globally for the entire wizard using setPixmap(), or on a per-page basis using QWizardPage::setPixmap().

Registering and Using Fields

In many wizards, the contents of a page may affect the default values of the fields of a later page. To make it easy to communicate between pages, QWizard supports a "field" mechanism that allows you to register a field (e.g., a QLineEdit) on a page and to access its value from any page. It is also possible to specify mandatory fields (i.e., fields that must be filled before the user can advance to the next page).

To register a field, call QWizardPage::registerField() field. For example:

ClassInfoPage::ClassInfoPage(QWidget *parent)

: QWizardPage(parent)

{

...

classNameLabel = new QLabel(tr("&Class name:"));

classNameLineEdit = new QLineEdit;

classNameLabel->setBuddy(classNameLineEdit);

baseClassLabel = new QLabel(tr("B&ase class:"));

baseClassLineEdit = new QLineEdit;

baseClassLabel->setBuddy(baseClassLineEdit);

qobjectMacroCheckBox = new QCheckBox(tr("Generate Q_OBJECT &macro"));

registerField("className", classNameLineEdit);

registerField("baseClass", baseClassLineEdit);

registerField("qobjectMacro", qobjectMacroCheckBox);

...

}

The above code registers three fields, className, baseClass, and qobjectMacro, which are associated with three child widgets. The asterisk (*) next to className denotes a mandatory field.

The fields of any page are accessible from any other page. For example:

void OutputFilesPage::initializePage()

{

QString className = field("className").toString();

headerLineEdit->setText(className.toLower() + ".h");

implementationLineEdit->setText(className.toLower() + ".cpp");

outputDirLineEdit->setText(QDir::convertSeparators(QDir::tempPath()));

}

Here, we call QWizardPage::field() to access the contents of the className field (which was defined in the ClassInfoPage) and use it to initialize the OuputFilePage. The field's contents is returned as a QVariant.

When we create a field using QWizardPage::registerField(), we pass a unique field name and a widget. We can also provide a Qt property name and a "changed" signal (a signal that is emitted when the property changes) as third and fourth arguments; however, this is not necessary for the most common Qt widgets, such as QLineEdit, QCheckBox, and QComboBox, because QWizard knows which properties to look for.

If an asterisk (*) is appended to the name when the property is registered, the field is a mandatory field. When a page has mandatory fields, the Next and/or Finish buttons are enabled only when all mandatory fields are filled.

To consider a field "filled", QWizard simply checks that the field's current value doesn't equal the original value (the value it had when initializePage() was called). For QLineEdit and QAbstractSpinBox subclasses, QWizard also checks that hasAcceptableInput() returns true, to honor any validator or mask.

QWizard's mandatory field mechanism is provided for convenience. A more powerful (but also more cumbersome) alternative is to reimplement QWizardPage::isComplete() and to emit the QWizardPage::completeChanged() signal whenever the page becomes complete or incomplete.

The enabled/disabled state of the Next and/or Finish buttons is one way to perform validation on the user input. Another way is to reimplement validateCurrentPage() (or QWizardPage::validatePage()) to perform some last-minute validation (and show an error message if the user has entered incomplete or invalid information). If the function returns true, the next page is shown (or the wizard finishes); otherwise, the current page stays up.

Creating Linear Wizards

Most wizards have a linear structure, with page 1 followed by page 2 and so on until the last page. The Class Wizard example is such a wizard. With QWizard, linear wizards are created by instantiating the QWizardPages and inserting them using addPage(). By default, the pages are shown in the order in which they were added. For example:

ClassWizard::ClassWizard(QWidget *parent)

: QWizard(parent)

{

addPage(new IntroPage);

addPage(new ClassInfoPage);

addPage(new CodeStylePage);

addPage(new OutputFilesPage);

addPage(new ConclusionPage);

...

}

When a page is about to be shown, QWizard calls initializePage() (which in turn calls QWizardPage::initializePage()) to fill the page with default values. By default, this function does nothing, but it can be reimplemented to initialize the page's contents based on other pages' fields (see the example above).

If the user presses Back, cleanupPage() is called (which in turn calls QWizardPage::cleanupPage()). The default implementation resets the page's fields to their original values (the values they had before initializePage() was called). If you want the Back button to be non-destructive and keep the values entered by the user, simply enable the IndependentPages option.

Creating Non-Linear Wizards

Some wizards are more complex in that they allow different traversal paths based on the information provided by the user. The License Wizard example illustrates this. It provides five wizard pages; depending on which options are selected, the user can reach different pages.

In complex wizards, pages are identified by IDs. These IDs are typically defined using an enum. For example:

class LicenseWizard : public QWizard

{

...

enum { Page_Intro, Page_Evaluate, Page_Register, Page_Details,

Page_Conclusion };

...

};

The pages are inserted using setPage(), which takes an ID and an instance of QWizardPage (or of a subclass):

LicenseWizard::LicenseWizard(QWidget *parent)

: QWizard(parent)

{

setPage(Page_Intro, new IntroPage);

setPage(Page_Evaluate, new EvaluatePage);

setPage(Page_Register, new RegisterPage);

setPage(Page_Details, new DetailsPage);

setPage(Page_Conclusion, new ConclusionPage);

...

}

By default, the pages are shown in increasing ID order. To provide a dynamic order that depends on the options chosen by the user, we must reimplement QWizardPage::nextId(). For example:

int IntroPage::nextId() const

{

if (evaluateRadioButton->isChecked()) {

return LicenseWizard::Page_Evaluate;

} else {

return LicenseWizard::Page_Register;

}

}

int EvaluatePage::nextId() const

{

return LicenseWizard::Page_Conclusion;

}

int RegisterPage::nextId() const

{

if (upgradeKeyLineEdit->text().isEmpty()) {

return LicenseWizard::Page_Details;

} else {

return LicenseWizard::Page_Conclusion;

}

}

int DetailsPage::nextId() const

{

return LicenseWizard::Page_Conclusion;

}

int ConclusionPage::nextId() const

{

return -1;

}

It would also be possible to put all the logic in one place, in a QWizard::nextId() reimplementation. For example:

int LicenseWizard::nextId() const

{

switch (currentId()) {

case Page_Intro:

if (field("intro.evaluate").toBool()) {

return Page_Evaluate;

} else {

return Page_Register;

}

case Page_Evaluate:

return Page_Conclusion;

case Page_Register:

if (field("register.upgradeKey").toString().isEmpty()) {

return Page_Details;

} else {

return Page_Conclusion;

}

case Page_Details:

return Page_Conclusion;

case Page_Conclusion:

default:

return -1;

}

}

To start at another page than the page with the lowest ID, call setStartId().

To test whether a page has been visited or not, call hasVisitedPage(). For example:

void ConclusionPage::initializePage()

{

QString licenseText;

if (wizard()->hasVisitedPage(LicenseWizard::Page_Evaluate)) {

licenseText = tr("<u>Evaluation License Agreement:</u> "

"You can use this software for 30 days and make one "

"backup, but you are not allowed to distribute it.");

} else if (wizard()->hasVisitedPage(LicenseWizard::Page_Details)) {

licenseText = tr("<u>First-Time License Agreement:</u> "

"You can use this software subject to the license "

"you will receive by email.");

} else {

licenseText = tr("<u>Upgrade License Agreement:</u> "

"This software is licensed under the terms of your "

"current license.");

}

bottomLabel->setText(licenseText);

}

See also QWizardPage, Class Wizard Example, and License Wizard Example.

Member Enumeration Documentation

This enum specifies the buttons in a wizard.

The following value is only useful when calling setButtonLayout():

See also setButton(), setButtonText(), setButtonLayout(), and customButtonClicked().

Enumerator:
BackButton 

The Back button (Go Back on Mac OS X)

CancelButton 

The Cancel button (see also NoCancelButton)

CommitButton 

The Commit button

CustomButton1 

The first user-defined button (see also HaveCustomButton1)

CustomButton2 

The second user-defined button (see also HaveCustomButton2)

CustomButton3 

The third user-defined button (see also HaveCustomButton3)

FinishButton 

The Finish button (Done on Mac OS X)

HelpButton 

The Help button (see also HaveHelpButton)

NButtons 
NStandardButtons 
NextButton 

The Next button (Continue on Mac OS X)

NoButton 
Stretch 

A horizontal stretch in the button layout

This enum specifies various options that affect the look and feel of a wizard.

See also setOptions(), setOption(), and testOption().

Enumerator:
CancelButtonOnLeft 

Put the Cancel button on the left of Back (rather than on the right of Finish or Next).

DisabledBackButtonOnLastPage 

Disable the Back button on the last page.

ExtendedWatermarkPixmap 

Extend any WatermarkPixmap all the way down to the window's edge.

HaveCustomButton1 

Show the first user-defined button (CustomButton1).

HaveCustomButton2 

Show the second user-defined button (CustomButton2).

HaveCustomButton3 

Show the third user-defined button (CustomButton3).

HaveFinishButtonOnEarlyPages 

Show the (disabled) Finish button on non-final pages.

HaveHelpButton 

Show the Help button.

HaveNextButtonOnLastPage 

Show the (disabled) Next button on the last page.

HelpButtonOnRight 

Put the Help button on the far right of the button layout (rather than on the far left).

IgnoreSubTitles 

Don't show any subtitles, even if they are set.

IndependentPages 

The pages are independent of each other (i.e., they don't derive values from each other).

NoBackButtonOnLastPage 

Don't show the Back button on the last page.

NoBackButtonOnStartPage 

Don't show the Back button on the start page.

NoCancelButton 

Don't show the Cancel button.

NoDefaultButton 

Don't make the Next or Finish button the dialog's default button.

This enum specifies the pixmaps that can be associated with a page.

See also setPixmap(), QWizardPage::setPixmap(), and Elements of a Wizard Page.

Enumerator:
BackgroundPixmap 

The pixmap that occupies the background of a MacStyle wizard

BannerPixmap 

The pixmap that occupies the background of a ModernStyle page header

LogoPixmap 

The small pixmap on the right side of a ClassicStyle or ModernStyle page header

NPixmaps 
WatermarkPixmap 

The tall pixmap on the left side of a ClassicStyle or ModernStyle page

This enum specifies the different looks supported by QWizard.

See also setWizardStyle(), WizardOption, and Wizard Look and Feel.

Enumerator:
AeroStyle 

Windows Aero look

ClassicStyle 

Classic Windows look

MacStyle 

Mac OS X look

ModernStyle 

Modern Windows look

NStyles 

Constructor & Destructor Documentation

QtGui.QWizard.QWizard ( System.Type  dummy)
protected
QtGui.QWizard.QWizard ( QWidget  parent = null,
Qt.WindowType  flags = 0 
)

Constructs a wizard with the given parent and window flags.

See also parent() and windowFlags().

Member Function Documentation

new int QtGui.QWizard.AddPage ( QWizardPage  page)

Adds the given page to the wizard, and returns the page's ID.

The ID is guaranteed to be larger than any other ID in the QWizard so far.

See also setPage(), page(), and pageAdded().

new void QtGui.QWizard.Back ( )

Goes back to the previous page.

This is equivalent to pressing the Back button.

See also next(), accept(), reject(), and restart().

new QAbstractButton QtGui.QWizard.Button ( QWizard.WizardButton  which)

Returns the button corresponding to role which.

See also setButton() and setButtonText().

new string QtGui.QWizard.ButtonText ( QWizard.WizardButton  which)

Returns the text on button which.

If a text has ben set using setButtonText(), this text is returned.

By default, the text on buttons depends on the wizardStyle. For example, on Mac OS X, the Next button is called Continue.

See also button(), setButton(), setButtonText(), QWizardPage::buttonText(), and QWizardPage::setButtonText().

virtual void QtGui.QWizard.CleanupPage ( int  id)
protectedvirtual

This virtual function is called by QWizard to clean up page id just before the user leaves it by clicking Back (unless the QWizard::IndependentPages option is set).

The default implementation calls QWizardPage::cleanupPage() on page(id).

See also QWizardPage::cleanupPage() and initializePage().

override void QtGui.QWizard.CreateProxy ( )
virtual

Reimplemented from QtGui.QDialog.

new void QtGui.QWizard.Dispose ( )
override void QtGui.QWizard.Done ( int  result)
virtual

Reimplemented from QDialog::done().

Reimplemented from QtGui.QDialog.

new object QtGui.QWizard.Field ( string  name)

Returns the value of the field called name.

This function can be used to access fields on any page of the wizard.

See also QWizardPage::registerField(), QWizardPage::field(), and setField().

new bool QtGui.QWizard.HasVisitedPage ( int  id)

Returns true if the page history contains page id; otherwise, returns false.

Pressing Back marks the current page as "unvisited" again.

See also visitedPages().

virtual void QtGui.QWizard.InitializePage ( int  id)
protectedvirtual

This virtual function is called by QWizard to prepare page id just before it is shown either as a result of QWizard::restart() being called, or as a result of the user clicking Next. (However, if the QWizard::IndependentPages option is set, this function is only called the first time the page is shown.)

By reimplementing this function, you can ensure that the page's fields are properly initialized based on fields from previous pages.

The default implementation calls QWizardPage::initializePage() on page(id).

See also QWizardPage::initializePage() and cleanupPage().

new void QtGui.QWizard.Next ( )

Advances to the next page.

This is equivalent to pressing the Next or Commit button.

See also nextId(), back(), accept(), reject(), and restart().

new void QtGui.QWizard.OnCurrentIdChanged ( int  id)
protected

This signal is emitted when the current page changes, with the new current id.

See also currentId() and currentPage().

new void QtGui.QWizard.OnCustomButtonClicked ( int  which)
protected

This signal is emitted when the user clicks a custom button. which can be CustomButton1, CustomButton2, or CustomButton3.

By default, no custom button is shown. Call setOption() with HaveCustomButton1, HaveCustomButton2, or HaveCustomButton3 to have one, and use setButtonText() or setButton() to configure it.

See also helpRequested().

override bool QtGui.QWizard.OnEvent ( QEvent event)

Reimplemented from QObject::event().

new void QtGui.QWizard.OnHelpRequested ( )
protected

This signal is emitted when the user clicks the Help button.

By default, no Help button is shown. Call setOption(HaveHelpButton, true) to have one.

Example:

LicenseWizard::LicenseWizard(QWidget *parent)

: QWizard(parent)

{

...

setOption(HaveHelpButton, true);

connect(this, SIGNAL(helpRequested()), this, SLOT(showHelp()));

...

}

void LicenseWizard::showHelp()

{

static QString lastHelpMessage;

QString message;

switch (currentId()) {

case Page_Intro:

message = tr("The decision you make here will affect which page you "

"get to see next.");

break;

...

default:

message = tr("This help is likely not to be of any help.");

}

QMessageBox::information(this, tr("License Wizard Help"), message);

}

See also customButtonClicked().

new void QtGui.QWizard.OnPageAdded ( int  id)
protected

This signal is emitted whenever a page is added to the wizard. The page's id is passed as parameter.

This function was introduced in Qt 4.7.

See also addPage(), setPage(), and startId().

new void QtGui.QWizard.OnPageRemoved ( int  id)
protected

This signal is emitted whenever a page is removed from the wizard. The page's id is passed as parameter.

This function was introduced in Qt 4.7.

See also removePage() and startId().

override void QtGui.QWizard.OnPaintEvent ( QPaintEvent event)
protectedvirtual

Reimplemented from QWidget::paintEvent().

Reimplemented from QtGui.QWidget.

override void QtGui.QWizard.OnResizeEvent ( QResizeEvent event)
protectedvirtual

Reimplemented from QWidget::resizeEvent().

Reimplemented from QtGui.QDialog.

new QWizardPage QtGui.QWizard.Page ( int  id)

Returns the page with the given id, or 0 if there is no such page.

See also addPage() and setPage().

new QPixmap QtGui.QWizard.Pixmap ( QWizard.WizardPixmap  which)

Returns the pixmap set for role which.

By default, the only pixmap that is set is the BackgroundPixmap on Mac OS X.

See also setPixmap(), QWizardPage::pixmap(), and Elements of a Wizard Page.

new void QtGui.QWizard.RemovePage ( int  id)

Removes the page with the given id. cleanupPage() will be called if necessary.

Note: Removing a page may influence the value of the startId property.

This function was introduced in Qt 4.5.

See also addPage(), setPage(), pageRemoved(), and startId().

new void QtGui.QWizard.Restart ( )

Restarts the wizard at the start page. This function is called automatically when the wizard is shown.

See also startId().

new void QtGui.QWizard.SetButton ( QWizard.WizardButton  which,
QAbstractButton  button 
)

Sets the button corresponding to role which to button.

To add extra buttons to the wizard (e.g., a Print button), one way is to call setButton() with CustomButton1 to CustomButton3, and make the buttons visible using the HaveCustomButton1 to HaveCustomButton3 options.

See also button(), setButtonText(), setButtonLayout(), and options.

new void QtGui.QWizard.SetButtonLayout ( System.Collections.Generic.List< QWizard.WizardButton layout)

Sets the order in which buttons are displayed to layout, where layout is a list of WizardButtons.

The default layout depends on the options (e.g., whether HelpButtonOnRight) that are set. You can call this function if you need more control over the buttons' layout than what options already provides.

You can specify horizontal stretches in the layout using Stretch.

Example:

MyWizard::MyWizard(QWidget *parent)

: QWizard(parent)

{

...

QList<QWizard::WizardButton> layout;

layout << QWizard::Stretch << QWizard::BackButton << QWizard::CancelButton

<< QWizard::NextButton << QWizard::FinishButton;

setButtonLayout(layout);

...

}

See also setButton(), setButtonText(), and setOptions().

new void QtGui.QWizard.SetButtonText ( QWizard.WizardButton  which,
string  text 
)

Sets the text on button which to be text.

By default, the text on buttons depends on the wizardStyle. For example, on Mac OS X, the Next button is called Continue.

To add extra buttons to the wizard (e.g., a Print button), one way is to call setButtonText() with CustomButton1, CustomButton2, or CustomButton3 to set their text, and make the buttons visible using the HaveCustomButton1, HaveCustomButton2, and/or HaveCustomButton3 options.

Button texts may also be set on a per-page basis using QWizardPage::setButtonText().

See also buttonText(), setButton(), button(), setButtonLayout(), setOptions(), and QWizardPage::setButtonText().

new void QtGui.QWizard.SetDefaultProperty ( string  className,
string  property,
string  changedSignal 
)

Sets the default property for className to be property, and the associated change signal to be changedSignal.

The default property is used when an instance of className (or of one of its subclasses) is passed to QWizardPage::registerField() and no property is specified.

QWizard knows the most common Qt widgets. For these (or their subclasses), you don't need to specify a property or a changedSignal. The table below lists these widgets:

WidgetPropertyChange Notification Signal

QAbstractButton bool checked toggled()

QAbstractSlider int value valueChanged()

QComboBox int currentIndex currentIndexChanged()

QDateTimeEdit QDateTime dateTime dateTimeChanged()

QLineEdit QString text textChanged()

QListWidget int currentRow currentRowChanged()

QSpinBox int value valueChanged()

See also QWizardPage::registerField().

new void QtGui.QWizard.SetField ( string  name,
object  value 
)

Sets the value of the field called name to value.

This function can be used to set fields on any page of the wizard.

See also QWizardPage::registerField(), QWizardPage::setField(), and field().

new void QtGui.QWizard.SetOption ( QWizard.WizardOption  option,
bool  on = true 
)

Sets the given option to be enabled if on is true; otherwise, clears the given option.

See also options, testOption(), and setWizardStyle().

new void QtGui.QWizard.SetPage ( int  id,
QWizardPage  page 
)

Adds the given page to the wizard with the given id.

Note: Adding a page may influence the value of the startId property in case it was not set explicitly.

See also addPage(), page(), and pageAdded().

new void QtGui.QWizard.SetPixmap ( QWizard.WizardPixmap  which,
QPixmap  pixmap 
)

Sets the pixmap for role which to pixmap.

The pixmaps are used by QWizard when displaying a page. Which pixmaps are actually used depend on the wizard style.

Pixmaps can also be set for a specific page using QWizardPage::setPixmap().

See also pixmap(), QWizardPage::setPixmap(), and Elements of a Wizard Page.

new bool QtGui.QWizard.TestOption ( QWizard.WizardOption  option)

Returns true if the given option is enabled; otherwise, returns false.

See also options, setOption(), and setWizardStyle().

static string QtGui.QWizard.Tr ( string  s,
string  c = null 
)
static
static string QtGui.QWizard.Tr ( string  s,
string  c,
int  n 
)
static
static string QtGui.QWizard.TrUtf8 ( string  s,
string  c = null 
)
static
static string QtGui.QWizard.TrUtf8 ( string  s,
string  c,
int  n 
)
static
virtual bool QtGui.QWizard.ValidateCurrentPage ( )
virtual

This virtual function is called by QWizard when the user clicks Next or Finish to perform some last-minute validation. If it returns true, the next page is shown (or the wizard finishes); otherwise, the current page stays up.

The default implementation calls QWizardPage::validatePage() on the currentPage().

When possible, it is usually better style to disable the Next or Finish button (by specifying mandatory fields or by reimplementing QWizardPage::isComplete()) than to reimplement validateCurrentPage().

See also QWizardPage::validatePage() and currentPage().

Property Documentation

new int QtGui.QWizard.CurrentId
get

This property holds the ID of the current page.

This property cannot be set directly. To change the current page, call next(), back(), or restart().

By default, this property has a value of -1, indicating that no page is currently shown.

Slot<System.Int32> QtGui.QWizard.CurrentIdChanged
addremove

This signal is emitted when the current page changes, with the new current id.

See also currentId() and currentPage().

QWizardPage QtGui.QWizard.CurrentPage
get

Returns a pointer to the current page, or 0 if there is no current page (e.g., before the wizard is shown).

This is equivalent to calling page(currentId()).

See also page(), currentId(), and restart().

Slot<System.Int32> QtGui.QWizard.CustomButtonClicked
addremove

This signal is emitted when the user clicks a custom button. which can be CustomButton1, CustomButton2, or CustomButton3.

By default, no custom button is shown. Call setOption() with HaveCustomButton1, HaveCustomButton2, or HaveCustomButton3 to have one, and use setButtonText() or setButton() to configure it.

See also helpRequested().

new IQWizardSignals QtGui.QWizard.Emit
getprotected
Slot QtGui.QWizard.HelpRequested
addremove

This signal is emitted when the user clicks the Help button.

By default, no Help button is shown. Call setOption(HaveHelpButton, true) to have one.

Example:

LicenseWizard::LicenseWizard(QWidget *parent)

: QWizard(parent)

{

...

setOption(HaveHelpButton, true);

connect(this, SIGNAL(helpRequested()), this, SLOT(showHelp()));

...

}

void LicenseWizard::showHelp()

{

static QString lastHelpMessage;

QString message;

switch (currentId()) {

case Page_Intro:

message = tr("The decision you make here will affect which page you "

"get to see next.");

break;

...

default:

message = tr("This help is likely not to be of any help.");

}

QMessageBox::information(this, tr("License Wizard Help"), message);

}

See also customButtonClicked().

virtual int QtGui.QWizard.NextId
get

This virtual function is called by QWizard to find out which page to show when the user clicks the Next button.

The return value is the ID of the next page, or -1 if no page follows.

The default implementation calls QWizardPage::nextId() on the currentPage().

By reimplementing this function, you can specify a dynamic page order.

See also QWizardPage::nextId() and currentPage().

new QWizard.WizardOption QtGui.QWizard.Options
getset

This property holds the various options that affect the look and feel of the wizard.

By default, the following options are set (depending on the platform):

Windows: HelpButtonOnRight.

Mac OS X: NoDefaultButton and NoCancelButton.

X11 and QWS (Qt for Embedded Linux): none.

Slot<System.Int32> QtGui.QWizard.PageAdded
addremove

This signal is emitted whenever a page is added to the wizard. The page's id is passed as parameter.

This function was introduced in Qt 4.7.

See also addPage(), setPage(), and startId().

System.Collections.Generic.List<System.Int32> QtGui.QWizard.PageIds
get

Returns the list of page IDs.

This function was introduced in Qt 4.5.

Slot<System.Int32> QtGui.QWizard.PageRemoved
addremove

This signal is emitted whenever a page is removed from the wizard. The page's id is passed as parameter.

This function was introduced in Qt 4.7.

See also removePage() and startId().

QWidget QtGui.QWizard.SideWidget
getset

Returns the widget on the left side of the wizard or 0.

By default, no side widget is present.

This function was introduced in Qt 4.7.

Sets the given widget to be shown on the left side of the wizard. For styles which use the WatermarkPixmap (ClassicStyle and ModernStyle) the side widget is displayed on top of the watermark, for other styles or when the watermark is not provided the side widget is displayed on the left side of the wizard.

Passing 0 shows no side widget.

When the widget is not 0 the wizard reparents it.

Any previous side widget is hidden.

You may call setSideWidget() with the same widget at different times.

All widgets set here will be deleted by the wizard when it is destroyed unless you separately reparent the widget after setting some other side widget (or 0).

By default, no side widget is present.

This function was introduced in Qt 4.7.

Reimplemented from QWidget::sizeHint().

new int QtGui.QWizard.StartId
getset

This property holds the ID of the first page.

If this property isn't explicitly set, this property defaults to the lowest page ID in this wizard, or -1 if no page has been inserted yet.

new QMetaObject QtGui.QWizard.StaticMetaObject
staticget
new Qt.TextFormat QtGui.QWizard.SubTitleFormat
getset

This property holds the text format used by page subtitles.

The default format is Qt::AutoText.

new Qt.TextFormat QtGui.QWizard.TitleFormat
getset

This property holds the text format used by page titles.

The default format is Qt::AutoText.

override bool QtGui.QWizard.Visible
getset

Reimplemented from QWidget::setVisible().

System.Collections.Generic.List<System.Int32> QtGui.QWizard.VisitedPages
get

Returns the list of IDs of visited pages, in the order in which the pages were visited.

Pressing Back marks the current page as "unvisited" again.

See also hasVisitedPage().

new WizardStyle QtGui.QWizard.wizardStyle
getset

This property holds the look and feel of the wizard.

By default, QWizard uses the AeroStyle on a Windows Vista system with alpha compositing enabled, regardless of the current widget style. If this is not the case, the default wizard style depends on the current widget style as follows: MacStyle is the default if the current widget style is QMacStyle, ModernStyle is the default if the current widget style is QWindowsStyle, and ClassicStyle is the default in all other cases.