GNOME.org
 

[gtkmm-documentation] Book: Remove the optional API appendix.

commit b1fc530a5a54a0335dfe1e1befa8ffc2b7138b12
Author: Murray Cumming <murrayc murrayc com>
Date:   Tue Jun 1 09:04:10 2010 +0200

    Book: Remove the optional API appendix.
    
    * docs/tutorial/C/gtkmm-tutorial-in.xml: Remove the appendix about the
        reduced API because we no longer offer it in glibmm or gtkmm.

 ChangeLog                             |   17 +++-
 docs/tutorial/C/gtkmm-tutorial-in.xml |  147 ---------------------------------
 2 files changed, 12 insertions(+), 152 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index b9aa6ff..29d6b0e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,15 +1,22 @@
+2010-06-01  Murray Cumming  <murrayc murrayc com>
+
+	Book: Remove the optional API appendix.
+
+	* docs/tutorial/C/gtkmm-tutorial-in.xml: Remove the appendix about the
+    reduced API because we no longer offer it in glibmm or gtkmm.
+
 2010-05-31  Murray Cumming  <murrayc murrayc com>
 
 	Finish removal of use of reduced API.
-	
-	* examples/book/treeview/drag_and_drop/treemodel_dnd.cc: Removed some 
+
+	* examples/book/treeview/drag_and_drop/treemodel_dnd.cc: Removed some
 	orhpaned #endif lines left from my previous commit.
 
 2010-05-31  Murray Cumming  <murrayc murrayc com>
 
 	Remove use of reduced API.
 
