nobody at rubyforge.org
2007-Jun-22 19:00 UTC
[Wxruby-development] [1056] trunk/wxruby2/swig/classes/include/wxToolBar.h: Add missing param to InsertTool long version; uncomment some methods now
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type"
content="text/html; charset=utf-8" /><style
type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:'':'';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family:
verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;
font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding:
6px; }
#msg ul, pre { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid;
padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family:
verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch
.binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[1056] trunk/wxruby2/swig/classes/include/wxToolBar.h: Add missing
param to InsertTool long version; uncomment some methods now</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd>1056</dd>
<dt>Author</dt> <dd>brokentoy</dd>
<dt>Date</dt> <dd>2007-06-22 15:00:21 -0400 (Fri, 22 Jun
2007)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add missing param to InsertTool long version; uncomment some methods
now
ignored in ToolBar.i; remove cruft and tidy</pre>
<h3>Modified Paths</h3>
<ul>
<li><a
href="#trunkwxruby2swigclassesincludewxToolBarh">trunk/wxruby2/swig/classes/include/wxToolBar.h</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwxruby2swigclassesincludewxToolBarh"></a>
<div class="modfile"><h4>Modified:
trunk/wxruby2/swig/classes/include/wxToolBar.h (1055 => 1056)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/swig/classes/include/wxToolBar.h        2007-06-22
18:59:19 UTC (rev 1055)
+++
trunk/wxruby2/swig/classes/include/wxToolBar.h        2007-06-22
19:00:21 UTC (rev 1056)
</span><span class="lines">@@ -1,372 +1,64 @@
</span><del>-// wxToolBar.h
-// This file was automatically generated
-// by extractxml.rb, part of the wxRuby project
-// Do not make changes directly to this file!
</del><ins>+// Copyright 2006 - 2007 by Kevin Smith
+// released under the MIT-style wxruby2 license
</ins><span class="cx">
</span><span class="cx"> #if !defined(_wxToolBar_h_)
</span><span class="cx"> #define _wxToolBar_h_
</span><span class="cx"> class wxToolBar : public
wxControl
</span><span class="cx"> {
</span><span class="cx"> public:
</span><del>-        /**
-         *
\brief Default constructor.
-        */
-
</del><span class="cx"> wxToolBar() ;
</span><del>-        /**
-         *
\brief Constructs a toolbar.
-         *
\param wxWindow*
-         *
\param wxWindowID
-         *
\param const wxPoint&
-         *
\param const wxSize&
-         *
\param long
-         *
\param const wxString&
-        */
-
</del><span class="cx"> wxToolBar(wxWindow* parent ,
wxWindowID id , const wxPoint& pos = wxDefaultPosition, const wxSize&
size = wxDefaultSize, long style = wxTB_HORIZONTAL, const wxString& name =
wxPanelNameStr) ;
</span><del>-        /**
-         *
\brief Toolbar destructor.
-        */
-
</del><span class="cx"> virtual ~wxToolBar() ;
</span><del>-        /**
-         *
\brief Adds any control to the toolbar, typically e.g. a combobox.
-         *
\param wxControl*
-        */
-
</del><span class="cx"> bool AddControl(wxControl*
control ) ;
</span><del>-        /**
-         *
\brief
-        */
-
</del><span class="cx"> void AddSeparator() ;
</span><del>-        /**
-         *
\brief
-         *
\param int
-         *
\param const wxString&
-         *
\param const wxBitmap&
-         *
\param const wxString&
-         *
\param wxItemKind
-        */
-
- wxToolBarTool* AddTool(int toolId , const wxString& label , const
wxBitmap& bitmap1 , const wxString& shortHelpString =
wxT(""), wxItemKind kind = wxITEM_NORMAL) ;
-        /**
-         *
\brief
-         *
\param int
-         *
\param const wxString&
-         *
\param const wxBitmap&
-         *
\param const wxBitmap&
-         *
\param wxItemKind
-         *
\param const wxString&
-         *
\param const wxString&
-         *
\param wxObject*
-        */
-
- wxToolBarTool* AddTool(int toolId , const wxString& label , const
wxBitmap& bitmap1 , const wxBitmap& bitmap2 = wxNullBitmap, wxItemKind
kind = wxITEM_NORMAL, const wxString& shortHelpString = wxT(""),
const wxString& longHelpString = wxT(""), wxObject* clientData =
NULL) ;
-        /**
-         *
\brief Adds a tool to the toolbar. The first (short and most commonly used)
version
-has fewer parameters than the full version at the price of not being able to
-specify some of the more rarely used button features. The last version allows
-to add an existing tool.
-         *
\param wxToolBarTool*
-        */
-
- //wxToolBarTool* AddTool(wxToolBarTool* tool );
-        /**
-         *
\brief Adds a new check (or toggle) tool to the toolbar. The parameters are the
same
-as in .
-         *
\param int
-         *
\param const wxString&
-         *
\param const wxBitmap&
-         *
\param const wxBitmap&
-         *
\param const wxString&
-         *
\param const wxString&
-         *
\param wxObject*
-        */
-
- wxToolBarTool* AddCheckTool(int toolId , const wxString& label , const
wxBitmap& bitmap1 , const wxBitmap& bitmap2 , const wxString&
shortHelpString = wxT(""), const wxString& longHelpString =
wxT(""), wxObject* clientData = NULL) ;
-        /**
-         *
\brief Adds a new radio tool to the toolbar. Consecutive radio tools form a
radio
-group such that exactly one button in the group is pressed at any moment, in
-other words whenever a button in the group is pressed the previously pressed
-button is automatically released. You should avoid having the radio groups of
-only one element as it would be impossible for the user to use such button.
-
-By default, the first button in the radio group is initially pressed, the
-others are not.
-         *
\param int
-         *
\param const wxString&
-         *
\param const wxBitmap&
-         *
\param const wxBitmap&
-         *
\param const wxString&
-         *
\param const wxString&
-         *
\param wxObject*
-        */
-
- wxToolBarTool* AddRadioTool(int toolId , const wxString& label , const
wxBitmap& bitmap1 , const wxBitmap& bitmap2 , const wxString&
shortHelpString = wxT(""), const wxString& longHelpString =
wxT(""), wxObject* clientData = NULL) ;
-        /**
-         *
\brief Removes the specified tool from the toolbar and deletes it. If you
don''t want
-to delete the tool, but just to remove it from the toolbar (to possibly add it
-back later), you may use instead.
-
-Note that it is unnecessary to call for the
-change to take place, it will happen immediately.
-
-Returns true if the tool was deleted, false otherwise.
-         *
\param int
-        */
-
</del><ins>+ wxToolBarToolBase* AddTool(int toolId , const
wxString& label , const wxBitmap& bitmap1 , const wxString&
shortHelpString = wxT(""), wxItemKind kind = wxITEM_NORMAL) ;
+ wxToolBarToolBase* AddTool(int toolId , const wxString& label , const
wxBitmap& bitmap1 , const wxBitmap& bitmap2 = wxNullBitmap, wxItemKind
kind = wxITEM_NORMAL, const wxString& shortHelpString = wxT(""),
const wxString& longHelpString = wxT(""), wxObject* clientData =
NULL) ;
+ wxToolBarToolBase* AddTool(wxToolBarToolBase* tool );
+ wxToolBarToolBase* AddCheckTool(int toolId , const wxString& label ,
const wxBitmap& bitmap1 , const wxBitmap& bitmap2 , const
wxString& shortHelpString = wxT(""), const wxString&
longHelpString = wxT(""), wxObject* clientData = NULL) ;
+ wxToolBarToolBase* AddRadioTool(int toolId , const wxString& label ,
const wxBitmap& bitmap1 , const wxBitmap& bitmap2 , const
wxString& shortHelpString = wxT(""), const wxString&
longHelpString = wxT(""), wxObject* clientData = NULL) ;
</ins><span class="cx"> bool DeleteTool(int toolId ) ;
</span><del>-        /**
-         *
\brief This function behaves like but it
-deletes the tool at the specified position and not the one with the given id.
-         *
\param size_t
-        */
-
</del><span class="cx"> bool DeleteToolByPos(size_t pos
) ;
</span><del>-        /**
-         *
\brief Enables or disables the tool.
-
-
-
-
-
-
-
- This function should only be called after
- .
-         *
\param int
-         *
\param const bool
-        */
-
</del><span class="cx"> void EnableTool(int toolId ,
const bool enable ) ;
</span><del>-        /**
-         *
\brief Returns a pointer to the control identified by or
-NULL if no corresponding control is found.
-         *
\param int
-        */
-
- wxControl* FindControl(int id ) ;
-        /**
-         *
\brief Finds a tool for the given mouse position.
-         *
\param const float
-         *
\param const float
-        */
-
- wxToolBarTool* FindToolForPosition(const float x , const float y ) const;
-        /**
-         *
\brief Returns the size of a whole button, which is usually larger than a tool
bitmap because
-of added 3D effects.
-        */
-
</del><ins>+ wxControl* FindControl(int id) ;
+ wxToolBarToolBase* FindToolForPosition(const float x , const float y )
const;
</ins><span class="cx"> wxSize GetToolSize() ;
</span><del>-        /**
-         *
\brief Returns the size of bitmap that the toolbar expects to have. The default
bitmap size is 16 by 15 pixels.
-        */
-
</del><span class="cx"> wxSize GetToolBitmapSize() ;
</span><del>-        /**
-         *
\brief Returns the left/right and top/bottom margins, which are also used for
inter-toolspacing.
-        */
-
</del><span class="cx"> wxSize GetMargins() const;
</span><del>-        /**
-         *
\brief Get any client data associated with the tool.
-         *
\param int
-        */
-
</del><span class="cx"> wxObject* GetToolClientData(int
toolId ) const;
</span><del>-        /**
-         *
\brief Called to determine whether a tool is enabled (responds to user input).
-         *
\param int
-        */
-
</del><span class="cx"> bool GetToolEnabled(int toolId
) const;
</span><del>-        /**
-         *
\brief Returns the long help for the given tool.
-         *
\param int
-        */
-
</del><span class="cx"> wxString GetToolLongHelp(int
toolId ) const;
</span><del>-        /**
-         *
\brief Returns the value used for packing tools.
-        */
-
</del><span class="cx"> int GetToolPacking() const;
</span><del>-        /**
-         *
\brief Returns the tool position in the toolbar, or wxNOT_FOUND if the tool is
not found.
-         *
\param int
-        */
-
- //int GetToolPos(int toolId ) const;
-        /**
-         *
\brief Returns the default separator size.
-        */
-
</del><ins>+ int GetToolPos(int toolId ) const;
</ins><span class="cx"> int GetToolSeparation() const;
</span><del>-        /**
-         *
\brief Returns the short help for the given tool.
-         *
\param int
-        */
-
</del><span class="cx"> wxString GetToolShortHelp(int
toolId ) const;
</span><del>-        /**
-         *
\brief Gets the on/off state of a toggle tool.
-         *
\param int
-        */
-
</del><span class="cx"> bool GetToolState(int toolId )
const;
</span><del>-        /**
-         *
\brief Inserts the control into the toolbar at the given position.
-
-You must call for the change to take place.
-         *
\param size_t
-         *
\param wxControl *
-        */
-
- wxToolBarTool * InsertControl(size_t pos , wxControl * control ) ;
-        /**
-         *
\brief Inserts the separator into the toolbar at the given position.
-
-You must call for the change to take place.
-         *
\param size_t
-        */
-
- wxToolBarTool * InsertSeparator(size_t pos ) ;
-        /**
-         *
\brief
-         *
\param size_t
-         *
\param int
-         *
\param const wxBitmap&
-         *
\param const wxBitmap&
-         *
\param bool
-         *
\param wxObject*
-         *
\param const wxString&
-         *
\param const wxString&
-        */
-
- wxToolBarTool * InsertTool(size_t pos , int toolId , const wxBitmap&
bitmap1 , const wxBitmap& bitmap2 = wxNullBitmap, bool isToggle = false,
wxObject* clientData = NULL, const wxString& shortHelpString =
wxT(""), const wxString& longHelpString = wxT("")) ;
-        /**
-         *
\brief Inserts the tool with the specified attributes into the toolbar at the
given
-position.
-
-You must call for the change to take place.
-         *
\param size_t
-         *
\param wxToolBarTool*
-        */
-
- //wxToolBarTool * InsertTool(size_t pos , wxToolBarTool* tool );
-        /**
-         *
\brief Called when the user clicks on a tool with the left mouse button.
-
-This is the old way of detecting tool clicks; although it will still work,
-you should use the EVT_MENU or EVT_TOOL macro instead.
-         *
\param int
-         *
\param bool
-        */
-
</del><ins>+ wxToolBarToolBase * InsertControl(size_t pos ,
wxControl * control ) ;
+ wxToolBarToolBase * InsertSeparator(size_t pos ) ;
+ wxToolBarToolBase * InsertTool(size_t pos,
+                                                        
int toolId,
+                                                        
const wxString& label,
+                                                        
const wxBitmap& bitmap,
+                                                        
const wxBitmap& bmpDisabled = wxNullBitmap,
+                                                        
wxItemKind kind = wxITEM_NORMAL,
+                                                        
const wxString& shortHelp = wxEmptyString,
+                                                        
const wxString& longHelp = wxEmptyString,
+                                                        
wxObject *clientData = NULL) ;
+ wxToolBarToolBase * InsertTool(size_t pos , wxToolBarToolBase* tool );
</ins><span class="cx"> virtual bool OnLeftClick(int
toolId , bool toggleDown ) ;
</span><del>-        /**
-         *
\brief This is called when the mouse cursor moves into a tool or out of
-the toolbar.
-
-This is the old way of detecting mouse enter events; although it will still
work,
-you should use the EVT_TOOL_ENTER macro instead.
-         *
\param int
-        */
-
</del><span class="cx"> virtual void OnMouseEnter(int
toolId ) ;
</span><del>-        /**
-         *
\brief Called when the user clicks on a tool with the right mouse button. The
-programmer should override this function to detect right tool clicks.
-
-This is the old way of detecting tool right clicks; although it will still
work,
-you should use the EVT_TOOL_RCLICKED macro instead.
-         *
\param int
-         *
\param float
-         *
\param float
-        */
-
</del><span class="cx"> virtual void OnRightClick(int
toolId , float x , float y ) ;
</span><del>-        /**
-         *
\brief This function should be called after you have added tools.
-
-If you are using absolute positions for your tools when using a wxToolBarSimple
object,
-do not call this function. You must call it at all other times.
-        */
-
</del><span class="cx"> bool Realize() ;
</span><del>-        /**
-         *
\brief Removes the given tool from the toolbar but doesn''t delete it.
This allows to
-insert/add this tool back to this (or another) toolbar later.
-
-Note that it is unnecessary to call for the
-change to take place, it will happen immediately.
-         *
\param int
-        */
-
- wxToolBarTool * RemoveTool(int id ) ;
-        /**
-         *
\brief
-         *
\param const wxSize&
-        */
-
</del><ins>+ wxToolBarToolBase * RemoveTool(int id ) ;
</ins><span class="cx"> void SetMargins(const
wxSize& size ) ;
</span><del>-        /**
-         *
\brief
-         *
\param int
-         *
\param int
-        */
-
</del><span class="cx"> void SetMargins(int x , int y
) ;
</span><del>-        /**
-         *
\brief Sets the default size of each tool bitmap. The default bitmap size is 16
by 15 pixels.
-         *
\param const wxSize&
-        */
-
</del><ins>+ void SetRows(int rows);
</ins><span class="cx"> void SetToolBitmapSize(const
wxSize& size ) ;
</span><del>-        /**
-         *
\brief Sets the client data associated with the tool.
-         *
\param int
-         *
\param wxObject*
-        */
-
</del><span class="cx"> void SetToolClientData(int id ,
wxObject* clientData ) ;
</span><del>-        /**
-         *
\brief Sets the long help for the given tool.
-         *
\param int
-         *
\param const wxString&
-        */
-
</del><span class="cx"> void SetToolLongHelp(int toolId
, const wxString& helpString ) ;
</span><del>-        /**
-         *
\brief Sets the value used for spacing tools. The default value is 1.
-         *
\param int
-        */
-
</del><span class="cx"> void SetToolPacking(int packing
) ;
</span><del>-        /**
-         *
\brief
-         *
\param int
-         *
\param const wxString&
-        */
-
</del><span class="cx"> void SetToolShortHelp(int
toolId , const wxString& helpString ) ;
</span><del>-        /**
-         *
\brief Sets the default separator size. The default value is 5.
-         *
\param int
-        */
-
</del><span class="cx"> void SetToolSeparation(int
separation ) ;
</span><del>-        /**
-         *
\brief Toggles a tool on or off. This does not cause any event to get emitted.
-         *
\param int
-         *
\param const bool
-        */
-
</del><span class="cx"> void ToggleTool(int toolId ,
const bool toggle ) ;
</span><del>- // the following were missing from the xml
- void SetRows(int rows);
</del><span class="cx"> };
</span><span class="cx">
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>
Apparently Analagous Threads
- [1057] trunk/wxruby2/swig/classes/include/wxToolBar.h: Add new methods from the 2.8 API
- [1055] trunk/wxruby2/swig/classes/ToolBar.i: Chnage methods returning ToolBarToolBase to return position of new tool;
- [1103] trunk/wxruby2: Added 2.8 methods to StaticBitmap & document them; cleanup header file
- [893] branches/wxruby2/wxwidgets_282: New hover bitmap methods in 2.6 -> 2.8 API
- [883] branches/wxruby2/wxwidgets_282/swig: API changes for move to WxWidgets 2.8
Wisdom of the Ancients
