SelectionDialog Namespace Reference

Functions
def	RunCustomSelectionDialogForManyItems
def	RunCustomSelectionDialogForManyItemsWithDescriptions
def	RunCustomSelectionDialogForOneItem
def	RunCustomSelectionDialogForOneItemWithDescription

Function Documentation

def SelectionDialog.RunCustomSelectionDialogForManyItems	(		dialog_title,
			items,
			preselection
	)

Returns

Instance of type tuple

     Launch a selection dialog displaying the values in items.
     Return a pair indicating if the user clicked OK and
     the selected items.
     Example: ok, sel = RunCustomSelectionDialogForManyItems(
         'Select many items'
         , sorted([2, 1, 0])
         , [1, 2])
     
 
     C++ signature :
         boost::python::tuple RunCustomSelectionDialogForManyItems(std::string,boost::python::list [,boost::python::list=[]])

def SelectionDialog.RunCustomSelectionDialogForManyItemsWithDescriptions	(		dialog_title,
			key_description_tuples,
			preselection
	)

Returns

Instance of type tuple

     Launch a selection dialog displaying the items
     in [d for k, d in key_description_tuples].
     Return a pair indicating if the user clicked OK and
     the selected key/description tuples.
     Example: ok, sel = SD.RunCustomSelectionDialogForManyItemsWithDescriptions(
         'Select many item descriptions'
         , sorted({0:'c', 1:'b', 2:'a'}.items(), key=lambda o: o[1])
         , [0, 1])
     
 
     C++ signature :
         boost::python::tuple RunCustomSelectionDialogForManyItemsWithDescriptions(std::string,boost::python::list [,boost::python::list=[]])
 
     Launch a selection dialog displaying the values in description_dictionary.
     Return a pair indicating if the user clicked OK and
     the selected key/description tuples.
     Example: ok, sel = SD.RunCustomSelectionDialogForManyItemsWithDescriptions(
         'Select many item descriptions'
         , {0:'c', 1:'b', 2:'a'}
         , [0, 1])
     
 
     C++ signature :
         boost::python::tuple RunCustomSelectionDialogForManyItemsWithDescriptions(std::string,boost::python::dict [,boost::python::list=[]])

Note

Additional signature: RunCustomSelectionDialogForManyItemsWithDescriptions( (str)dialog_title, (dict)description_dictionary [, (list)preselection=[]]) -> tuple

def SelectionDialog.RunCustomSelectionDialogForOneItem	(		dialog_title,
			items,
			preselection = None
	)

Returns

Instance of type tuple

     Launch a selection dialog displaying the values in items.
     Return a pair indicating if the user clicked OK and
     the selected description if one was selected.
     Example: ok, sel = RunCustomSelectionDialogForOneItem(
         'Select one item', sorted([2,1,0]), 2)
 
     C++ signature :
         boost::python::tuple RunCustomSelectionDialogForOneItem(std::string,boost::python::list [,boost::python::api::object=None])

def SelectionDialog.RunCustomSelectionDialogForOneItemWithDescription	(		dialog_title,
			key_description_tuples,
			preselection = None
	)

Returns

Instance of type tuple

     Launch a selection dialog displaying the items
     in [d for k, d in key_description_tuples].
     Return a pair indicating if the user clicked OK and
     the selected key/description tuple if one was selected.
     Example: ok, sel = RunCustomSelectionDialogForOneItemWithDescription(
         'Select one item description'
         , sorted({0:'c', 1:'b', 2:'a'}.items(), key=lambda o: o[1])
         , 0)
     
 
     C++ signature :
         boost::python::tuple RunCustomSelectionDialogForOneItemWithDescription(std::string,boost::python::list [,boost::python::api::object=None])
 
     Launch a selection dialog displaying the values in description_dictionary.
     Return a pair indicating if the user clicked OK and
     the selected key/description tuple if one was selected.
     Example: ok, sel = RunCustomSelectionDialogForOneItemWithDescription(
         'Select many item descriptions'
         , {0:'c', 1:'b', 2:'a'}
         , [0, 1])
     
 
     C++ signature :
         boost::python::tuple RunCustomSelectionDialogForOneItemWithDescription(std::string,boost::python::dict [,boost::python::api::object=None])

Note

Additional signature: RunCustomSelectionDialogForOneItemWithDescription( (str)dialog_title, (dict)description_dictionary [, (object)preselection=None]) -> tuple