SDS2 Parametric API
 All Classes Namespaces Functions Variables Pages
List of all members
Gadget.CallbackBanner Class Reference

A python constructible GadgetBanner. More...

Methods defined here:

def __init__
def __reduce__

Data descriptors defined here:

def icon
 The filename of an image to display for this banner on the Gadget tree.
def imageCavity
 (Read-only) Returns the frame which should be used as the parent for this leaf's explanatory images.
def mainCavity
 (Read-only) Returns the frame which should be used as the parent of widgets in this banner.
def secondaryCavity
 (Read-only) Returns the frame which should be used as the parent for auxiliary controls used by this banner, such as form cut and paste buttons.

Data and other attributes defined here:

int __instance_size__ = 40

Data descriptors inherited from Boost.Python.instance:

def __dict__
def __weakref__

Data and other attributes inherited from Boost.Python.instance:

def __new__

Detailed Description

A python constructible GadgetBanner.

(See GadgetBanner.)

Method resolution order

CallbackBanner
Boost.Python.instance
builtin.object

Constructor & Destructor Documentation

def Gadget.CallbackBanner.__init__ (   args)
 CallbackBanner(gadgetscreen, callback, displayname, sortname,        foldname, defaultfoldstate)
     gadgetscreen - the gadget screen object this banner is
                    associated with
     callback     - a function that takes a GadgetBanner as a
                    parameter and creates widgets in it
     displayname  - a string that is used for the title of the
                    banner
     sortname     - a string that is used to establish the order
                    banners will appear on their GadgetScreen
     foldname     - a uuid that is used to track the user's preferred
                    fold state for this gadget
     defaultfoldstate - a boolean that specifies the default fold
                    state when the user's prefere is not known
 A CallbackBanner is automatically added to its screen;
 GadgetScreen.add does not need to be called.

Member Function Documentation

def Gadget.CallbackBanner.__dict__ (   args)
def Gadget.CallbackBanner.__new__ (   args)
T.__new__(S, ...) -> a new object with type S, a subtype of T
 __new__ = <built-in method __new__ of Boost.Python.class object>
def Gadget.CallbackBanner.__reduce__ (   args)
 __reduce__ = <unnamed Boost.Python function>(args)
def Gadget.CallbackBanner.__weakref__ (   args)
def Gadget.CallbackBanner.icon (   args)

The filename of an image to display for this banner on the Gadget tree.

def Gadget.CallbackBanner.imageCavity (   args)

(Read-only) Returns the frame which should be used as the parent for this leaf's explanatory images.

def Gadget.CallbackBanner.mainCavity (   args)

(Read-only) Returns the frame which should be used as the parent of widgets in this banner.

def Gadget.CallbackBanner.secondaryCavity (   args)

(Read-only) Returns the frame which should be used as the parent for auxiliary controls used by this banner, such as form cut and paste buttons.

Member Data Documentation

int Gadget.CallbackBanner.__instance_size__ = 40
staticprivate