Provided by: tulip-doc_3.1.2-2.3ubuntu3_all bug

NAME

       tlp::StringListSelectionWidget -

       A widget which allow to select a subset of strings from an input string list This Widget
       allows the user to select a subset of strings from an input string list The widget is
       composed of an input string list on the left and an output string list on the right The
       user user can move an item from one list to another by using the 'left' and 'right' button
       (located in the middle of the widget) or by drag'n drop The output string list can also be
       ordering the way the user want it by using the 'up' and 'down' button on the right of the
       widget.

SYNOPSIS

       #include <StringListSelectionWidget.h>

       Inherited by tlp::GraphPropertiesSelectionWidget.

   Public Slots
       void pressButtonAdd ()
       void pressButtonRem ()
       void pressButtonUp ()
       void pressButtonDown ()

   Public Member Functions
       StringListSelectionWidget (QWidget *parent=0, const unsigned int maxOutputListSize=0)
       StringListSelectionWidget (const std::vector< std::string > &inputStringList, QWidget
           *parent=0, const unsigned int maxOutputListSize=0)
       void setInputStringList (const std::vector< std::string > &inputStringList)
       void setOutputStringList (const std::vector< std::string > &outputStringList)
       void clearInputStringList ()
       void clearOutputStringList ()
       void setInputStringListLabel (const std::string &inputStringListLabel)
       void setOutputStringListLabel (const std::string &outputStringListLabel)
       void setMaxOutputListSize (const unsigned int maxOutputListSize)
       std::vector< std::string > getOutputStringList () const
       std::vector< std::string > getInputStringList () const

Detailed Description

       A widget which allow to select a subset of strings from an input string list This Widget
       allows the user to select a subset of strings from an input string list The widget is
       composed of an input string list on the left and an output string list on the right The
       user user can move an item from one list to another by using the 'left' and 'right' button
       (located in the middle of the widget) or by drag'n drop The output string list can also be
       ordering the way the user want it by using the 'up' and 'down' button on the right of the
       widget.

Constructor & Destructor Documentation

   tlp::StringListSelectionWidget::StringListSelectionWidget (QWidget *parent = 0, const unsigned
       intmaxOutputListSize = 0) Default constructor, create an empty String List Selection
       Widget Use setInputStringList and setOutputStringList to initialize the widget the way you
       want
       Parameters:
           maxOutputListSize specify the maximum number of items the user can pick (if set to 0,
           there is no restriction on the output list size)

   tlp::StringListSelectionWidget::StringListSelectionWidget (const std::vector< std::string >
       &inputStringList, QWidget *parent = 0, const unsigned intmaxOutputListSize = 0) This
       constructor will create a new String List Selection Widget with the input string list
       initialized with the content of the vector passed as first parameter
       Parameters:
           inputStringList a vector containing the strings to insert in the input string list
           maxOutputListSize specify the maximum number of items the user can pick (if set to 0,
           there is no restriction on the output list size)

Member Function Documentation

   void tlp::StringListSelectionWidget::clearInputStringList () Methods which empty the contents
       of the input string list
   void tlp::StringListSelectionWidget::clearOutputStringList () Methods which empty the contents
       of the output string list
   std::vector<std::string> tlp::StringListSelectionWidget::getInputStringList () const Method
       which returns the content of the input string list.
   std::vector<std::string> tlp::StringListSelectionWidget::getOutputStringList () const Method
       which returns the content of the output string list
   void tlp::StringListSelectionWidget::pressButtonAdd () [slot]
   void tlp::StringListSelectionWidget::pressButtonDown () [slot]
   void tlp::StringListSelectionWidget::pressButtonRem () [slot]
   void tlp::StringListSelectionWidget::pressButtonUp () [slot]
   void tlp::StringListSelectionWidget::setInputStringList (const std::vector< std::string >
       &inputStringList) Method to fill the content of the input string list
       Parameters:
           inputStringList a vector containing the strings to insert in the input string list

   void tlp::StringListSelectionWidget::setInputStringListLabel (const std::string
       &inputStringListLabel) Method to set the text of the label located at the top of the input
       string list
       Parameters:
           inputStringListLabel the string to display in the input string list label

   void tlp::StringListSelectionWidget::setMaxOutputListSize (const unsigned
       intmaxOutputListSize) Method to set the maximum size of the output string list
       Parameters:
           maxOutputListSize the maximum number of items the output list can contain (if set to
           0, there is no restriction on the output list size)

   void tlp::StringListSelectionWidget::setOutputStringList (const std::vector< std::string >
       &outputStringList) Method to fill the content of the output string list
       Parameters:
           outputStringList a vector containing the strings to insert in the output string list

   void tlp::StringListSelectionWidget::setOutputStringListLabel (const std::string
       &outputStringListLabel) Method to set the text of the label located at the top of the
       input string list
       Parameters:
           inputStringListLabel the string to display in the input string list label

Author

       Generated automatically by Doxygen for Tulip QT Library from the source code.