Changeset 2217

Show
Ignore:
Timestamp:
08/06/08 18:15:31 (4 months ago)
Author:
hlamer
Message:

Documented Message Box plugin

Location:
v2/branches/dev
Files:
10 modified

Legend:

Unmodified
Added
Removed

  • v2/branches/dev/monkey/src/consolemanager/pCommandParser.cpp

    r2204 r2217  
    125125        \param rex Already matched regular expression (searching of a pattern  
    126126                should be called before this function) 
     127        \param s String, which contains %d (where d is number) patterns. 
     128                Patterns will be replaced with according submatch of string 
    127129        \return Resulting string 
    128130*/ 

  • v2/branches/dev/monkey/src/consolemanager/pConsoleManager.cpp

    r2215 r2217  
    22** 
    33**              Created using Monkey Studio v1.8.1.0 
    4 ** Authors    : Filipe AZEVEDO aka Nox P@sNox <pasnox@gmail.com> 
     4** Authors   : Filipe AZEVEDO aka Nox P@sNox <pasnox@gmail.com> 
    55** Project   : Monkey Studio IDE 
    66** FileName  : pConsoleManager.cpp 
    … …  
    3030        \file pConsoleManager.cpp 
    3131        \date 2008-01-14T00:36:50 
    32         \author Filipe AZEVEDO aka Nox P@sNox <pasnox@gmail.com> 
     32        \author Filipe AZEVEDO aka Nox PasNox <pasnox@gmail.com> 
    3333        \brief Implementation of pConsoleManager class 
    3434*/ 
    … …  
    129129/*! 
    130130        Remove parser to list of available parsers (which could be used for some commands) 
    131         \param p Name of parser 
     131        \param s Name of parser 
    132132*/ 
    133133void pConsoleManager::removeParser( const QString& s ) 

  • v2/branches/dev/monkey/src/consolemanager/pConsoleManager.h

    r2215 r2217  
    3030        \file pConsoleManager.h 
    3131        \date 2008-01-14T00:36:50 
    32         \author Filipe AZEVEDO aka Nox P@sNox <pasnox@gmail.com> 
     32        \author Filipe AZEVEDO aka Nox PasNox <pasnox@gmail.com> 
    3333        \brief Header of pConsoleManager class 
    3434*/ 

  • v2/branches/dev/plugins/base/MessageBox/src/MessageBox.cpp

    r2117 r2217  
    2727** 
    2828****************************************************************************/ 
     29/*! 
     30        \file MessageBox.cpp 
     31        \date 2008-01-14T00:40:08 
     32        \author Andrei Kopats 
     33        \brief implementation of main class of MessageBox plugin 
     34*/ 
    2935#include "MessageBox.h" 
    3036#include "ui/MessageBoxDocks.h" 
    … …  
    3844#include <QTabWidget> 
    3945 
     46/*! 
     47        Constructor of class 
     48*/ 
    4049MessageBox::MessageBox() 
    4150{ 
    … …  
    5160} 
    5261 
     62/*! 
     63        Destructor of class. Uninstalls plugin from IDE 
     64*/ 
    5365MessageBox::~MessageBox() 
    5466{ 
    … …  
    5769} 
    5870 
     71/*! 
     72        Enable/disable plugin 
     73         
     74        If plugin is enabled - it visible on main window and it's actions are in  
     75        the main menu 
     76        \param b Flag. Enable = true, Disable = false 
     77        \return Status of process  
     78        \retval true Successfully enabled 
     79        \retval false Some error ocurred 
     80*/ 
    5981bool MessageBox::setEnabled( bool b ) 
    6082{ 
    … …  
    98120} 
    99121 
     122/*! 
     123        Get settings widget for configuring plugin 
     124        \return Pointer to widget 
     125*/ 
    100126QWidget* MessageBox::settingsWidget() 
    101127{ return new UIMessageBoxSettings( this ); } 

  • v2/branches/dev/plugins/base/MessageBox/src/MessageBox.h

    r2117 r2217  
    22** 
    33**              Created using Monkey Studio v1.8.1.0 
    4 ** Authors    : Filipe AZEVEDO aka Nox P@sNox <pasnox@gmail.com> 
     4** Authors   : Filipe AZEVEDO aka Nox P@sNox <pasnox@gmail.com>, Andrei KOPATS aka hlamer, <hlamer at tut by> 
    55** Project   : Monkey Studio Base Plugins 
    66** FileName  : MessageBox.h 
    … …  
    2727** 
    2828****************************************************************************/ 
     29/*! 
     30        \file MessageBox.h 
     31        \date 2008-01-14T00:40:08 
     32        \author Filipe AZEVEDO, Andrei KOPATS 
     33        \brief Header file for MessageBox plugin 
     34*/ 
    2935#ifndef MESSAGEBOX_H 
    3036#define MESSAGEBOX_H 
    … …  
    3440class MessageBoxDocks; 
    3541 
     42/*! 
     43        Main class of MessageBox plugin 
     44 
     45        Plugin displaying console output and build steps of current building project 
     46*/ 
    3647class MessageBox : public BasePlugin 
    3748{ 

  • v2/branches/dev/plugins/base/MessageBox/src/ui/MessageBoxDocks.cpp

    r2142 r2217  
     1/**************************************************************************** 
     2** 
     3**              Created using Monkey Studio v1.8.1.0 
     4** Authors   : Filipe AZEVEDO aka Nox P@sNox <pasnox@gmail.com>,  
     5**             Andrei KOPATS aka hlamer <hlamer at tut by> 
     6**                 
     7** Project   : Monkey Studio Base Plugins 
     8** FileName  : MessageBoxDocs.cpp 
     9** Date      : 2008-01-14T00:40:08 
     10** License   : GPL 
     11** Comment   : This header has been automatically generated, if you are the original author, or co-author, fill free to replace/append with your informations. 
     12** Home Page : http://www.monkeystudio.org 
     13** 
     14        Copyright (C) 2005 - 2008  Filipe AZEVEDO & The Monkey Studio Team 
     15 
     16        This program is free software; you can redistribute it and/or modify 
     17        it under the terms of the GNU General Public License as published by 
     18        the Free Software Foundation; either version 2 of the License, or 
     19        (at your option) any later version. 
     20 
     21        This program is distributed in the hope that it will be useful, 
     22        but WITHOUT ANY WARRANTY; without even the implied warranty of 
     23        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
     24        GNU General Public License for more details. 
     25 
     26        You should have received a copy of the GNU General Public License 
     27        along with this program; if not, write to the Free Software 
     28        Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA 
     29** 
     30****************************************************************************/ 
     31/*! 
     32        \file MessageBoxDocks.cpp 
     33        \date 2008-01-14T00:40:08 
     34        \author Filipe AZEVEDO, Andrei KOPATS 
     35        \brief Implementation of MessageBoxDocks class 
     36         
     37*/ 
     38 
    139#include "MessageBoxDocks.h" 
    240 
    … …  
    846#include <xupmanager.h> 
    947 
     48/*! 
     49        Constructor of class 
     50         
     51        Installs plugin to IDE, creates GUI, connects self to signals from sources  
     52        on informations. 
     53         
     54        \param parent Parent object 
     55*/ 
    1056MessageBoxDocks::MessageBoxDocks( QObject* parent ) 
    1157        : QObject( parent ) 
    … …  
    3076} 
    3177 
     78/*! 
     79        Destuctor of class 
     80 
     81        Deletes docks of Message Box 
     82*/ 
    3283MessageBoxDocks::~MessageBoxDocks() 
    3384{ 
    … …  
    3889} 
    3990 
     91/*! 
     92        Make text colored by adding HTML tags before and after text 
     93         
     94        \param s Source string 
     95        \param c Desired color 
     96        \return String, containing color tags at start and end 
     97*/ 
    4098QString MessageBoxDocks::colourText( const QString& s, const QColor& c ) 
    4199{ return QString( "<font color=\"%1\">%2</font>" ).arg( c.name() ).arg( s ); } 
    42100 
     101/*! 
     102        Append text to Output dock 
     103        \param s Text to append 
     104*/ 
    43105void MessageBoxDocks::appendOutput( const QString& s ) 
    44106{ 
    … …  
    56118} 
    57119 
     120/*! 
     121        Append text to Commands dock 
     122        \param s Text to append 
     123*/ 
    58124void MessageBoxDocks::appendLog( const QString& s ) 
    59125{ 
    … …  
    71137} 
    72138 
     139/*! 
     140        Append text to Commands dock, which will be displayed in the box of stars 
     141 
     142        Example: 
     143        ******************************************************* 
     144        Here is your text 
     145        ******************************************************* 
     146        \param s String to append 
     147        \param c Color of string 
     148*/ 
    73149void MessageBoxDocks::appendInBox( const QString& s, const QColor& c ) 
    74150{ 
    … …  
    78154} 
    79155 
     156/*! 
     157        Append build step to Build Steps dock 
     158        \param s Build step to append 
     159*/ 
    80160void MessageBoxDocks::appendStep( const pConsoleManager::Step& s ) 
    81161{ 
    … …  
    183263} 
    184264 
     265/*! 
     266        Append search result to Search Results dock 
     267         
     268        Search result representing by same structure, as Build Step 
     269        \param s Search result to append 
     270*/ 
    185271void MessageBoxDocks::appendSearchResult( const pConsoleManager::Step& s ) 
    186272{ 
    … …  
    195281} 
    196282 
     283/*! 
     284        Show Build Steps dock 
     285*/ 
    197286void MessageBoxDocks::showBuild() 
    198287{ 
    … …  
    202291} 
    203292 
     293/*! 
     294        Show Output dock 
     295*/ 
    204296void MessageBoxDocks::showOutput() 
    205297{ 
    … …  
    209301} 
    210302 
     303/*! 
     304        Show Log dock 
     305*/ 
    211306void MessageBoxDocks::showLog() 
    212307{ 
    … …  
    216311} 
    217312 
     313/*! 
     314        Show Search Results dock 
     315*/ 
    218316void MessageBoxDocks::showSearchResults() 
    219317{ 
    … …  
    223321} 
    224322 
     323/*! 
     324        Show next error on Build Steps dock 
     325*/ 
    225326void MessageBoxDocks::showNextError() 
    226327{ 
    … …  
    239340} 
    240341 
     342/*! 
     343        Clear Search Results dock 
     344*/ 
    241345void MessageBoxDocks::clearSearchResults() 
    242346{ 
    … …  
    244348} 
    245349 
     350/*! 
     351        Handler of pressing on step in the Build Steps dock 
     352 
     353        Trying to open file/line according to step in the editor 
     354        If there are more than one file, which possible are target file, (same name,  
     355        but different path) - user will asked, which file should be opened 
     356*/ 
    246357void MessageBoxDocks::lwBuildSteps_itemPressed( QListWidgetItem* it ) 
    247358{ 
    … …  
    293404} 
    294405 
     406/*! 
     407        Handler of pressing on item in the Search Results dock 
     408 
     409        Opens file/line in the editor 
     410        \param it Item, which was pressed 
     411*/ 
    295412void MessageBoxDocks::lwSearchResults_itemPressed( QListWidgetItem* it ) 
    296413{ 
    … …  
    300417} 
    301418 
     419/*! 
     420        Handler of pressing return in the edit of Raw Command. Executes command  
     421        using console manager 
     422*/ 
    302423void MessageBoxDocks::cbRawCommand_returnPressed() 
    303424{ 
    … …  
    308429} 
    309430 
     431/*! 
     432        Handler of finishing command with error. Prints information about error  
     433        to Commands dock 
     434        \param c Command, which are finished 
     435        \param e Error type 
     436*/ 
    310437void MessageBoxDocks::commandError( const pCommand& c, QProcess::ProcessError e ) 
    311438{ 
    … …  
    342469} 
    343470 
     471/*! 
     472        Handler of finishing command 
     473 
     474        Prints information about exit status to Commands tab 
     475        \param c Finished command 
     476        \param exitCode Exit code of process 
     477        \param e Exit status of process 
     478*/ 
    344479void MessageBoxDocks::commandFinished( const pCommand& c, int exitCode, QProcess::ExitStatus e ) 
    345480{ 
    … …  
    369504} 
    370505 
     506/*! 
     507        Handler of Ready Read event from runned command.  
     508 
     509        Appends text, readed from process to Output dock 
     510        \param a Text in the QByteArray format 
     511*/ 
    371512void MessageBoxDocks::commandReadyRead( const pCommand&, const QByteArray& a ) 
    372513{ 
    … …  
    391532} 
    392533 
     534/*! 
     535        Handler of Command Started event 
     536 
     537        Prints information about start to Commands dock 
     538        \param c Command, which are started 
     539*/ 
    393540void MessageBoxDocks::commandStarted( const pCommand& c ) 
    394541{ 
    … …  
    406553} 
    407554 
     555/*! 
     556        Handler of State Changed event from executed process. 
     557         
     558        Prints information about change to Commands dock 
     559        \param c Command 
     560        \param s State of process 
     561*/ 
    408562void MessageBoxDocks::commandStateChanged( const pCommand& c, QProcess::ProcessState s ) 
    409563{ 
    … …  
    430584} 
    431585 
     586/*! 
     587        Handler of Command Skipped event.  
     588         
     589        Prints information to Commands dock 
     590        \param c Command, which was skipped 
     591*/ 
    432592void MessageBoxDocks::commandSkipped( const pCommand& c ) 
    433593{ 

  • v2/branches/dev/plugins/base/MessageBox/src/ui/MessageBoxDocks.h

    r2142 r2217  
     1/**************************************************************************** 
     2** 
     3**              Created using Monkey Studio v1.8.1.0 
     4** Authors   : Filipe AZEVEDO aka Nox P@sNox <pasnox@gmail.com>,  
     5**             Andrei KOPATS aka hlamer <hlamer at tut by> 
     6**                 
     7** Project   : Monkey Studio Base Plugins 
     8** FileName  : MessageBoxDocs.h 
     9** Date      : 2008-01-14T00:40:08 
     10** License   : GPL 
     11** Comment   : This header has been automatically generated, if you are the original author, or co-author, fill free to replace/append with your informations. 
     12** Home Page : http://www.monkeystudio.org 
     13** 
     14        Copyright (C) 2005 - 2008  Filipe AZEVEDO & The Monkey Studio Team 
     15 
     16        This program is free software; you can redistribute it and/or modify 
     17        it under the terms of the GNU General Public License as published by 
     18        the Free Software Foundation; either version 2 of the License, or 
     19        (at your option) any later version. 
     20 
     21        This program is distributed in the hope that it will be useful, 
     22        but WITHOUT ANY WARRANTY; without even the implied warranty of 
     23        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
     24        GNU General Public License for more details. 
     25 
     26        You should have received a copy of the GNU General Public License 
     27        along with this program; if not, write to the Free Software 
     28        Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA 
     29** 
     30****************************************************************************/ 
     31/*! 
     32        \file MessageBoxDocks.h 
     33        \date 2008-01-14T00:40:08 
     34        \author Filipe AZEVEDO, Andrei KOPATS 
     35        \brief Header of MessageBoxDocks class 
     36         
     37        File also contains classes of tabs of Message Box 
     38        MessageBox 
     39*/ 
     40 
    141#ifndef MESSAGEBOXDOCKS_H 
    242#define MESSAGEBOXDOCKS_H 
    … …  
    1050#include <consolemanager.h> 
    1151 
     52/*! 
     53        Implementation of Build Steps tab of Message box 
     54*/ 
    1255class UIBuildStep : public pDockWidget, public Ui::UIBuildStep 
    1356{ 
    … …  
    1861}; 
    1962 
     63/*! 
     64        Implementation of Output tab of Message box 
     65*/ 
    2066class UIOutput : public pDockWidget, public Ui::UIOutput 
    2167{ 
    … …  
    2672}; 
    2773 
     74/*! 
     75        Implementation of Commands tab of Message box 
     76*/ 
    2877class UICommand : public pDockWidget, public Ui::UICommand 
    2978{ 
    … …  
    3483}; 
    3584 
     85/*! 
     86        Implementation of Search Results tab of Message box 
     87*/ 
    3688class UISearchResult : public pDockWidget, public Ui::UISearchResult 
    3789{ 
    … …  
    4294}; 
    4395 
     96/*! 
     97        Implementation of GUI of MessageBox plugin 
     98         
     99        Manages tabs, implements functionality of plugin. Appends and removes  
     100        information from docks, according with signals from sources of information) 
     101        Allows to show some tab of message box 
     102*/ 
    44103class MessageBoxDocks : public QObject 
    45104{ 

  • v2/branches/dev/plugins/base/MessageBox/src/ui/UIMessageBoxSettings.cpp

    r2142 r2217  
     1/**************************************************************************** 
     2** 
     3**              Created using Monkey Studio v1.8.1.0 
     4** Authors   : Filipe AZEVEDO aka Nox P@sNox <pasnox@gmail.com>,  
     5**                 
     6** Project   : Monkey Studio Base Plugins 
     7** FileName  : UIMessageBoxSettings.h 
     8** Date      : 2008-01-14T00:40:08 
     9** License   : GPL 
     10** Comment   : This header has been automatically generated, if you are the original author, or co-author, fill free to replace/append with your informations. 
     11** Home Page : http://www.monkeystudio.org 
     12** 
     13        Copyright (C) 2005 - 2008  Filipe AZEVEDO & The Monkey Studio Team 
     14 
     15        This program is free software; you can redistribute it and/or modify 
     16        it under the terms of the GNU General Public License as published by 
     17        the Free Software Foundation; either version 2 of the License, or 
     18        (at your option) any later version. 
     19 
     20        This program is distributed in the hope that it will be useful, 
     21        but WITHOUT ANY WARRANTY; without even the implied warranty of 
     22        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
     23        GNU General Public License for more details. 
     24 
     25        You should have received a copy of the GNU General Public License 
     26        along with this program; if not, write to the Free Software 
     27        Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA 
     28** 
     29****************************************************************************/ 
     30/*! 
     31        \file UIMessageBoxSettings.h 
     32        \date 2008-01-14T00:40:08 
     33        \author Filipe AZEVEDO 
     34        \brief Header of UIMessageBoxSettings class 
     35*/ 
     36 
    137#include "UIMessageBoxSettings.h" 
    238#include "../MessageBox.h" 
    … …  
    541#include <QPushButton> 
    642 
     43/*! 
     44        Create settings widget 
     45        \param plugin Pointer to MessageBox plugin 
     46        \param parent Parent widget 
     47*/ 
    748UIMessageBoxSettings::UIMessageBoxSettings( MessageBox* plugin, QWidget* parent ) 
    849        : QWidget( parent ) 
    … …  
    2364} 
    2465 
     66/*! 
     67        Handler of pressing of any button on settings widget 
     68         
     69        Help, Restore Defaults or Apply button can be pressed 
     70        Function will do action, according to button 
     71        \param button Pressed button (Help, RestoreDefaults, Apply) 
     72*/ 
    2573void UIMessageBoxSettings::on_dbbButtons_clicked( QAbstractButton* button ) 
    2674{ 
    … …  
    4189        } 
    4290} 
    43  

  • v2/branches/dev/plugins/base/MessageBox/src/ui/UIMessageBoxSettings.h

    r2142 r2217  
     1/**************************************************************************** 
     2** 
     3**              Created using Monkey Studio v1.8.1.0 
     4** Authors   : Filipe AZEVEDO aka Nox P@sNox <pasnox@gmail.com>,  
     5**                 
     6** Project   : Monkey Studio Base Plugins 
     7** FileName  : UIMessageBoxSettings.h 
     8** Date      : 2008-01-14T00:40:08 
     9** License   : GPL 
     10** Comment   : This header has been automatically generated, if you are the original author, or co-author, fill free to replace/append with your informations. 
     11** Home Page : http://www.monkeystudio.org 
     12** 
     13        Copyright (C) 2005 - 2008  Filipe AZEVEDO & The Monkey Studio Team 
     14 
     15        This program is free software; you can redistribute it and/or modify 
     16        it under the terms of the GNU General Public License as published by 
     17        the Free Software Foundation; either version 2 of the License, or 
     18        (at your option) any later version. 
     19 
     20        This program is distributed in the hope that it will be useful, 
     21        but WITHOUT ANY WARRANTY; without even the implied warranty of 
     22        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
     23        GNU General Public License for more details. 
     24 
     25        You should have received a copy of the GNU General Public License 
     26        along with this program; if not, write to the Free Software 
     27        Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA 
     28** 
     29****************************************************************************/ 
     30/*! 
     31        \file UIMessageBoxSettings.h 
     32        \date 2008-01-14T00:40:08 
     33        \author Filipe AZEVEDO 
     34        \brief Header of UIMessageBoxSettings class 
     35*/ 
    136#ifndef UIMESSAGEBOXSETTINGS_H 
    237#define UIMESSAGEBOXSETTINGS_H 
    … …  
    843class MessageBox; 
    944 
     45/*! 
     46        Settings widget for Message Box class 
     47*/ 
    1048class UIMessageBoxSettings : public QWidget, public Ui::UIMessageBoxSettings 
    1149{ 

  • v2/branches/dev/plugins/base/Navigator/src/Navigator.cpp

    r2201 r2217  
    3131        \date 2008-01-14T00:40:08 
    3232        \author Andrei Kopats 
    33         \brief Header file for Navigator plugin 
     33        \brief Implementation of main class of MessageBox plugin 
    3434*/ 
    3535