← Back to branch summary

~ubuntu-branches/ubuntu/raring/codeblocks/raring-proposed

« back to all changes in this revision

Viewing changes to src/plugins/contrib/wxSmithAui/wxSmithAui.h

  • Committer: Bazaar Package Importer
  • Author(s): Cosme Domínguez Díaz
  • Date: 2010-08-09 04:38:38 UTC
  • mfrom: (1.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20100809043838-a59ygguym4eg0jgw
Tags: 10.05-0ubuntu1
https://launchpad.net/bugs/322350
* New upstream release. Closes (LP: #322350)
 - Switch to dpkg-source 3.0 (quilt) format
 - Remove unneeded README.source
 - Add debian/get-source-orig script that removes all
   Windows prebuilt binaries
* Bump Standards-Version to 3.9.1
 - Stop shipping *.la files
* debian/control
 - Add cdbs package as Build-Depend
 - Add libbz2-dev and zlib1g-dev packages as
   Build-Depends (needed by libhelp_plugin.so)
 - Remove dpatch package of Build-Depends
 - Add codeblocks-contrib-debug package
 - Split architecture-independent files of codeblocks
   package in codeblocks-common package
* debian/rules
 - Switch to CDBS rules system
 - Add parallel build support
 - Add a call to debian/get-source-orig script
 - Use lzma compression (saves 23,5 MB of free space)
* debian/patches
 - Refresh 01_codeblocks_plugin_path
 - Add 02_no_Makefiles_in_debian_dir to remove any link
   in codeblocks build system to deleted Makefiles of debian directory
 - Drop 02_ftbfs_gcc44 and 03_ftbfs_glib221 (merged in upstream)
* debian/watch
 - Update to use the new host (berlios.de)

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/plugins/contrib/wxSmithAui/wxSmithAui.h
 
1
/***************************************************************
 
2
 * Name:      wxSmith - Aui
 
3
 * Purpose:   Code::Blocks plugin
 
4
 * Author:     ()
 
5
 * Created:   2008-12-15
 
6
 * Copyright: 
 
7
 * License:   GPL
 
8
 **************************************************************/
 
9
 
 
10
#ifndef WXSMITHAUI_H_INCLUDED
 
11
#define WXSMITHAUI_H_INCLUDED
 
12
 
 
13
// For compilers that support precompilation, includes <wx/wx.h>
 
14
#include <wx/wxprec.h>
 
15
 
 
16
#ifndef WX_PRECOMP
 
17
    #include <wx/wx.h>
 
18
#endif
 
19
 
 
20
#include <cbplugin.h> // for "class cbPlugin"
 
21
 
 
22
class wxSmithAui : public cbPlugin
 
23
{
 
24
    public:
 
25
        /** Constructor. */
 
26
        wxSmithAui();
 
27
        /** Destructor. */
 
28
        virtual ~wxSmithAui();
 
29
 
 
30
 
 
31
        /** This method is called by Code::Blocks and is used by the plugin
 
32
          * to add any menu items it needs on Code::Blocks's menu bar.\n
 
33
          * It is a pure virtual method that needs to be implemented by all
 
34
          * plugins. If the plugin does not need to add items on the menu,
 
35
          * just do nothing ;)
 
36
          * @param menuBar the wxMenuBar to create items in
 
37
          */
 
38
        virtual void BuildMenu(wxMenuBar* menuBar){}
 
39
 
 
40
        /** This method is called by Code::Blocks core modules (EditorManager,
 
41
          * ProjectManager etc) and is used by the plugin to add any menu
 
42
          * items it needs in the module's popup menu. For example, when
 
43
          * the user right-clicks on a project file in the project tree,
 
44
          * ProjectManager prepares a popup menu to display with context
 
45
          * sensitive options for that file. Before it displays this popup
 
46
          * menu, it asks all attached plugins (by asking PluginManager to call
 
47
          * this method), if they need to add any entries
 
48
          * in that menu. This method is called.\n
 
49
          * If the plugin does not need to add items in the menu,
 
50
          * just do nothing ;)
 
51
          * @param type the module that's preparing a popup menu
 
52
          * @param menu pointer to the popup menu
 
53
          * @param data pointer to FileTreeData object (to access/modify the file tree)
 
54
          */
 
55
        virtual void BuildModuleMenu(const ModuleType type, wxMenu* menu, const FileTreeData* data = 0){}
 
56
 
 
57
        /** This method is called by Code::Blocks and is used by the plugin
 
58
          * to add any toolbar items it needs on Code::Blocks's toolbar.\n
 
59
          * It is a pure virtual method that needs to be implemented by all
 
60
          * plugins. If the plugin does not need to add items on the toolbar,
 
61
          * just do nothing ;)
 
62
          * @param toolBar the wxToolBar to create items on
 
63
          * @return The plugin should return true if it needed the toolbar, false if not
 
64
          */
 
65
        virtual bool BuildToolBar(wxToolBar* toolBar){ return false; }
 
66
    protected:
 
67
        /** Any descendent plugin should override this virtual method and
 
68
          * perform any necessary initialization. This method is called by
 
69
          * Code::Blocks (PluginManager actually) when the plugin has been
 
70
          * loaded and should attach in Code::Blocks. When Code::Blocks
 
71
          * starts up, it finds and <em>loads</em> all plugins but <em>does
 
72
          * not</em> activate (attaches) them. It then activates all plugins
 
73
          * that the user has selected to be activated on start-up.\n
 
74
          * This means that a plugin might be loaded but <b>not</b> activated...\n
 
75
          * Think of this method as the actual constructor...
 
76
          */
 
77
        virtual void OnAttach();
 
78
 
 
79
        /** Any descendent plugin should override this virtual method and
 
80
          * perform any necessary de-initialization. This method is called by
 
81
          * Code::Blocks (PluginManager actually) when the plugin has been
 
82
          * loaded, attached and should de-attach from Code::Blocks.\n
 
83
          * Think of this method as the actual destructor...
 
84
          * @param appShutDown If true, the application is shutting down. In this
 
85
          *         case *don't* use Manager::Get()->Get...() functions or the
 
86
          *         behaviour is undefined...
 
87
          */
 
88
        virtual void OnRelease(bool appShutDown);
 
89
 
 
90
};
 
91
 
 
92
#endif // WXSMITHAUI_H_INCLUDED