Skip to content

C
core
Kaydet (Commit) 42824b9c authored tarafından Lennard Wasserthal's avatar Lennard Wasserthal Kaydeden (comit) Norbert Thiebaud
Dosyalara gözat
Seçenekler

Added further documentation for sfx2 

Added further documentation on the sfx2 framework.
Turned the packed odg file into a git-friendly html+svg file.

Change-Id: I0b86f00ffb9355d4cbc911a7b406b1b76dbf62ac
Signed-off-by: 's avatarLennard Wasserthal <Wasserthal@nefkom.net>
Reviewed-on: https://gerrit.libreoffice.org/3871Reviewed-by: 's avatarNorbert Thiebaud <nthiebaud@gmail.com>
Tested-by: 's avatarNorbert Thiebaud <nthiebaud@gmail.com>
üst 1887d2e9
Hide whitespace changes
Inline Side-by-side
Showing with 82 additions and 1 deletion
sfx2/README
Dosyayı görüntüle @ 42824b9c
SFX is the "old" framework, used for historical reasons.
An attempt of documentation of this module is located in [git:sfx2/doc].
It contains base classes for document model, view and controller, used
by "old" applications like sw, sc, sd (while "new" applications
are based on the "new" UNO based framework in "framework").
......@@ -12,7 +14,7 @@ subdirectory.
Document load/save code is maintained in [git:sfx2/source/doc/docfile.cxx]
SfxMedium class, which handles all the twisty load and save corner cases.
[git:sfx2/source/applappl/sfxhelp.cxx] Start procedure for the online
[git:sfx2/source/appl/sfxhelp.cxx] Start procedure for the online
help viewer top level window; handling of help URL creation and
dispatch.
......
sfx2/doc/sfx2doc.html 0 → 100644
Dosyayı görüntüle @ 42824b9c
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<BODY LANG="de-DE" DIR="LTR">
<P CLASS="western">Signal processing in the sfx2 Interface.
State of 5.5.2013<BR><BR>
related modules are: svidl (idl compiler), framework (command processing routines), rsc (resource compiler, see below), vcl (command processing routines)<BR>
Here is a chart how the "slot-model" of the command processing framework works.
<BR>
Menu commands and Key accelerators are stored
asynchronously into a UNO command stack and later executed
seqentially.<BR>
</P>
<P CLASS="western" STYLE="margin-bottom: 0.5cm"><IMG SRC="sfx2doc0001.svg" NAME="Grafik1" ALIGN=BOTTOM WIDTH=950 HEIGHT=350 BORDER=0></P>
<P CLASS="western" STYLE="margin-bottom: 0.5cm"><BR><BR>
Changing the system: <b>In Order to add a function to a shell,
Add an entry to the .sdi file corresponding to that SfxShell</b><BR>
<FONT style="color: red">Example:</FONT>
<BR>
<PRE><FONT style="background-color: black" color="white">SID_PASTE [ ExecMethod = ExecDrawFunc; StateMethod = GetDrawFuncState; Export = FALSE; ]</FONT></PRE><BR>
The "state" method is the method called to checked whether that command is active now. The "exec" method is called when the command should be processed by the shell. Both functions obtain a SfxRequest Object as a parameter, declared in ./include/sfx2/request.hxx.<BR>
Each Application Window has ONE Dispatcher.
This registers all SfxShells (or rather their
subclasses) which can get commands from the user AT THE MOMENT.
These shells are created when the edit mode they
are part of is first used, but not discarded until the window closes.
./sfx2/source/control/dispatch.cxx:
void SfxDispatcher::Pop receives Pushes and Pops
of the shell to/from the stack.
The real Pushing/Popping, however, is done during
SfxDispatcher::FlushImpl
Main dispatching routine In
./sfx2/source/control/unoctitm.cxx
SfxDispatchController_Impl::dispatch.
<BR>
SfxDispatchController::_FindServer
gets the SfxInterfaces of the shells. They are defined by macro calls
to SFX_IMPL_INTERFACE, defined in include/sfx2/shell.hxx .
Upon GetInterface, they yield their pInterface,
which, upon GetSlot, returns a SfxSlot of that Shell
For that command, which is then Executed with
Dispatcher::Execute.
If the program is set into another mode, for
example by clicking a hovering object in writer
after Text editing, all shells are removed from
the dispatcher and new shells are pushed
to match the current mode.
<BR>
<B> How to build menus</B><BR>
In order to introduce a menu command, the uno command must be linked to a slot name.<BR>
This is done in different sdi files, such as sfx2/sdi/sfx.sdi.
There, you <U>define</U> the slot:<BR>
<FONT style="color: red">Structure:</FONT>
<PRE>
<FONT style="background-color: black" color="white">
SfxVoidItem uno_name_the_part_after_colon SID_COMMAND_NAME
()
[
/* initialization of variables is coming here */
]
</PRE>
</FONT>
In ./include/sfx2/sfxsids.hrc, the defines of the slot names and their numbers are entered. The numbers are just needed because definitions cannot be enums, and for compatibility.<BR>
In ./officecfg/registry/data/org/openoffice/Office/UI,
there are .xcu ended xml files that define the single menu items.
They contain the US- language name and the .uno: command.<BR>
In ./include/sfx2/sfxcommands.h, the uno command names are listed.
<BR><BR>
The resource compiler, which creates files some GetState methods refer to, is in the ./rsc directory. It is a separate executable, invoked at compile time.<BR>
</P>
</BODY>
</HTML>
\ No newline at end of file
sfx2/doc/sfx2doc0001.svg 0 → 100644
Dosyayı görüntüle @ 42824b9c
This diff was suppressed by a .gitattributes entry.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment