rviz: ros_topic_property.h Source File

00001 /*
00002  * Copyright (c) 2008, 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 #ifndef RVIZ_ROS_TOPIC_PROPERTY_H
00031 #define RVIZ_ROS_TOPIC_PROPERTY_H
00032 
00033 #include <wx/wx.h>
00034 #include <wx/propgrid/propgrid.h>
00035 #include <wx/propgrid/propdev.h>
00036 
00037 #include <string>
00038 
00039 namespace ros
00040 {
00041 class Node;
00042 }
00043 
00044 namespace rviz
00045 {
00046 class ROSTopicDialogAdapter : public wxPGEditorDialogAdapter
00047 {
00048 public:
00049 
00050   ROSTopicDialogAdapter( const std::string& message_type )
00051   : wxPGEditorDialogAdapter()
00052   , message_type_(message_type)
00053   {
00054   }
00055 
00056   virtual bool DoShowDialog( wxPropertyGrid* WXUNUSED(propGrid), wxPGProperty* WXUNUSED(property) );
00057 
00058 protected:
00059   std::string message_type_;
00060 };
00061 
00062 //
00063 // wxLongStringProperty has wxString as value type and TextCtrlAndButton as editor.
00064 // Here we will derive a new property class that will show single choice dialog
00065 // on button click.
00066 //
00067 
00068 class ROSTopicProperty : public wxLongStringProperty
00069 {
00070   DECLARE_DYNAMIC_CLASS(ROSTopicProperty)
00071 public:
00072 
00073   // Normal property constructor.
00074   ROSTopicProperty(const std::string& message_type, const wxString& label, const wxString& name = wxPG_LABEL, const wxString& value = wxEmptyString);
00075 
00076   // Do something special when button is clicked.
00077   virtual wxPGEditorDialogAdapter* GetEditorDialog() const
00078   {
00079     return new ROSTopicDialogAdapter( message_type_ );
00080   }
00081 
00082   void setMessageType(const std::string& message_type)
00083   {
00084     message_type_ = message_type;
00085   }
00086 
00087   virtual void OnSetValue();
00088 
00089 protected:
00090   ROSTopicProperty();
00091 
00092   void checkForEmptyValue();
00093 
00094   std::string message_type_;
00095 };
00096 
00097 } // namespace rviz
00098 
00099 #endif