knotes
KNotesIface Class Reference
List of all members.Detailed Description
Definition at line 31 of file KNotesIface.h.
DCOP Member Functions | |
virtual QString | newNote (const QString &name=QString::null, const QString &text=QString::null)=0 |
virtual QString | newNoteFromClipboard (const QString &name=QString::null)=0 |
virtual ASYNC | killNote (const QString ¬eId)=0 |
virtual ASYNC | killNote (const QString ¬eId, bool force)=0 |
virtual QMap< QString, QString > | notes () const=0 |
virtual ASYNC | setName (const QString ¬eId, const QString &newName)=0 |
virtual ASYNC | setText (const QString ¬eId, const QString &newText)=0 |
virtual QString | name (const QString ¬eId) const=0 |
virtual QString | text (const QString ¬eId) const=0 |
Member Function Documentation
virtual QString KNotesIface::newNote | ( | const QString & | name = QString::null , |
|
const QString & | text = QString::null | |||
) | [pure virtual] |
Create a new note.
- Parameters:
-
name the name (title) of the new note, if it is empty, KNotes will choose an appropriate name text the body of the new note
- Returns:
- the new notes' id
virtual QString KNotesIface::newNoteFromClipboard | ( | const QString & | name = QString::null |
) | [pure virtual] |
Create a new note and inserts the current text in the clipboard as text.
- Parameters:
-
name the name (title) of the new note, if it is empty, KNotes will choose an appropriate name
- Returns:
- the new notes' id
virtual ASYNC KNotesIface::killNote | ( | const QString & | noteId | ) | [pure virtual] |
Deletes a note forever.
- Parameters:
-
noteId the id of the note to kill
virtual ASYNC KNotesIface::killNote | ( | const QString & | noteId, | |
bool | force | |||
) | [pure virtual] |
Deletes a note forever.
- Parameters:
-
noteId the id of the note to kill force do not request confirmation
virtual QMap<QString,QString> KNotesIface::notes | ( | ) | const [pure virtual] |
Get all the notes including their ids.
- Returns:
- a QMap that maps the id of a note to its name
virtual ASYNC KNotesIface::setName | ( | const QString & | noteId, | |
const QString & | newName | |||
) | [pure virtual] |
Changes the title/name of a note.
- Parameters:
-
noteId the id of the note to be modified newName the new title
virtual ASYNC KNotesIface::setText | ( | const QString & | noteId, | |
const QString & | newText | |||
) | [pure virtual] |
Sets the text of a note.
This will delete the old text!
- Parameters:
-
noteId the id of the note newText the new text for the note
virtual QString KNotesIface::name | ( | const QString & | noteId | ) | const [pure virtual] |
Returns the title/name of a note.
- Parameters:
-
noteId the id of the note in question
- Returns:
- the name as a QString
virtual QString KNotesIface::text | ( | const QString & | noteId | ) | const [pure virtual] |
Returns the text of a note.
- Parameters:
-
noteId the id of the note in question
- Returns:
- the body as a QString
The documentation for this class was generated from the following file: