<html> <head> <title>Interface XUndoManager</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XUndoManager-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">chart2</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XUndoManager</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>An interface for undo functionality based on passing frame::XModel objects. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#preAction">preAction</a></td> <td class="imsum_right">call this before you change the xCurrentModel </td> </tr> <tr> <td class="imsum_left"><a href="#preActionWithArguments">preActionWithArguments</a></td> <td class="imsum_right">call this before you change the xCurrentModel. You can pass parameters to refine the undo action. </td> </tr> <tr> <td class="imsum_left"><a href="#postAction">postAction</a></td> <td class="imsum_right">call this after you successfully did changes to your current model </td> </tr> <tr> <td class="imsum_left"><a href="#cancelAction">cancelAction</a></td> <td class="imsum_right">call this if you aborted the current action. </td> </tr> <tr> <td class="imsum_left"><a href="#cancelActionWithUndo">cancelActionWithUndo</a></td> <td class="imsum_right">same as cancelAction() but restores the given model to the state set in preAction. This is useful for cancellation in live-preview dialogs. </td> </tr> <tr> <td class="imsum_left"><a href="#undo">undo</a></td> <td class="imsum_right">give the current model to be put into the redo-stack </td> </tr> <tr> <td class="imsum_left"><a href="#redo">redo</a></td> <td class="imsum_right">give the current model to be put into the undo-stack </td> </tr> <tr> <td class="imsum_left"><a href="#undoPossible">undoPossible</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#redoPossible">redoPossible</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getCurrentUndoString">getCurrentUndoString</a></td> <td class="imsum_right">Retrieves the undo string for the most recent undo step </td> </tr> <tr> <td class="imsum_left"><a href="#getCurrentRedoString">getCurrentRedoString</a></td> <td class="imsum_right">Retrieves the redo string for the most recent undo step </td> </tr> <tr> <td class="imsum_left"><a href="#getAllUndoStrings">getAllUndoStrings</a></td> <td class="imsum_right">Retrieves the undo strings of all stored undo actions in chronological order starting with the most recent. </td> </tr> <tr> <td class="imsum_left"><a href="#getAllRedoStrings">getAllRedoStrings</a></td> <td class="imsum_right">Retrieves the redo strings of all stored undo actions in chronological order starting with the most recent. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="preAction" class="membertitle">preAction</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>preAction</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a></td> <td valign="bottom"> xModelBeforeChange );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>call this before you change the xCurrentModel </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="preActionWithArguments" class="membertitle">preActionWithArguments</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>preActionWithArguments</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a></td> <td valign="bottom"> xModelBeforeChange,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> aArguments );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>call this before you change the xCurrentModel. You can pass parameters to refine the undo action. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="postAction" class="membertitle">postAction</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>postAction</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aUndoText );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>call this after you successfully did changes to your current model </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="cancelAction" class="membertitle">cancelAction</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>cancelAction</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>call this if you aborted the current action. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="cancelActionWithUndo" class="membertitle">cancelActionWithUndo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>cancelActionWithUndo</b>(</td> <td valign="top">[inout] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a></td> <td valign="bottom"> xModelToRestore );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>same as cancelAction() but restores the given model to the state set in preAction. This is useful for cancellation in live-preview dialogs. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="undo" class="membertitle">undo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>undo</b>(</td> <td valign="top">[inout] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a></td> <td valign="bottom"> xCurrentModel );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>give the current model to be put into the redo-stack </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="redo" class="membertitle">redo</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>redo</b>(</td> <td valign="top">[inout] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XModel.html">XModel</a></td> <td valign="bottom"> xCurrentModel );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>give the current model to be put into the undo-stack </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="undoPossible" class="membertitle">undoPossible</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>undoPossible</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd><b>true</b> if the undo stack is not empty, i.e. a call to undo() will succeed </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="redoPossible" class="membertitle">redoPossible</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>redoPossible</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd><b>true</b> if the redo stack is not empty, i.e. a call to redo() will succeed </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCurrentUndoString" class="membertitle">getCurrentUndoString</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getCurrentUndoString</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Retrieves the undo string for the most recent undo step </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCurrentRedoString" class="membertitle">getCurrentRedoString</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getCurrentRedoString</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Retrieves the redo string for the most recent undo step </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAllUndoStrings" class="membertitle">getAllUndoStrings</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getAllUndoStrings</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Retrieves the undo strings of all stored undo actions in chronological order starting with the most recent. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAllRedoStrings" class="membertitle">getAllRedoStrings</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getAllRedoStrings</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Retrieves the redo strings of all stored undo actions in chronological order starting with the most recent. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
1836
