Package wx :: Package lib :: Package agw :: Module advancedsplash :: Class AdvancedSplash

[frames | no frames]

## Type AdvancedSplash

    object --+
             |
        Object --+
                 |
        EvtHandler --+
                     |
                Window --+
                         |
            TopLevelWindow --+
                             |
                         Frame --+
                                 |
                                AdvancedSplash

Method Summary
| ``__init__`(self, parent, id, pos, size, style, bitmap, timeout, extrastyle, shadowcolour)` Default class constructor.
| ``GetSplashStyle`(self)` Returns a list of strings and a list of integers containing the styles.
| ``GetText`(self)` Returns the text displayed on AdvancedSplash.
| ``GetTextColour`(self)` Gets the colour for the text in AdvancedSplash.
| ``GetTextFont`(self)` Gets the font for the text in AdvancedSplash.
| ``GetTextPosition`(self)` Returns the text position inside AdvancedSplash frame.
| ``OnCharEvents`(self, event)` Handles the wx.EVT_CHAR for AdvancedSplash.
| ``OnCloseWindow`(self, event)` Handles the wx.EVT_CLOSE for AdvancedSplash.
| ``OnMouseEvents`(self, event)` Handles the wx.EVT_MOUSE_EVENTS for AdvancedSplash.
| ``OnNotify`(self)` Handles the timer expiration, and calls the close() method.
| ``OnPaint`(self, event)` Handles the wx.EVT_PAINT for AdvancedSplash.
| ``SetSplashShape`(self)` Sets AdvancedSplash shape using the region created from the bitmap.
| ``SetText`(self, text)` Sets the text to be displayed on AdvancedSplash.
| ``SetTextColour`(self, colour)` Sets the colour for the text in AdvancedSplash.
| ``SetTextFont`(self, font)` Sets the font for the text in AdvancedSplash.
| ``SetTextPosition`(self, position)` Sets the text position inside AdvancedSplash frame.
| ``ShadowBitmap`(self, bmp, shadowcolour)` Applies a mask on the bitmap accordingly to user input.

Property Summary

Instance Method Details

### __init__(self, parent, id=-1, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=32786, bitmap=None, timeout=5000, extrastyle=5, shadowcolour=None)
(Constructor)

    Default class constructor.

    Non standard wxPython parameters are:

    a) bitmap: this must be a valid wx.Bitmap, that you may construct using
       whatever image file format supported by wxPython. If the file you load
       already supports mask/transparency (like png), the transparent areas
       will not be drawn on screen, and the AdvancedSplash frame will have
       the shape defined only by *non-transparent* pixels.
       If you use other file formats that does not supports transparency, you
       can obtain the same effect as above by masking a specific colour in
       your wx.Bitmap. See "shadowcolour" and "extrastyle" parameters;

    b) timeout: if you construct AdvancedSplash using the style as_timeout,
       AdvancedSplash will be destroyed after "timeout" milliseconds;

    c) extrastyle: this value specifies The AdvancedSplash styles:
       - as_timeout: AdvancedSplash will be destroyed after "timeout"
         milliseconds;
       - as_notimeout: AdvancedSplash can be destroyed by clicking on it,
         pressing a key or by explicitly call the close() method;
       - AS_CENTER_ON_SCREEN: AdvancedSplash will be centered on screen;
       - AS_CENTER_ON_PARENT: AdvancedSplash will be centered on parent;
       - AS_NO_CENTER: AdvancedSplash will not be centered;
       - AS_SHADOW_BITMAP: if the bitmap you pass as input has no transparency,
         you can choose one colour that will be masked in your bitmap. the
         final shape of AdvancedSplash will be defined only by non-transparent
         (non-masked) pixels.

    d) shadowcolour: if you construct AdvancedSplash using the style
       AS_SHADOW_BITMAP, here you can specify the colour that will be masked on
       your input bitmap. This has to be a valid wxPython colour.

  Overrides:
    `wx.Frame.__init__`

### GetSplashStyle(self)

Returns a list of strings and a list of integers containing the styles.

### GetText(self)

Returns the text displayed on AdvancedSplash.

### GetTextColour(self)

Gets the colour for the text in AdvancedSplash.

### GetTextFont(self)

Gets the font for the text in AdvancedSplash.

### GetTextPosition(self)

Returns the text position inside AdvancedSplash frame.

### OnCharEvents(self, event)

Handles the wx.EVT_CHAR for AdvancedSplash. This reproduces the behavior of wx.SplashScreen.

### OnCloseWindow(self, event)

Handles the wx.EVT_CLOSE for AdvancedSplash. This reproduces the behavior of wx.SplashScreen.

### OnMouseEvents(self, event)

Handles the wx.EVT_MOUSE_EVENTS for AdvancedSplash. This reproduces the behavior of wx.SplashScreen.

### OnNotify(self)

Handles the timer expiration, and calls the close() method.

### OnPaint(self, event)

Handles the wx.EVT_PAINT for AdvancedSplash.

### SetSplashShape(self)

Sets AdvancedSplash shape using the region created from the bitmap.

### SetText(self, text=None)

Sets the text to be displayed on AdvancedSplash.

### SetTextColour(self, colour=None)

Sets the colour for the text in AdvancedSplash.

### SetTextFont(self, font=None)

Sets the font for the text in AdvancedSplash.

### SetTextPosition(self, position=None)

Sets the text position inside AdvancedSplash frame.

### ShadowBitmap(self, bmp, shadowcolour)

Applies a mask on the bitmap accordingly to user input.

Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:51:43 2009 | http://epydoc.sf.net