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

GadgetScreen(screen_name, title, place_mode) More...

Inheritance diagram for Gadget.GadgetScreen:
componentedit.StandaloneComponentEditView Gadget.MemberEditScreen

Methods defined here:

def __init__
def __reduce__
def add
def finalize
def remove
def setCancelButton
def setOkButton
def showModal
def showModeless
def unpackOverlay
def unpackShowImages

Data descriptors defined here:

def secondaryCavity
 (Read-only) A frame which can, for example, be used for OK/Cancel buttons, etc.

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

GadgetScreen(screen_name, title, place_mode)

screen_name - uuid of the screen for stateful placement
title - title of the created window
place_mode - must be PlaceMode.Explicit

Toplevel windows in the Gadget framework, which contains a tree control, GadgetBanners, and GadgetColumns

When possible, GadgetScreens defer creation of child objects, banners, columns, leaves, and the widgets inside them, until they are made visible by user interaction, for example, when a user clicks to open a node on the tree, causing the contents of a leaf to become visible. You should not count on your widgets existing before their container is open or on the order in which the different containers are opened, since this is subject to the actions of the user.

Method resolution order

GadgetScreen
Boost.Python.instance
builtin.object

Constructor & Destructor Documentation

def Gadget.GadgetScreen.__init__ (   args)

Member Function Documentation

def Gadget.GadgetScreen.__dict__ (   args)
def Gadget.GadgetScreen.__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>

Reimplemented in componentedit.StandaloneComponentEditView, and Gadget.MemberEditScreen.

def Gadget.GadgetScreen.__reduce__ (   args)
 __reduce__ = <unnamed Boost.Python function>(args)

Reimplemented in componentedit.StandaloneComponentEditView, and Gadget.MemberEditScreen.

def Gadget.GadgetScreen.__weakref__ (   args)
def Gadget.GadgetScreen.add (   args)
 add(gadget_column)
 Called with GadgetColumn object, adds the column to the GadgetScreen
 
 add(gadget_banner)
 Called with GadgetBanner object, adds the banner to the GadgetScreen

Reimplemented in componentedit.StandaloneComponentEditView, and Gadget.MemberEditScreen.

def Gadget.GadgetScreen.finalize (   args)
 GadgetScreen.finalize()
 Clean up memory associated with the screen.  This must be called
 before the GadgetScreen object goes out of scope, or memory leaks
 can result.

Reimplemented in componentedit.StandaloneComponentEditView, and Gadget.MemberEditScreen.

def Gadget.GadgetScreen.remove (   args)
 remove(gadget_column)
 Called with GadgetColumn object, removes the column from the GadgetScreen
 
 remove(gadget_banner)
 Called with GadgetBanner object, removes the banner from the GadgetScreen

Reimplemented in componentedit.StandaloneComponentEditView, and Gadget.MemberEditScreen.

def Gadget.GadgetScreen.secondaryCavity (   args)

(Read-only) A frame which can, for example, be used for OK/Cancel buttons, etc.

Reimplemented in componentedit.StandaloneComponentEditView, and Gadget.MemberEditScreen.

def Gadget.GadgetScreen.setCancelButton (   args)
 Set the button that will be invoked when the user closes the window or presses escape

Reimplemented in componentedit.StandaloneComponentEditView.

def Gadget.GadgetScreen.setOkButton (   args)
 Set the button that will be invoked when the user presses the enter key

Reimplemented in componentedit.StandaloneComponentEditView.

def Gadget.GadgetScreen.showModal (   args)
 GadgetScreen.showModal()
 For a GadgetScreen created with PlaceMode.Explicit, display the screen
 and make it modal.

Reimplemented in componentedit.StandaloneComponentEditView.

def Gadget.GadgetScreen.showModeless (   args)
 GadgetScreen.showModal()
 For a GadgetScreen created with PlaceMode.Explicit, display the screen
 and make it modeless.

Reimplemented in componentedit.StandaloneComponentEditView.

def Gadget.GadgetScreen.unpackOverlay (   args)
 unpackOverlay(args)

Reimplemented in componentedit.StandaloneComponentEditView.

def Gadget.GadgetScreen.unpackShowImages (   args)
 unpackShowImages(args)

Reimplemented in componentedit.StandaloneComponentEditView.

Member Data Documentation

int Gadget.GadgetScreen.__instance_size__ = 40
staticprivate