libyui
3.0.10
|
00001 /* 00002 Copyright (C) 2000-2012 Novell, Inc 00003 This library is free software; you can redistribute it and/or modify 00004 it under the terms of the GNU Lesser General Public License as 00005 published by the Free Software Foundation; either version 2.1 of the 00006 License, or (at your option) version 3.0 of the License. This library 00007 is distributed in the hope that it will be useful, but WITHOUT ANY 00008 WARRANTY; without even the implied warranty of MERCHANTABILITY or 00009 FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 00010 License for more details. You should have received a copy of the GNU 00011 Lesser General Public License along with this library; if not, write 00012 to the Free Software Foundation, Inc., 51 Franklin Street, Fifth 00013 Floor, Boston, MA 02110-1301 USA 00014 */ 00015 00016 00017 /*-/ 00018 00019 File: YMacroRecorder.h 00020 00021 Author: Stefan Hundhammer <sh@suse.de> 00022 00023 /-*/ 00024 00025 #ifndef YMacroRecorder_h 00026 #define YMacroRecorder_h 00027 00028 #include <string> 00029 00030 class YWidget; 00031 00032 00033 /** 00034 * Abstract base class for macro recorders. 00035 * 00036 * Applications should not use this directly, but the static methods in YMacro. 00037 **/ 00038 class YMacroRecorder 00039 { 00040 friend class YMacro; 00041 00042 protected: 00043 00044 /** 00045 * Constructor 00046 **/ 00047 YMacroRecorder() {} 00048 00049 public: 00050 /** 00051 * Destructor 00052 **/ 00053 virtual ~YMacroRecorder() {} 00054 00055 /** 00056 * Start recording a macro to the specified file. 00057 **/ 00058 virtual void record( const std::string & macroFileName ) = 0; 00059 00060 /** 00061 * End recording and close the current macro file (if there is any). 00062 **/ 00063 virtual void endRecording() = 0; 00064 00065 /** 00066 * Return 'true' if a macro is currently being recorded. 00067 **/ 00068 virtual bool recording() const = 0; 00069 00070 /** 00071 * Record one widget property. 00072 **/ 00073 virtual void recordWidgetProperty( YWidget * widget, 00074 const char * propertyName ) = 0; 00075 00076 /** 00077 * Record a "UI::MakeScreenShot()" statement. 00078 * 00079 * If 'enabled' is 'false', this statement will be commented out. 00080 * If no file name is given, a default file name (with auto-increment) will 00081 * be used. 00082 **/ 00083 virtual void recordMakeScreenShot( bool enabled = false, 00084 const std::string & filename = std::string() ) = 0; 00085 }; 00086 00087 #endif // YMacroRecorder_h