.. module:: wx.adv


.. include:: headings.inc

=========================================================================
**wx.adv**
=========================================================================

The ``wx.adv`` module contains classes which are more advanced and/or less
commonly used than those in the core namespace. They are provided in a
separate module to help reduce overhead and dependencies for those
applications which do not need any of these classes.


Class Summary
=============

================================================================================ ================================================================================
**Class**                                                                        **Short Description**
================================================================================ ================================================================================
`~wx.adv.AboutDialogInfo`                                                        :ref:`wx.adv.AboutDialogInfo`  contains information shown in the standard `About`  dialog displayed by the `wx.adv.AboutBox`       function.
`~wx.adv.ANIDecoder`                                                             An animation decoder supporting animated cursor (.ani) files.
`~wx.adv.Animation`                                                              The  :ref:`wx.adv.Animation`  class handles the interface between the animation control and the details of the animation image or data.
`~wx.adv.AnimationCtrl`                                                          This is a static control which displays an animation.
`~wx.adv.AnimationDecoder`                                                       :ref:`wx.adv.AnimationDecoder`  is used by  :ref:`wx.adv.Animation`  for loading frames and other information for the animation from the animation image file.
`~wx.adv.BannerWindow`                                                           A simple banner window showing either a bitmap or text.
`~wx.adv.BitmapComboBox`                                                         A combobox that displays bitmap in front of the list items.
`~wx.adv.CalculateLayoutEvent`                                                   This event is sent by :ref:`wx.adv.LayoutAlgorithm`  to calculate the amount of the remaining client area that the window should occupy.
`~wx.adv.CalendarCtrl`                                                           The calendar control allows the user to pick a date.
`~wx.adv.CalendarDateAttr`                                                       :ref:`wx.adv.CalendarDateAttr`  is a custom attributes for a calendar date.
`~wx.adv.CalendarEvent`                                                          The :ref:`wx.adv.CalendarEvent`  class is used together with :ref:`wx.adv.CalendarCtrl`.
`~wx.adv.CommandLinkButton`                                                      Objects of this class are similar in appearance to the normal Buttons but are similar to the links in a web page in functionality.
`~wx.adv.DateEvent`                                                              This event class holds information about a date change and is used together with :ref:`wx.adv.DatePickerCtrl`.
`~wx.adv.DatePickerCtrl`                                                         This control allows the user to select a date.
`~wx.adv.DatePickerCtrlGeneric`                                                  This control allows the user to select a date.
`~wx.adv.EditableListBox`                                                        An editable listbox is composite control that lets the user easily enter, delete and reorder a list of strings.
`~wx.adv.ExtHelpController`                                                      This class implements help via an external browser.
`~wx.adv.GenericAnimationCtrl`                                                   Generic implementation of :ref:`wx.adv.AnimationCtrl`  interface.
`~wx.adv.GenericCalendarCtrl`                                                    The calendar control allows the user to pick a date.
`~wx.adv.GIFDecoder`                                                             An animation decoder supporting animated ``GIF`` files.
`~wx.adv.HyperlinkCtrl`                                                          This class shows a static text element which links to an URL.
`~wx.adv.HyperlinkEvent`                                                         This event class is used for the events generated by :ref:`wx.adv.HyperlinkCtrl`.
`~wx.adv.Joystick`                                                               :ref:`wx.adv.Joystick`  allows an application to control one or more joysticks.
`~wx.adv.LayoutAlgorithm`                                                        :ref:`wx.adv.LayoutAlgorithm`  implements layout of subwindows in MDI or SDI frames.
`~wx.adv.NotificationMessage`                                                    This class allows showing the user a message non intrusively.
`~wx.adv.OwnerDrawnComboBox`                                                     :ref:`wx.adv.OwnerDrawnComboBox`  is a combobox with owner-drawn list items.
`~wx.adv.PropertySheetDialog`                                                    This class represents a property sheet dialog: a tabbed dialog for showing settings.
`~wx.adv.PseudoDC`                                                               A PseudoDC is an object that can be used much like real
`~wx.adv.QueryLayoutInfoEvent`                                                   This event is sent when :ref:`wx.adv.LayoutAlgorithm`  wishes to get the size, orientation and alignment of a window.
`~wx.adv.RichToolTip`                                                            Allows showing a tool tip with more customizations than :ref:`wx.ToolTip`.
`~wx.adv.SashEvent`                                                              A sash event is sent when the sash of a :ref:`wx.adv.SashWindow`  has been dragged by the user.
`~wx.adv.SashLayoutWindow`                                                       :ref:`wx.adv.SashLayoutWindow`  responds to OnCalculateLayout events generated by :ref:`wx.adv.LayoutAlgorithm`.
`~wx.adv.SashWindow`                                                             :ref:`wx.adv.SashWindow`  allows any of its edges to have a sash which can be dragged to resize the window.
`~wx.adv.Sound`                                                                  This class represents a short sound (loaded from Windows ``WAV`` file), that can be stored in memory and played.
`~wx.adv.SplashScreen`                                                           :ref:`wx.adv.SplashScreen`  shows a window with a thin border, displaying a bitmap describing your application.
`~wx.adv.TaskBarIcon`                                                            This class represents a taskbar icon.
`~wx.adv.TaskBarIconEvent`                                                       The event class used by :ref:`wx.adv.TaskBarIcon`.
`~wx.adv.TimePickerCtrl`                                                         This control allows the user to enter time.
`~wx.adv.TipProvider`                                                            This is the class used together with `wx.adv.ShowTip`       function.
`~wx.adv.Wizard`                                                                 :ref:`wx.adv.Wizard`  is the central class for implementing 'wizard-like' dialogs.
`~wx.adv.WizardEvent`                                                            :ref:`wx.adv.WizardEvent`  class represents an event generated by the :ref:`wx.adv.Wizard`: this event is first sent to the page itself and, if not processed there, goes up the window hierarchy as usual.
`~wx.adv.WizardPage`                                                             :ref:`wx.adv.WizardPage`  is one of the screens in :ref:`wx.adv.Wizard`: it must know what are the following and preceding pages (which may be ``None`` for the first/last page).
`~wx.adv.WizardPageSimple`                                                       :ref:`wx.adv.WizardPageSimple`  is the simplest possible :ref:`wx.adv.WizardPage`  implementation: it just returns the pointers given to its constructor from :meth:`wx.adv.WizardPage.GetNext`   and :meth:`wx.adv.WizardPage.GetPrev`   functions.
================================================================================ ================================================================================