-	* examples/*.[h|cc]: Remove all ifdefed code that supported the various 
+	* examples/*.[h|cc]: Remove all ifdefed code that supported the various
 	reduced API, because we no longer support that in latest glibmm and gtkmm.
 
 2010-05-07  David King  <davidk openismus com>
@@ -41,7 +48,7 @@
 
     Assistant chapter: Slight improvements to the text.
 
-	* docs/tutorial/C/gtkmm-tutorial-in.xml: Assistant chapter: simplify the 
+	* docs/tutorial/C/gtkmm-tutorial-in.xml: Assistant chapter: simplify the
     text, avoiding the passive.
 
 2010-04-01  David King  <davidk openismus com>
@@ -88,7 +95,7 @@
 2010-02-27  Murray Cumming  <murrayc murrayc com>
 
     Fix a typo in the Mixing C and C++ APIs chapter.
-  
+
 	* docs/tutorial/C/gtkmm-tutorial-in.xml: Mixing C and C++ APIs chapter:
 	Fix a typo.
 	Bug #610745 (Wouter Bolsterlee)
diff --git a/docs/tutorial/C/gtkmm-tutorial-in.xml b/docs/tutorial/C/gtkmm-tutorial-in.xml
index bdb83c0..3ca9c62 100644
--- a/docs/tutorial/C/gtkmm-tutorial-in.xml
+++ b/docs/tutorial/C/gtkmm-tutorial-in.xml
@@ -9349,153 +9349,6 @@ For instance,
 
 </appendix>
 
-
-<appendix id="chapter-optional-api">
-<title>Optional API</title>
-<para>The gtkmm API is meant to be easy and convenient. However, some of these
-    conveniences are not worth the overhead on reduced resources devices, such
-    as the Nokia 770 internet tablet. For instance, with regular gtkmm you can
-    implement a signal handler by deriving the class and overriding its virtual
-    <methodname>on_thesignalname()</methodname> method. But that additional API
-    increases code size. And in the case of virtual methods, it increases
-    per-object memory size, and demands that the linker loads the method's
-    symbol even if you don't use it.  Therefore, gtkmm can be built with a
-    reduced API. In general, the optional API is rarely used, and there are
-    slightly less convenient alternatives for all of the optional API.</para>
-<para>When gtkmm has been built with optional API disabled, macros will be
-    undefined, indicating that the API is not available. If you attempt to
-    compile an application that uses this optional API, against a version of
-    gtkmm that has disabled that API, you will see compiler warnings about
-    missing functions.</para>
-<para>The following sections describe the available configure options used to
-    disable optional API. Most developers will rarely need to provide these
-    configure options, because they will rarely build glibmm or gtkmm,
-    preferring to use official packages or installers. However, if you are
-    developing for an embedded device, you might need to be aware of these
-    options.</para>
-
-<sect1 id="sec-glibmm-optional-api">
-<title>Optional API when building glibmm</title>
-
-
-<sect2 id="glibmm-enable-deprecated">
-<title>--enable-deprecated-api=no</title>
-<para>
-    When enable-deprecated-api is disabled, no deprecated classes or methods
-    will be available in glibmm. For instance, the <code>Date::set_time(GTime
-        time)</code> method overload will not be provided. The reference
-    documentation contains a <ulink
-        url="&url_refdocs_base_glib_html;deprecated.html">full list of
-        deprecated glibmm API</ulink>.</para>
-<para>If deprecated glibmm API is available, the
-    <varname>GLIBMM_DISABLE_DEPRECATED</varname> macro will not be
-    defined.</para>
-</sect2>
-
-<sect2 id="glibmm-enable-exceptions">
-<title>--enable-api-exceptions=no</title>
-<para>
-When enable-api-exceptions is disabled, no exceptions will be used in the glibmm
-or gtkmm API, and no exceptions will be thrown. This allows applications to be
-built without support for exceptions. For intance, the <command>g++
-    -fno-exceptions</command> option may be used. Where a method would normally
-throw an exception, that method will instead take an additional
-<code>std::auto_ptr&lt;Glib::Error&gt;&amp;</code> output parameter. If you are
-not using exceptions then you should check whether this parameter was set and
-handle any error appropriately.</para>
-<para>If exceptions are not available, the
-    <varname>GLIBMM_EXCEPTIONS_ENABLED</varname> macro will not be
-    defined.</para>
-</sect2>
-
-<sect2 id="glibmm-enable-properties">
-<title>--enable-api-properties=no</title>
-<para>
-When enable-api-properties is disabled, no property accessors will be available in the glibmm or gtkmm API. For instance, the <methodname>Gtk::Button::property_label()</methodname> method will not be available. &quot;getter&quot; and &quot;setter&quot; methods, such as <methodname>Gtk::Button::set_label()</methodname> will still be available.</para>
-<para>When you really need to set or get the property value directly, for instance when using the <classname>Gtk::CellRenderer</classname> API, you can use the alternative <methodname>set_property()</methodname> and <methodname>get_property()</methodname> methods. For instance:</para>
-<para>
-<programlisting>
-#ifdef GLIBMM_PROPERTIES_ENABLED
-  m_cellrenderer.property_editable() = true;
-#else
-  m_cellrenderer.set_property("editable", true);
-#endif
-</programlisting>
-</para>
-<para>If property accessors are not available, the
-    <varname>GLIBMM_PROPERTIES_ENABLED</varname> macro will not be
-    defined.</para>
-</sect2>
-
-<sect2 id="glibmm-enable-vfuncs">
-<title>--enable-api-vfuncs=no</title>
-<para>
-    When enable-api-exceptions is disabled, no <methodname>_vfunc</methodname>
-    virtual methods will be available in the glibmm or gtkmm API. These methods
-    allow the developer to override some low-level behaviour of the underlying
-    GTK+ objects, and they are therefore rarely used. For instance,
-    <methodname>Gtk::Frame::compute_child_allocation_vfunc()</methodname> will not
-    be available.</para>
-<para>However, if you really need to override a <methodname>_vfunc</methodname>, for
-    instance when implementing a custom <classname>Gtk::TreeModel</classname>,
-    you may directly access the underlying GObject via the
-    <methodname>gobj()</methodname> method.</para>
-<para>If vfuncs are not available, the <varname>GLIBMM_VFUNCS_ENABLED</varname>
-    macro will not be defined.</para>
-</sect2>
-
-<sect2 id="glibmm-enable-default-signal-handlers">
-<title>--enable-api-default-signal-handlers=no</title>
-<para>
-When enable-api-exceptions is disabled, no virtual signal handler methods will
-be available in the glibmm or gtkmm API. For instance, the
-<methodname>Gtk::Button::on_clicked()</methodname> method will not be provided.
-Instead you must connect a signal handler by using the
-<methodname>signal_clicked()</methodname> accessor. This option offers a
-considerable code size and per-object memory reduction.</para>
-<para>Note, however, that the compiler will not complain if you attempt to
-    override a default signal handler when they are not supported by &gtkmm;,
-    because the compiler cannot know that you expected to override a virtual
-    method.</para>
-<para>If default signal handlers are not available, the
-    <varname>GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED</varname> macro will not be
-    defined.</para>
-</sect2>
-
-</sect1>
-
-<sect1 id="sec-gtkmm-optional-api">
-<title>Optional API when building gtkmm</title>
-
-<sect2 id="gtkmm-enable-deprecated">
-<title>--enable-deprecated-api=no</title>
-<para>
-    When enable-deprecated-api is disabled, no deprecated classes or methods
-    will be available in gtkmm. For instance, the
-    <classname>Gtk::FileSelection</classname> dialog will not be provided,
-    because it is replaced by <classname>Gtk::FileChooserDialog</classname>. The
-    reference documentation contains a <ulink
-        url="&url_refdocs_base_gtk_html;deprecated.html">full list of deprecated
-        gtkmm API</ulink>.</para>
-<para>If deprecated gtkmm API is available, the
-    <varname>GTKMM_DISABLE_DEPRECATED</varname> macro will not be
-    defined.</para>
-</sect2>
-
-<sect2 id="gtkmm-enable-atk">
-<title>--enable-api-atk=no</title>
-<para>
-    When enable-api-atk is disabled, no atkmm API will be available in gtkmm.
-    For instance, <classname>Gtk::Widget</classname> will not inherit from
-    <classname>Atk::Implementor</classname>.</para>
-<para>If the atkmm API is not available, the
-    <varname>GTKMM_ATKMM_ENABLED</varname> macro will not be defined.</para>
-</sect2>
-
-</sect1>
-
-</appendix>
-
 </book>
 
 <!-- some vim settings
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]