We have moved to https://dokuwiki.librecad.org/

Lots of content was already moved to the new wiki, but there is still work to do. If you want to contribute, please register a new account at https://dokuwiki.librecad.org/

This wiki will be kept for a while to keep search engine results valid. Moved sites may be deleted here in future.

Difference between revisions of "Document Interface class"

From LibreCAD wiki
Jump to: navigation, search
Line 48: Line 48:
 
----
 
----
  
virtual void Document_Interface::'''addText''' (QString ''txt'', QString ''sty'', QPointF * ''start'', double ''height'', double ''angle'', DPI::HAlign ''ha'', DPI::VAlign ''va'' <code>[pure virtual]</code>
+
virtual void Document_Interface::'''addText''' (QString ''txt'', QString ''sty'', QPointF * ''start'', double ''height'', double ''angle'', DPI::HAlign ''ha'', DPI::VAlign ''va'') <code>[pure virtual]</code>
 
<p>Add text entity to current document with current attributes</p>
 
<p>Add text entity to current document with current attributes</p>
 
'''Parameters:'''
 
'''Parameters:'''
Line 63: Line 63:
 
----
 
----
  
      <table>
+
virtual QString Document_Interface::getCurrentLayer() <code>[pure virtual]</code>
        <tr>
+
          <td>virtual QString Document_Interface::getCurrentLayer </td>
+
          <td>(</td>
+
          <td></td><td>)</td>
+
          <td><code> [pure virtual]</code></td>
+
        </tr>
+
      </table>
+
  
 
<p>Get the current layer in current document. </p>
 
<p>Get the current layer in current document. </p>
<p>Get the current layer in current document. </p>
+
'''Returns:'''The name of the current layer.
<dl class="return"><dt><b>Returns:</b></dt><dd>The name of the current layer. </dd></dl>
+
  
<p>Implemented in Doc_plugin_interface</p>
+
----
 
+
<hr/>
+
<a name="a7308de4c648f7d50f16b80409a96e219"></a>
+
  
      <table>
+
virtual <a  href="Plug_Entity-Class-Reference">Plug_Entity</a>* Document_Interface::getEnt </td>
        <tr>
+
          <td>virtual <a  href="Plug_Entity-Class-Reference">Plug_Entity</a>* Document_Interface::getEnt </td>
+
 
           <td>(</td>
 
           <td>(</td>
 
           <td>const QString &amp;</td>
 
           <td>const QString &amp;</td>

Revision as of 16:55, 25 July 2012

Document_Interface Class Reference

Interface for comunicate plugins.

Class for comunicate plugins with document (drawing).

#include <document_interface.h>

Public Member Functions

virtual ~Document_Interface()
virtual void addPoint (QPointF *start)=0Add point entity to current document.
virtual void addLine (QPointF *start, QPointF *end)=0Add line entity to current document.
virtual void addText(QString txt, QString sty, QPointF *start, double height, double angle, DPI::HAlign ha, DPI::VAlign va)=0 Add text entity to current document.
virtual void setLayer(QString name)=0Set the current layer in current document.
virtual QString getCurrentLayer()=0Get the current layer in current document.
virtual bool getPoint(QPointF *point, const QString &mesage="", QPointF *base=0)=0Gets a point.
virtual Plug_Entity* getEnt (const QString &mesage="")=0Select a entity.
virtual QList< Plug_Entity* > getSelect (const QString &mesage="")=0Gets a entities selection.

virtual Document_Interface::~Document_Interface () [inline, virtual]

Member Function Documentation


virtual void Document_Interface::addLine(QPointF* start, QPointF* end) <code>[pure virtual]

Add line entity to current document with current attributes.

Parameters:

startstart point coordinate.
endend point coordinate.

virtual void Document_Interface::addPoint(QPointF* start) [pure virtual]

Add point entity to current document with current attributes.

Parameters:

startstart point coordinate.

virtual void Document_Interface::addText (QString txt, QString sty, QPointF * start, double height, double angle, DPI::HAlign ha, DPI::VAlign va) [pure virtual]

Add text entity to current document with current attributes

Parameters:

txta QString with text content
stya QString with text style name
startinsertion point coordinate
heightheight of text
anglerotation angle of text
hahorizontal alignement of text
vavertical alignement of text

virtual QString Document_Interface::getCurrentLayer() [pure virtual]

Get the current layer in current document.

Returns:The name of the current layer.


virtual <a href="Plug_Entity-Class-Reference">Plug_Entity</a>* Document_Interface::getEnt </td>

         <td>(</td>
         <td>const QString &</td>
         <td>mesage = ""</td><td>)</td>
         <td> [pure virtual]</td>
       </tr>
     </table>

Select a entity.

Prompt message or a default message to the user asking for a sigle selection. You can delete the <a href="Plug_Entity-Class-Reference" title="Wrapper for acces entities from plugins.">Plug_Entity</a> wen no more needed.

Parameters:

mesagean optional QString with prompt message.

Returns:a <a href="Plug_Entity-Class-Reference" title="Wrapper for acces entities from plugins.">Plug_Entity</a> handle the selected entity or NULL.

Implemented in Doc_plugin_interface


<a name="accafc3c2812bbe033a6b8d073ad4e08e"></a>

Gets a point.

Prompt message or an default message to the user asking for a point. If base is present draw a line from base to cursor position.

Parameters:

virtual bool Document_Interface::getPoint ( QPointF * point,
const QString &  mesage = "",
QPointF *  base = 0 
) [pure virtual]
pointa pointer to QPointF to store the obtained point.
mesagean optional QString with prompt message.
basevisual helper point, if present.


false if fail, i.e. user cancel.

Implemented in Doc_plugin_interface


<a name="a98f11873900dcf95f64dad6325d70a9b"></a>

virtual QList<<a href="Plug_Entity-Class-Reference">Plug_Entity</a> *> Document_Interface::getSelect ( const QString &  mesage = "") [pure virtual]

Gets a entities selection.

Prompt message or an default message to the user asking for a selection. You can delete all, the <a href="Plug_Entity-Class-Reference" title="Wrapper for acces entities from plugins.">Plug_Entity</a> and the returned QList wen no more needed.

Parameters:

mesagean optional QString with prompt message.

Returns:a QList of poiters to <a href="Plug_Entity-Class-Reference" title="Wrapper for acces entities from plugins.">Plug_Entity</a> handled the selected entites or an empty QList.

Implemented in Doc_plugin_interface


<a name="a32cb7bf0798d060e3ed06dcfe470303c"></a>

virtual void Document_Interface::setLayer ( QString  name) [pure virtual]

Set the current layer in current document.

Set the current layer in current document, if not exist create it.

Parameters:

namea QString with the name of the layer.


Implemented in Doc_plugin_interface