Functions Summary
=================

================================================================================ ================================================================================
**Function**                                                                     **Short Description**
================================================================================ ================================================================================
:func:`~wx.adv.AboutBox`                                                         This function shows the standard about dialog containing the information specified in `info`.
:func:`~wx.adv.CreateFileTipProvider`                                            This function creates a :ref:`wx.adv.TipProvider`  which may be used with `wx.adv.ShowTip`     .
:func:`~wx.adv.GenericAboutBox`                                                  This function does the same thing as `wx.adv.AboutBox`       except that it always uses the generic wxWidgets version of the dialog instead of the native one.
:func:`~wx.adv.ShowTip`                                                          This function shows a "startup tip" to the user.
================================================================================ ================================================================================


.. toctree::
   :maxdepth: 1
   :hidden:

   wx.adv.ANIDecoder
   wx.adv.AboutDialogInfo
   wx.adv.Animation
   wx.adv.AnimationCtrl
   wx.adv.AnimationDecoder
   wx.adv.AnimationDisposal.enumeration
   wx.adv.AnimationType.enumeration
   wx.adv.BannerWindow
   wx.adv.BitmapComboBox
   wx.adv.CalculateLayoutEvent
   wx.adv.CalendarCtrl
   wx.adv.CalendarDateAttr
   wx.adv.CalendarDateBorder.enumeration
   wx.adv.CalendarEvent
   wx.adv.CalendarHitTestResult.enumeration
   wx.adv.CommandLinkButton
   wx.adv.DateEvent
   wx.adv.DatePickerCtrl
   wx.adv.DatePickerCtrlGeneric
   wx.adv.EditableListBox
   wx.adv.ExtHelpController
   wx.adv.GIFDecoder
   wx.adv.GenericAnimationCtrl
   wx.adv.GenericCalendarCtrl
   wx.adv.HyperlinkCtrl
   wx.adv.HyperlinkEvent
   wx.adv.Joystick
   wx.adv.LayoutAlgorithm
   wx.adv.LayoutAlignment.enumeration
   wx.adv.LayoutOrientation.enumeration
   wx.adv.NotificationMessage
   wx.adv.OwnerDrawnComboBox
   wx.adv.OwnerDrawnComboBoxPaintingFlags.enumeration
   wx.adv.PropertySheetDialog
   wx.adv.PropertySheetDialogFlags.enumeration
   wx.adv.PseudoDC
   wx.adv.QueryLayoutInfoEvent
   wx.adv.RichToolTip
   wx.adv.SashDragStatus.enumeration
   wx.adv.SashEdgePosition.enumeration
   wx.adv.SashEvent
   wx.adv.SashLayoutWindow
   wx.adv.SashWindow
   wx.adv.Sound
   wx.adv.SplashScreen
   wx.adv.TaskBarIcon
   wx.adv.TaskBarIconEvent
   wx.adv.TaskBarIconType.enumeration
   wx.adv.TimePickerCtrl
   wx.adv.TipKind.enumeration
   wx.adv.TipProvider
   wx.adv.Wizard
   wx.adv.WizardEvent
   wx.adv.WizardPage
   wx.adv.WizardPageSimple
   wx.adv.functions