Source: kregexpeditor/kregexpeditorinterface.h

# Source: kregexpeditor/kregexpeditorinterface.h |
Annotated List
Files
Globals
Hierarchy
Index

    #ifndef __kregexpeditorinterface_h__
    #define __kregexpeditorinterface_h__

    /**
     *  A graphical editor for regular expressions.
     *
     * @author Jesper K. Pedersen blackie@kde.org
     *
     * The actual editor is located in kdeutils, with an interface in
     * kdelibs. This means that it is a bit more comlicated to create an
     * instance of the editor, but only a little bit more complicated.
     *
     * To check if kregexpeditor in kdeutils is installed and available use this line:
     *
     *
     * bool installed=!KTrader::self()->query("KRegExpEditor/KRegExpEditor").isEmpty();
     *
     *
     * The following is a template for what you need to do to create an instance of the
     * regular expression dialog:
     *
     *
     * QDialog *editorDialog = KParts::ComponentFactory::createInstanceFromQuery( "KRegExpEditor/KRegExpEditor" );
     * if ( editorDialog ) {
     *   // kdeutils was installed, so the dialog was found fetch the editor interface
     *   KRegExpEditorInterface *editor = static_cast( editorDialog->qt_cast( "KRegExpEditorInterface" ) );
     *   Q_ASSERT( editor ); // This should not fail!
     *
     *   // now use the editor.
     *   editor->setRegExp("^kde$");
     *
     *   // Finally exec the dialog
     *   editorDialog->exec();
     * }
     * else {
     *   // Don't offer the dialog.
     * }
     *
     *
     * Note: signals and slots must be connected to the editorDialog object, not to the editor object:
     *
     * connect( editorDialog, SIGNAL( canUndo( bool ) ), undoBut, SLOT( setEnabled( bool ) ) );
     *
     *
     * If you want to create an instance of the editor widget, i.e. not the
     * dialog, then you must do it in the following way:
     *
     *
     * QWidget *editorWidget =
     * KParts::ComponentFactory::createInstanceFromQuery(
     *     "KRegExpEditor/KRegExpEditor", QString::null, parent );
     * if ( editorWidget ) {
     *   // kdeutils was installed, so the widget was found fetch the editor interface
     *   KRegExpEditorInterface *editor = static_cast( editorWidget->qt_cast( "KRegExpEditorInterface" ) );
     *   Q_ASSERT( editor ); // This should not fail!
     *
     *   // now use the editor.
     *   editor->setRegExp("^kde$");

     *   // Finally insert the widget into the layout of its parent
     *   layout->addWidget( editorWidget );
     * }
     * else {
     *   // Don't offer the editor widget.
     * }
     *
     *
     */
    class KRegExpEditorInterface
    {
    public:
      /**
       * returns the regular expression of the editor in Qt3 QRegExp
       * syntax. Note, there is also a 'regexp' Qt property available.
       */
      virtual QString regExp() const = 0;

    signals:
      /**
       * This signal tells whether undo is available.
       */
      virtual void canUndo( bool ) = 0;

      /**
       * This signal tells whether redo is available.
       */
      virtual void canRedo( bool ) = 0;

      /**
       * This signal is emited whenever the regular expression changes.
       * The argument is true when the regular expression is different from
       * the loaded regular expression and false when it is equal to the
       * loaded regular expression.
       */
      virtual void changes( bool ) = 0;

    public slots:
     /**
      * Set the regular expression for the editor. The syntax must be Qt3
      * QRegExp syntax.
      */
      virtual void setRegExp( const QString ®exp ) = 0;
      virtual void redo() = 0;
      virtual void undo() = 0;

      /**
       * Set text to use when showing matches. NOT IMPLEMENTED YET!
       *
       * This method is not yet implemented. In later version of the widget
       * this method will be used to give the widget a text to show matches of
       * the regular expression on.
       */
      virtual void setMatchText( const QString& ) = 0;

      /**
       * This method allows for future changes that will not break binary
       * compatibility. DONT USE!
       *
       * KDE has a policy of keeping binary compatibility for all major
       * version of KDE. This means that new methods can not be added to this
       * API before KDE version 4.0.
       *
       * This method is an escape door for that.
       *
       * Conclusion: You should not use this method in this version of KDE!
       */
      virtual void doSomething( QString method, void* arguments ) = 0;
    };

    #endif

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:38:11 2003, using kdoc 2.0a54.