property_tree_with_help.cpp
Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2011, Willow Garage, Inc.
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  *     * Redistributions of source code must retain the above copyright
00009  *       notice, this list of conditions and the following disclaimer.
00010  *     * Redistributions in binary form must reproduce the above copyright
00011  *       notice, this list of conditions and the following disclaimer in the
00012  *       documentation and/or other materials provided with the distribution.
00013  *     * Neither the name of the Willow Garage, Inc. nor the names of its
00014  *       contributors may be used to endorse or promote products derived from
00015  *       this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00018  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00027  * POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 #include <QTextBrowser>
00031 
00032 #include "rviz/properties/property.h"
00033 #include "rviz/properties/property_tree_widget.h"
00034 
00035 #include "rviz/properties/property_tree_with_help.h"
00036 
00037 namespace rviz
00038 {
00039 
00040 PropertyTreeWithHelp::PropertyTreeWithHelp( QWidget* parent )
00041   : QSplitter( parent )
00042 {
00043   setOrientation( Qt::Vertical );
00044 
00045   property_tree_ = new PropertyTreeWidget;
00046 
00047   help_ = new QTextBrowser;
00048   help_->setOpenExternalLinks( true );
00049 
00050   addWidget( property_tree_ );
00051   addWidget( help_ );
00052 
00053   setStretchFactor( 0, 1000 );
00054   setCollapsible( 0, false );
00055 
00056   QList<int> _sizes;
00057   _sizes.push_back( 1000 );
00058   _sizes.push_back( 1 );
00059   setSizes( _sizes );
00060 
00061   connect( property_tree_, SIGNAL( currentPropertyChanged( const Property* )),
00062            this, SLOT( showHelpForProperty( const Property* )));
00063 }
00064 
00065 void PropertyTreeWithHelp::showHelpForProperty( const Property* property )
00066 {
00067   if( property )
00068   {
00069     QString body_text = property->getDescription();
00070     QString heading = property->getName();
00071     QString html = "<html><body bgcolor=\"#EFEBE7\"><strong>" + heading + "</strong><br>" + body_text + "</body></html>";
00072     help_->setHtml( html );
00073   }
00074   else
00075   {
00076     help_->setHtml( "" );
00077   }
00078 }
00079 
00080 void PropertyTreeWithHelp::save( Config config ) const
00081 {
00082   property_tree_->save( config.mapMakeChild( "Property Tree Widget" ));
00083 
00084   QList<int> _sizes = sizes();
00085   config.mapSetValue( "Tree Height", _sizes.at( 0 ));
00086   config.mapSetValue( "Help Height", _sizes.at( 1 ));
00087 }
00088 
00089 void PropertyTreeWithHelp::load( const Config& config )
00090 {
00091   property_tree_->load( config.mapGetChild( "Property Tree Widget" ));
00092 
00093   int tree_height;
00094   int help_height;
00095   if( config.mapGetInt( "Tree Height", &tree_height ) &&
00096       config.mapGetInt( "Help Height", &help_height ))
00097   {
00098     QList<int> _sizes;
00099     _sizes.push_back( tree_height );
00100     _sizes.push_back( help_height );
00101     setSizes( _sizes );
00102   }
00103 }
00104 
00105 } // end namespace rviz


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Thu Jun 6 2019 18:02:15