knotes
KNotesAppIface Class ReferenceInheritance diagram for KNotesAppIface:
List of all members.
Detailed Description
Definition at line 41 of file KNotesAppIface.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 | fgColor (const QString ¬eId) const =0 |
virtual QString | bgColor (const QString ¬eId) const =0 |
virtual ASYNC | setColor (const QString ¬eId, const QString &fgColor, const QString &bgColor)=0 |
virtual QString | name (const QString ¬eId) const =0 |
virtual QString | text (const QString ¬eId) const =0 |
virtual ASYNC | showNote (const QString ¬eId) const =0 |
virtual ASYNC | hideNote (const QString ¬eId) const =0 |
virtual ASYNC | showAllNotes () const =0 |
virtual ASYNC | hideAllNotes () const =0 |
virtual int | width (const QString ¬eId) const =0 |
virtual int | height (const QString ¬eId) const =0 |
virtual ASYNC | move (const QString ¬eId, int x, int y) const =0 |
virtual ASYNC | resize (const QString ¬eId, int width, int height) const =0 |
virtual ASYNC | sync (const QString &app)=0 |
virtual bool | isNew (const QString &app, const QString ¬eId) const =0 |
virtual bool | isModified (const QString &app, const QString ¬eId) const =0 |
Member Function Documentation
virtual QString KNotesAppIface::bgColor |
( |
const QString & |
noteId |
) |
const [pure virtual] |
|
|
Returns the background color of a note.
- Parameters:
-
| noteId | the id of the note in question |
- Returns:
- the background color as a QString
Implemented in KNotesApp. |
virtual QString KNotesAppIface::fgColor |
( |
const QString & |
noteId |
) |
const [pure virtual] |
|
|
Returns the foreground/text color of a note.
- Parameters:
-
| noteId | the id of the note in question |
- Returns:
- the foreground/text color as a QString
Implemented in KNotesApp. |
virtual int KNotesAppIface::height |
( |
const QString & |
noteId |
) |
const [pure virtual] |
|
|
Returns the height of a note.
- Parameters:
-
| noteId | the id of the note in question |
- Returns:
- the height as a uint
Implemented in KNotesApp. |
virtual ASYNC KNotesAppIface::hideAllNotes |
( |
|
) |
const [pure virtual] |
|
virtual ASYNC KNotesAppIface::hideNote |
( |
const QString & |
noteId |
) |
const [pure virtual] |
|
|
Hide a note.
- Parameters:
-
| noteId | the id of the note to hide |
Implemented in KNotesApp. |
virtual bool KNotesAppIface::isModified |
( |
const QString & |
app, |
|
|
const QString & |
noteId |
|
) |
const [pure virtual] |
|
|
Test if a note was modified since the last sync.
- Parameters:
-
| app | the app that wants to get the status since the last sync |
| noteId | the id of the note |
- Returns:
- true if modified (note that this will return true if the note is new as well!) and false if the note is not modified or doesn't exist
Implemented in KNotesApp. |
virtual bool KNotesAppIface::isNew |
( |
const QString & |
app, |
|
|
const QString & |
noteId |
|
) |
const [pure virtual] |
|
|
Test if a note was created new after the last sync.
- Parameters:
-
| app | the app that wants to get the status since the last sync |
| noteId | the id of the note |
- Returns:
- true if the note is new, false if not or if the note does not exist
Implemented in KNotesApp. |
virtual ASYNC KNotesAppIface::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 |
Implemented in KNotesApp. |
virtual ASYNC KNotesAppIface::killNote |
( |
const QString & |
noteId |
) |
[pure virtual] |
|
|
Deletes a note forever.
- Parameters:
-
| noteId | the id of the note to kill |
Implemented in KNotesApp. |
virtual ASYNC KNotesAppIface::move |
( |
const QString & |
noteId, |
|
|
int |
x, |
|
|
int |
y |
|
) |
const [pure virtual] |
|
|
Repositions a note.
- Parameters:
-
| noteId | the id of the note to be moved |
| x | the new x-coordinate of the note |
| y | the new y-coordinate of the note |
Implemented in KNotesApp. |
virtual QString KNotesAppIface::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
Implemented in KNotesApp. |
virtual QString KNotesAppIface::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
Implemented in KNotesApp. |
virtual QString KNotesAppIface::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
Implemented in KNotesApp. |
virtual QMap<QString,QString> KNotesAppIface::notes |
( |
|
) |
const [pure virtual] |
|
|
Get all the notes including their ids.
- Returns:
- a QMap that maps the id of a note to its name
Implemented in KNotesApp. |
virtual ASYNC KNotesAppIface::resize |
( |
const QString & |
noteId, |
|
|
int |
width, |
|
|
int |
height |
|
) |
const [pure virtual] |
|
|
Changes the size of a note.
- Parameters:
-
| noteId | the id of the note to be resized |
| width | the new width of the note |
| height | the new height of the note |
Implemented in KNotesApp. |
virtual ASYNC KNotesAppIface::setColor |
( |
const QString & |
noteId, |
|
|
const QString & |
fgColor, |
|
|
const QString & |
bgColor |
|
) |
[pure virtual] |
|
|
Sets the color (foreground and background color) of a note.
- Parameters:
-
| noteId | the id of the note |
| fgColor | the new text color for the note |
| bgColor | the new background color for the note |
Implemented in KNotesApp. |
virtual ASYNC KNotesAppIface::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 |
Implemented in KNotesApp. |
virtual ASYNC KNotesAppIface::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 |
Implemented in KNotesApp. |
virtual ASYNC KNotesAppIface::showAllNotes |
( |
|
) |
const [pure virtual] |
|
|
Show all notes on their respective desktops.
Implemented in KNotesApp. |
virtual ASYNC KNotesAppIface::showNote |
( |
const QString & |
noteId |
) |
const [pure virtual] |
|
|
Show a note as if it had been selected from the "notes" menu.
- Parameters:
-
| noteId | the id of the note to show |
Implemented in KNotesApp. |
virtual ASYNC KNotesAppIface::sync |
( |
const QString & |
app |
) |
[pure virtual] |
|
|
This tells KNotes that a specific app has synchronized with all the notes.
- Parameters:
-
| app | the app that has synced with KNotes |
Implemented in KNotesApp. |
virtual QString KNotesAppIface::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
Implemented in KNotesApp. |
virtual int KNotesAppIface::width |
( |
const QString & |
noteId |
) |
const [pure virtual] |
|
|
Returns the width of a note.
- Parameters:
-
| noteId | the id of the note in question |
- Returns:
- the width as a uint
Implemented in KNotesApp. |
The documentation for this class was generated from the following file:
|