/usr/include/wxsmith/wxwidgets/wxsitemresdata.h is in libwxsmithlib-dev 13.12+dfsg-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 | /*
* This file is part of wxSmith plugin for Code::Blocks Studio
* Copyright (C) 2006-2007 Bartlomiej Swiecki
*
* wxSmith is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* wxSmith is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with wxSmith. If not, see <http://www.gnu.org/licenses/>.
*
* $Revision: 8574 $
* $Id: wxsitemresdata.h 8574 2012-11-18 15:59:14Z mortenmacfly $
* $HeadURL: http://svn.code.sf.net/p/codeblocks/code/branches/release-xx.yy/src/plugins/contrib/wxSmith/wxwidgets/wxsitemresdata.h $
*/
#ifndef WXSITEMRESDATA_H
#define WXSITEMRESDATA_H
#include "wxsitem.h"
#include "wxsparent.h"
#include "wxsitemres.h"
#include "wxscorrector.h"
#include "wxsitemundobuffer.h"
#include "wxsitemresdataobject.h"
#include "../wxsresourcetree.h"
class wxsTool;
class wxsItemEditor;
/** \brief Class holding data for item resources and operating on it */
class wxsItemResData
{
public:
/** \brief Ctor
*
* Constructor tries to load resource. Depending on what
* parameters are empty strings, given type of file is assumed.
* - If Wxs, Src and Hdr file names are empty, it's only Xrc file.
* - If Xrc is empty but no other, it's resource not using Xrc file
* - If all file names are not empty, it's resource using Xrc file
* - Other combinations are invalid.
*
* Parameters passed to constructor are GLOBAL paths (opposite to
* wxsItemRes where names are relative to .cbp's directory).
*/
wxsItemResData(
const wxString& WxsFileName,
const wxString& SrcFileName,
const wxString& HdrFileName,
const wxString& XrcFileName,
const wxString& ClassName,
const wxString& ClassType,
wxsCodingLang Language,
bool UseForwardDeclarations,
bool WithTranslation,
wxsResourceItemId TreeId,
wxsItemEditor* Editor,
wxsItemResFunctions* Functions
);
/** \brief Dctor
*
* \note When wxsItemResData is deleted and the
* data is in modified state (was not saved after modification),
* all changes are lost. Please call Save() to avoid this.
*/
virtual ~wxsItemResData();
/** \brief Loading resource
*
* This function (Re)loads resource from
* files. Current resource content is moved into
* undo buffer and resource data is replaced by the one
* loaded from file.
*/
bool Load();
/** \brief Saving resource
*
* This function saves resource to wxs file
* (note that Src / Hdr / Xrc files are not saved
* because they're updated after each resource change)
*/
bool Save();
/** \brief Checking if resource was loaded properly
*
* This function may be used to check if resource was properly
* loaded. It may be especially usual after checking if
* constructor has loaded all data properly.
*/
inline bool IsOk() { return m_IsOK; }
/** \brief Function starting change of resource data
*
* This function Notifies that resource is going to change.
* It locks data from other changes. Each resource
* change must be finished with call to EndChange function.
* Between BeginChange and EndChange call there should not
* be any call to gui item, so do not jump out of event
* function before EndChange is called.
*
* Change of resource is any operation made on any wxsItem
* class inside the resource (including the root class).
*/
void BeginChange();
/** \brief Function ending change of resource data
*
* This function must be paired with BeginChange() call.
* it notifies that change of resource has been finished
* and that it's good time to update all data on the screen
* ans store new undo buffer entry.
*/
void EndChange();
/** \brief Checking if item has modified state */
inline bool GetModified() { return m_Undo.IsModified(); }
/** \brief Getting root item
* \return pointer to item on success, 0 when data wasn't initialized properly
*/
inline wxsItem* GetRootItem() { return m_RootItem; }
/** \brief Getting main item of selection */
inline wxsItem* GetRootSelection() { return m_RootSelection; }
/** \brief Getting properties filter based on current edit mode */
inline int GetPropertiesFilter() { return m_PropertiesFilter; }
/** \brief Getting name of wxs file (global path) */
inline const wxString& GetWxsFileName() { return m_WxsFileName; }
/** \brief Getting name of source file (global path) */
inline const wxString& GetSrcFileName() { return m_SrcFileName; }
/** \brief Getting name of header file (global path) */
inline const wxString& GetHdrFileName() { return m_HdrFileName; }
/** \brief Getting name of XRC file (global path) */
inline const wxString& GetXrcFileName() { return m_XrcFileName; }
/** \brief Getting name of class of edited resource */
inline const wxString& GetClassName() { return m_ClassName; }
/** \brief Getting name class used as base for this resource (like wxDialog) */
inline const wxString& GetClassType() { return m_ClassType; }
/** \brief Getting state of internationalize, this allows for translation */
inline bool GetTranslation() { return m_Translation; }
/** \brief Getting language used in resource */
inline wxsCodingLang GetLanguage() { return m_Language; }
/** \brief Searching for tree id in main resource tree for given item */
inline bool GetTreeId(wxsResourceItemId& Id,wxsItem* Item) { return FindId(Id,Item); }
/** \brief Showing popup menu from given item */
inline wxsItemEditor* GetEditor() { return m_Editor; }
/* ************************ */
/* Undo buffer operations */
/* ************************ */
/** \brief Checking if can Undo */
inline bool CanUndo() { return m_Undo.CanUndo(); }
/** \brief Checking if can Redo */
inline bool CanRedo() { return m_Undo.CanRedo(); }
/** \brief Undoing */
inline void Undo() { SetXmlData(m_Undo.Undo()); }
/** \brief Redoing */
inline void Redo() { SetXmlData(m_Undo.Redo()); }
/** \brief Checking if current content is read only */
inline bool IsReadOnly() { return m_ReadOnly; }
/* ********************** */
/* Clipboard operations */
/* ********************** */
/** \brief Checking if we can paste current clipboard content */
bool CanPaste();
/** \brief Cutting current selection to clipboard */
void Cut();
/** \brief Copying current selection to clipboard */
void Copy();
/** \brief Pasting components from clipboard
* \param Parent parent for new items
* \param Position initial position for new items
*/
void Paste(wxsParent* Parent,int Position);
/* ********************** */
/* Selection operations */
/* ********************** */
/** \brief Checking of there's any selection */
bool AnySelected();
/** \brief Selecting one item */
bool SelectItem(wxsItem* Item,bool UnselectOther);
/** \brief Getting last selected item or 0 if there's no valid selection */
inline wxsItem* GetLastSelection() { return m_RootSelection; }
/* ******************* */
/* Operating on data */
/* ******************* */
/** \brief Adding new item
*
* This function tries to add new item into
* given position. If it's possible, new item
* is added and true is returned. If it's
* impossible, new item is deleted internally
* and function returns false.
* \note To add tool item use InsertNewTool
* \param New new item
* \param Parent item which will become parent of New
* \param Position position inside Parent (if <0 or out of range,
* appending New at the end of Parent's children)
*/
bool InsertNew(wxsItem* New,wxsParent* Parent,int Position);
/** \brief Adding new tool
*
* This function adds new tool into this resource.
* Since tools require special treatment, they
* need separate function.
* \param Tool new tool
* \return true on success, false otherwise
*/
bool InsertNewTool(wxsTool* Tool);
/** \brief Deleting all selected items */
void DeleteSelected();
/** \brief Getting number of tools */
inline int GetToolsCount() { return (int)m_Tools.Count(); }
/** \brief Getting tool at given index */
inline wxsTool* GetTool(int Index) { return ((Index>=0)&&(Index<GetToolsCount())) ? m_Tools[Index] : 0; }
/* ******************* */
/* Preview functions */
/* ******************* */
/** \brief Checking if there's preview already */
inline bool IsPreview() { return m_Preview!=0; }
/** \brief Showing preview of current resource content */
bool ShowPreview();
/** \brief Closing window with current resource content */
bool HidePreview();
/** \brief Function notifying that preview has been closed externally */
inline void NotifyPreviewClosed() { m_Preview = 0; }
/* *********************** */
/* Notification handlers */
/* *********************** */
/** \brief Notification of change of data
*
* This function is called from wxsItem objects
* notifying about change of such item.
*/
void NotifyChange(wxsItem* Changed);
private:
WX_DECLARE_STRING_HASH_MAP(TiXmlElement*,IdToXmlMapT);
WX_DECLARE_HASH_MAP(wxsItem*,wxsResourceItemId,wxPointerHash,wxPointerEqual,ItemToIdMapT);
WX_DEFINE_ARRAY(wxsTool*,ToolArrayT);
/** \brief Generating string with xml data for this item
* \note used when creating undo entries
*/
wxString GetXmlData();
/** \brief Restoring resource data from string with xml data */
bool SetXmlData(const wxString& XmlData);
/** \brief Rebuilding all files kept up-to-date after change in resource */
void RebuildFiles();
/** \brief Rebuilding sources for this resource */
void RebuildSourceCode();
/** \brief Rebuilding XRC file managed by this resource */
bool RebuildXrcFile();
// Various loading functions
bool SilentLoad();
bool LoadInFileMode();
bool LoadInMixedMode();
bool LoadInSourceMode();
void UpdateExtraDataReq(wxsItem* Item,IdToXmlMapT& Map);
void RecreateRootItem();
void LoadToolsReq(TiXmlElement* Node,bool IsXRC,bool IsExtra);
// Various saving function
bool SaveInFileMode();
bool SaveInMixedMode();
bool SaveInSourceMode();
void SaveExtraDataReq(wxsItem* Item,TiXmlElement* Node);
// Some misc functions
inline void StoreUndo() { m_Undo.StoreChange(GetXmlData()); }
bool ValidateRootSelection();
bool ValidateRootSelectionReq(wxsItem* Item,wxsItem*& NewSelection);
void CopyReq(wxsItem* Item,wxsItemResDataObject* Data);
bool AnySelectedReq(wxsItem* Item);
void StoreTreeExpandState();
void StoreTreeExpandStateReq(wxsItem* Item);
void RestoreTreeExpandAndSelectionState();
void RestoreTreeExpandAndSelectionStateReq(wxsItem* Item);
void DeleteSelectedReq(wxsItem* Item);
void RebuildTree();
void StoreTreeIds();
void StoreTreeIdsReq(wxsItem* Item);
bool FindId(wxsResourceItemId& Id,wxsItem* Item);
void DetectAutoCodeBlocks();
// Functions used by RebuildSourceCode
wxString DeclarationsCode(wxsCoderContext* Ctx);
wxString IdentifiersCode(wxsCoderContext* Ctx);
wxString InitializeCode(wxsCoderContext* Ctx);
wxString IdInitCode(wxsCoderContext* Ctx);
wxString HeadersCode(wxsCoderContext* Ctx);
wxString HeadersNoPCHCode(wxsCoderContext* Ctx);
wxString HeadersAllCode(wxsCoderContext* Ctx);
wxString InternalHeadersCode(wxsCoderContext* Ctx);
wxString InternalHeadersNoPCHCode(wxsCoderContext* Ctx);
wxString InternalHeadersAllCode(wxsCoderContext* Ctx);
wxString XRCLoadingCode();
// Wrappers to m_Functions functionality
inline wxWindow* BuildExactPreview(wxWindow* Parent) { return m_Functions->OnBuildExactPreview(Parent,this); }
wxString m_WxsFileName;
wxString m_SrcFileName;
wxString m_HdrFileName;
wxString m_XrcFileName;
bool m_Translation; // Generate strings with _() macro instead of _T() macro
wxString m_ClassName;
wxString m_ClassType;
wxsCodingLang m_Language;
wxsResourceItemId m_TreeId;
wxsResourceItemId m_ToolsId;
bool m_ToolsNodeIsExpanded;
ItemToIdMapT m_IdMap;
wxsItemEditor* m_Editor;
wxsItemResFunctions* m_Functions;
wxsItem* m_RootItem;
wxsItem* m_RootSelection;
ToolArrayT m_Tools;
long m_PropertiesFilter;
wxWindow* m_Preview;
wxsItemUndoBuffer m_Undo;
wxsCorrector m_Corrector;
bool m_IsOK;
bool m_IsEventTable;
int m_LockCount;
bool m_ReadOnly;
};
#endif
|