nobody at rubyforge.org
2007-Mar-22 09:53 UTC
[Wxruby-development] [912] trunk/wxsugar/lib: Overview documentation moved to lib/wx_sugar.rb
<!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>[912] trunk/wxsugar/lib: Overview documentation moved to lib/wx_sugar.rb</title> </head> <body> <div id="msg"> <dl> <dt>Revision</dt> <dd>912</dd> <dt>Author</dt> <dd>brokentoy</dd> <dt>Date</dt> <dd>2007-03-22 05:53:13 -0400 (Thu, 22 Mar 2007)</dd> </dl> <h3>Log Message</h3> <pre>Overview documentation moved to lib/wx_sugar.rb</pre> <h3>Modified Paths</h3> <ul> <li><a href="#trunkwxsugarlibwx_sugarallrb">trunk/wxsugar/lib/wx_sugar/all.rb</a></li> <li><a href="#trunkwxsugarlibwx_sugarrb">trunk/wxsugar/lib/wx_sugar.rb</a></li> </ul> </div> <div id="patch"> <h3>Diff</h3> <a id="trunkwxsugarlibwx_sugarallrb"></a> <div class="modfile"><h4>Modified: trunk/wxsugar/lib/wx_sugar/all.rb (911 => 912)</h4> <pre class="diff"><span> <span class="info">--- trunk/wxsugar/lib/wx_sugar/all.rb        2007-03-22 09:26:31 UTC (rev 911) +++ trunk/wxsugar/lib/wx_sugar/all.rb        2007-03-22 09:53:13 UTC (rev 912) </span><span class="lines">@@ -1,71 +1,3 @@ </span><del>-# = WxSugar -# -# WxSugar is a set of additions to the WxRuby API, written in pure -# ruby. They''re intended to: -# -# * Make some tricky WxWidgets things easier and more consistent -# * Reduce repetitiveness and redundancy for common tasks -# * Make code more expressive -# * Make code more idiomatically Rubyish -# -# Not everyone will like all the extensions to WxRuby here. So the -# Sugar modules: -# -# * Can generally be used separately, without depending on each other -# * Supplement rather than replace the underlying ''raw'' API -# -# == Using WxSugar -# -# The extensions can currently be used with WxRuby2 or the old WxRuby -# (0.6.0). WxRuby2 is strongly recommended, and support for the old -# series may be dropped in the future. -# -# The simplest way to use WxSugar is to load all the behaviours. You -# should load the wx library first: -# -# require ''wx'' -# # OR ... old non-SWIG beta veresion -# require ''wxruby'' -# -# require ''wx_sugar/all'' -# ... -# -# If you only want to load specific WxSugar behaviours, just +require+ -# the desired extensions only -# -# require ''wx_sugar/keyword_constructors'' -# require ''wx_sugar/acccessors'' -# -# == Overview of extensions -# -# The following are the WxSugar behaviours that are available. In -# general you require one of these extensions, it modifies the behaviour -# of all relevant Wx classes, and affects all new instances. -# -# [accessors] -# Provide ruby-style getters, setters and question-mark methods -# [delayed_constructors] -# Required by +layout+, of limited independent interest -# [event_connector] -# Neater syntax for connecting event listeners -# [keyword_constructors] -# Use keyword-style hash arguments to construct widgets -# [layout] -# Easy interface to using WxWidgets Sizers to arrange controls -# [menu] -# Create and update menus without a mess of system ids -# [wx_classes] -# Useful ruby methods added to individual Wx classes. -# -# === Deprecated extensions -# -# This module is deprecated and will soon be removed. -# -# [itemdata.rb] -# Linking ruby objects with wx controls; use the -# get/set_item_data methods in core wxruby2 instead. - - </del><span class="cx"> %w[ accessors delayed_constructors event_connector </span><span class="cx"> keyword_constructors layout menu wx_classes ].each do | ext_feature | </span><span class="cx"> require ''wx_sugar/'' + ext_feature </span></span></pre></div> <a id="trunkwxsugarlibwx_sugarrb"></a> <div class="modfile"><h4>Modified: trunk/wxsugar/lib/wx_sugar.rb (911 => 912)</h4> <pre class="diff"><span> <span class="info">--- trunk/wxsugar/lib/wx_sugar.rb        2007-03-22 09:26:31 UTC (rev 911) +++ trunk/wxsugar/lib/wx_sugar.rb        2007-03-22 09:53:13 UTC (rev 912) </span><span class="lines">@@ -1 +1,66 @@ </span><ins>+# = WxSugar +# +# WxSugar is a set of additions to the WxRuby API, written in pure +# ruby. They''re intended to: +# +# * Make some tricky WxWidgets things easier and more consistent +# * Reduce repetitiveness and redundancy for common tasks +# * Make code more expressive +# * Make code more idiomatically Rubyish +# +# Not everyone will like all the extensions to WxRuby here. So the +# Sugar modules: +# +# * Can generally be used separately, without depending on each other +# * Supplement rather than replace the underlying ''raw'' API +# +# == Using WxSugar +# +# As of version 0.1.14, the WxSugar extensions require the latest +# version of WxRuby2, preview 0.0.39. Support for the old series of +# WxRuby (version 0.6.0) has now been dropped. +# +# The simplest way to use WxSugar is to load all the behaviours. You +# should load the wx library first: +# +# require ''wx'' +# require ''wx_sugar'' +# ... +# +# If you only want to load specific WxSugar behaviours, just +require+ +# the desired extensions only +# +# require ''wx_sugar/keyword_constructors'' +# require ''wx_sugar/acccessors'' +# +# == Overview of extensions +# +# The following are the WxSugar behaviours that are available. In +# general you require one of these extensions, it modifies the behaviour +# of all relevant Wx classes, and affects all new instances. +# +# [accessors] +# Provide ruby-style getters, setters and question-mark methods +# [delayed_constructors] +# Required by +layout+, of limited independent interest +# [event_connector] +# Neater syntax for connecting event listeners +# [keyword_constructors] +# Use keyword-style hash arguments to construct widgets +# [layout] +# Easy interface to using WxWidgets Sizers to arrange controls +# [menu] +# Create and update menus without a mess of system ids +# [wx_classes] +# Useful ruby methods added to individual Wx classes. +# +# === Deprecated extensions +# +# This module is deprecated and will soon be removed. +# +# [itemdata.rb] +# Linking ruby objects with wx controls; use the +# get/set_item_data methods in core wxruby2 instead. + + </ins><span class="cx"> require ''wx_sugar/all'' </span></span></pre> </div> </div> </body> </html>
Reasonably Related Threads
- [773] trunk/wxsugar/lib/wx_sugar/all.rb: Updated overview, deprecated itemdata
- [945] trunk/wxsugar/lib/wx_sugar.rb: Add note about enumerable_controls, reorder list of extensions
- [771] trunk/wxsugar/lib/wx_sugar/keyword_constructors.rb: Fix typo in error message
- [836] trunk/wxsugar/lib/wx_sugar: Make :validator and :name sugary ctor args work for Controls classes
- wxSugar control problem