<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>gtksourceviewmm: gtksourceview::SourceUndoManager Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>gtksourceview</b>::<a class="el" href="classgtksourceview_1_1SourceUndoManager.html">SourceUndoManager</a>
</div>
</div>
<div class="contents">
<h1>gtksourceview::SourceUndoManager Class Reference</h1><!-- doxytag: class="gtksourceview::SourceUndoManager" --><!-- doxytag: inherits="Glib::Interface" -->
<p>Undo manager interface for <a class="el" href="classgtksourceview_1_1SourceView.html" title="The view object.">SourceView</a>. <a href="#_details">More...</a></p>
<p><code>#include <gtksourceviewmm/sourceundomanager.h></code></p>
<div class="dynheader">
Inheritance diagram for gtksourceview::SourceUndoManager:</div>
<div class="dynsection">
<div class="center"><img src="classgtksourceview_1_1SourceUndoManager__inherit__graph.png" border="0" usemap="#gtksourceview_1_1SourceUndoManager_inherit__map" alt="Inheritance graph"/></div>
<map name="gtksourceview_1_1SourceUndoManager_inherit__map" id="gtksourceview_1_1SourceUndoManager_inherit__map">
<area shape="rect" id="node2" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="80,160,197,189"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="71,83,207,112"/><area shape="rect" id="node6" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="79,5,199,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgtksourceview_1_1SourceUndoManager-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a847d06ac9ae3109193227c4c677eb221"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::gobj" ref="a847d06ac9ae3109193227c4c677eb221" args="()" -->
GtkSourceUndoManager* </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a847d06ac9ae3109193227c4c677eb221">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff2a4b0f661c69e34d0dde4e20fc1270"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::gobj" ref="aff2a4b0f661c69e34d0dde4e20fc1270" args="() const " -->
const GtkSourceUndoManager* </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#aff2a4b0f661c69e34d0dde4e20fc1270">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#ab076c197c4f7c9c0fae908e882404a62">can_undo</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get whether there are undo operations available. <a href="#ab076c197c4f7c9c0fae908e882404a62"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a423580d657a052fe54f5bc7b81b3983d">can_redo</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get whether there are redo operations available. <a href="#a423580d657a052fe54f5bc7b81b3983d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#abfd74b362a3131adc16eea09fe2cd49e">undo</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform a single undo. <a href="#abfd74b362a3131adc16eea09fe2cd49e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a55ddd7329266347ba92644c1b8902d04">redo</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform a single redo. <a href="#a55ddd7329266347ba92644c1b8902d04"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a392331bbdc99eed37dfbf1c714fd0948">begin_not_undoable_action</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Begin a not undoable action on the buffer. <a href="#a392331bbdc99eed37dfbf1c714fd0948"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a71f9f116219913d06ce2124b5eee4e24">end_not_undoable_action</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ends a not undoable action on the buffer. <a href="#a71f9f116219913d06ce2124b5eee4e24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a99cc18ecf00a10b5c20b36e3863b85b6">can_undo_changed</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Emits the 'can-undo-changed' signal. <a href="#a99cc18ecf00a10b5c20b36e3863b85b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a2156f5e5851e0a8d5b5d9c7faa72cee6">can_redo_changed</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Emits the 'can-redo-changed' signal. <a href="#a2156f5e5851e0a8d5b5d9c7faa72cee6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a6a5fbfd832cee6bbce477e93aa844e88">signal_can_undo_changed</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when the ability to undo has changed. <a href="#a6a5fbfd832cee6bbce477e93aa844e88"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a28d905b153b5f541bea38b5c3113db24">signal_can_redo_changed</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when the ability to redo has changed. <a href="#a28d905b153b5f541bea38b5c3113db24"></a><br/></td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak"/>
< <a class="el" href="classgtksourceview_1_1SourceUndoManager.html">gtksourceview::SourceUndoManager</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a00d385e74d671baeb71ae1cf356ba7be">wrap</a> (GtkSourceUndoManager* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a00d385e74d671baeb71ae1cf356ba7be"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Undo manager interface for <a class="el" href="classgtksourceview_1_1SourceView.html" title="The view object.">SourceView</a>. </p>
<p>The <a class="el" href="classgtksourceview_1_1SourceUndoManager.html" title="Undo manager interface for SourceView.">SourceUndoManager</a> interface can be implemented to provide custom undo management to a <a class="el" href="classgtksourceview_1_1SourceBuffer.html" title="Buffer object for SourceView.">SourceBuffer</a>. Use <a class="el" href="classgtksourceview_1_1SourceBuffer.html#a7a60b643c3acb4b10ca592587a826a81" title="Set the buffer undo manager.">SourceBuffer::set_undo_manager()</a> to install a custom undo manager for a particular source buffer.</p>
<p>Use <a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a99cc18ecf00a10b5c20b36e3863b85b6" title="Emits the 'can-undo-changed' signal.">SourceUndoManager::can_undo_changed()</a> and <a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a2156f5e5851e0a8d5b5d9c7faa72cee6" title="Emits the 'can-redo-changed' signal.">SourceUndoManager::can_redo_changed()</a> when respectively the undo state or redo state of the undo stack has changed.</p>
<dl class="since_2_10"><dt><b><a class="el" href="since__2__10.html#_since_2_10000141">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a392331bbdc99eed37dfbf1c714fd0948"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::begin_not_undoable_action" ref="a392331bbdc99eed37dfbf1c714fd0948" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gtksourceview::SourceUndoManager::begin_not_undoable_action </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Begin a not undoable action on the buffer. </p>
<p>All changes between this call and the call to <a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a71f9f116219913d06ce2124b5eee4e24" title="Ends a not undoable action on the buffer.">end_not_undoable_action()</a> cannot be undone. This function should be re-entrant.</p>
<dl class="since_2_10"><dt><b><a class="el" href="since__2__10.html#_since_2_10000146">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a423580d657a052fe54f5bc7b81b3983d"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::can_redo" ref="a423580d657a052fe54f5bc7b81b3983d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gtksourceview::SourceUndoManager::can_redo </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get whether there are redo operations available. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if there are redo operations available, <code>false</code> otherwise.</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since__2__10.html#_since_2_10000143">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a2156f5e5851e0a8d5b5d9c7faa72cee6"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::can_redo_changed" ref="a2156f5e5851e0a8d5b5d9c7faa72cee6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gtksourceview::SourceUndoManager::can_redo_changed </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Emits the 'can-redo-changed' signal. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since__2__10.html#_since_2_10000149">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="ab076c197c4f7c9c0fae908e882404a62"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::can_undo" ref="ab076c197c4f7c9c0fae908e882404a62" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool gtksourceview::SourceUndoManager::can_undo </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get whether there are undo operations available. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if there are undo operations available, <code>false</code> otherwise.</dd></dl>
<dl class="since_2_10"><dt><b><a class="el" href="since__2__10.html#_since_2_10000142">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a99cc18ecf00a10b5c20b36e3863b85b6"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::can_undo_changed" ref="a99cc18ecf00a10b5c20b36e3863b85b6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gtksourceview::SourceUndoManager::can_undo_changed </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Emits the 'can-undo-changed' signal. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since__2__10.html#_since_2_10000148">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a71f9f116219913d06ce2124b5eee4e24"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::end_not_undoable_action" ref="a71f9f116219913d06ce2124b5eee4e24" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gtksourceview::SourceUndoManager::end_not_undoable_action </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Ends a not undoable action on the buffer. </p>
<dl class="since_2_10"><dt><b><a class="el" href="since__2__10.html#_since_2_10000147">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a55ddd7329266347ba92644c1b8902d04"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::redo" ref="a55ddd7329266347ba92644c1b8902d04" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gtksourceview::SourceUndoManager::redo </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform a single redo. </p>
<p>Calling this function when there are no redo operations available is an error. Use <a class="el" href="classgtksourceview_1_1SourceUndoManager.html#a423580d657a052fe54f5bc7b81b3983d" title="Get whether there are redo operations available.">can_redo()</a> to find out if there are redo operations available.</p>
<dl class="since_2_10"><dt><b><a class="el" href="since__2__10.html#_since_2_10000145">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a28d905b153b5f541bea38b5c3113db24"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::signal_can_redo_changed" ref="a28d905b153b5f541bea38b5c3113db24" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > gtksourceview::SourceUndoManager::signal_can_redo_changed </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Emitted when the ability to redo has changed. </p>
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_can_redo_changed()</code> </dd></dl>
</div>
</div>
<a class="anchor" id="a6a5fbfd832cee6bbce477e93aa844e88"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::signal_can_undo_changed" ref="a6a5fbfd832cee6bbce477e93aa844e88" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1SignalProxy0.html">Glib::SignalProxy0</a>< void > gtksourceview::SourceUndoManager::signal_can_undo_changed </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Emitted when the ability to undo has changed. </p>
<dl class="user"><dt><b>Prototype:</b></dt><dd><code>void on_my_can_undo_changed()</code> </dd></dl>
</div>
</div>
<a class="anchor" id="abfd74b362a3131adc16eea09fe2cd49e"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::undo" ref="abfd74b362a3131adc16eea09fe2cd49e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gtksourceview::SourceUndoManager::undo </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform a single undo. </p>
<p>Calling this function when there are no undo operations available is an error. Use <a class="el" href="classgtksourceview_1_1SourceUndoManager.html#ab076c197c4f7c9c0fae908e882404a62" title="Get whether there are undo operations available.">can_undo()</a> to find out if there are undo operations available.</p>
<dl class="since_2_10"><dt><b><a class="el" href="since__2__10.html#_since_2_10000144">Since gtksourceviewmm 2.10:</a></b></dt><dd></dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a00d385e74d671baeb71ae1cf356ba7be"></a><!-- doxytag: member="gtksourceview::SourceUndoManager::wrap" ref="a00d385e74d671baeb71ae1cf356ba7be" args="(GtkSourceUndoManager *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classgtksourceview_1_1SourceUndoManager.html">gtksourceview::SourceUndoManager</a> > wrap </td>
<td>(</td>
<td class="paramtype">GtkSourceUndoManager * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
