New interface documentation for TC7 plugins

Discuss and announce Total Commander plugins, addons and other useful tools here, both their usage and their development.

Moderators: white, Hacker, petermad, Stefan2

User avatar
ghisler(Author)
Site Admin
Site Admin
Posts: 48083
Joined: 2003-02-04, 09:46 UTC
Location: Switzerland
Contact:

New interface documentation for TC7 plugins

Post by *ghisler(Author) »

As promised, I have now published the changed documentation for packer, file system and content plugins. The lister plugin interface has NOT been changed.

:arrow: Packer plugins
:arrow: File system plugins
:arrow: Content plugins
:arrow: Lister plugins (requires beta 4)

Please report any problems you find with the documentation here in this thread!
Last edited by ghisler(Author) on 2007-02-23, 09:48 UTC, edited 2 times in total.
Author of Total Commander
https://www.ghisler.com
User avatar
Lefteous
Power Member
Power Member
Posts: 9535
Joined: 2003-02-09, 01:18 UTC
Location: Germany
Contact:

Post by *Lefteous »

2ghisler(Author)
Thank you very much :-)
The lister plugin interface has NOT been changed.
Are you sure? I thought plug-ins need to react if the user wants to fit only large images or center images?
Last edited by Lefteous on 2006-11-09, 23:09 UTC, edited 1 time in total.
User avatar
D1P
Senior Member
Senior Member
Posts: 233
Joined: 2005-02-28, 18:29 UTC
Location: Moscow
Contact:

Post by *D1P »

Some typos and mistakes in new documentation found. One serious mistake in FSPLUGIN.HLP: in fsplugin.pas contains description of FsContentGetDetectString function prototype, but that function not present in wfx API. Also that prototype not described in fsplugin.h.

Sorry for my bad English, but i think, I have clearly described this mistake.
User avatar
ghisler(Author)
Site Admin
Site Admin
Posts: 48083
Joined: 2003-02-04, 09:46 UTC
Location: Switzerland
Contact:

Post by *ghisler(Author) »

2D1P
Thanks for the info! Can you send me a list of errors by e-mail, please? You can also list them here if you prefer.
Author of Total Commander
https://www.ghisler.com
User avatar
D1P
Senior Member
Senior Member
Posts: 233
Joined: 2005-02-28, 18:29 UTC
Location: Moscow
Contact:

Post by *D1P »

Some found mistakes in contentplugin.HLP:
ContentGetSupportedField decription, unnecessary blank before a point:
When a field supports several units like bytes, kbytes, Mbytes etc, they need to be specified here in the following form: bytes|kbytes|Mbytes .
ContentPluginUnloading description, bold "T" symbol:
There are no parameters.
ContentGetSupportedFieldFlags decription, twice repeated blank before contflags_subst*:
Returning one of the__contflags_subst* flags instructs Total Commander to replace (substitute) the returned variable...
I yet have not read other files so closely, but I post here, if I find other mistakes.
User avatar
byblo
Senior Member
Senior Member
Posts: 270
Joined: 2005-02-20, 21:13 UTC
Contact:

Post by *byblo »

void __stdcall ContentSendStateInformation(int state,char* path) is already called in tc7.0pb1 ? I'm not really programmer but it seem that it didn't working at all:/
User avatar
Lefteous
Power Member
Power Member
Posts: 9535
Joined: 2003-02-09, 01:18 UTC
Location: Germany
Contact:

Post by *Lefteous »

2byblo
Works fine here! Did you export the function correctly?
User avatar
byblo
Senior Member
Senior Member
Posts: 270
Joined: 2005-02-20, 21:13 UTC
Contact:

Post by *byblo »

Lefteous wrote:2byblo
Works fine here! Did you export the function correctly?
It wasn't done. Thanks, it working well now. (last week I discovered pointers ^^;)
User avatar
byblo
Senior Member
Senior Member
Posts: 270
Joined: 2005-02-20, 21:13 UTC
Contact:

Post by *byblo »

A typo fix : In contentplugin.hlp -> ContentSendStateInformation ->
contstr_showhint: A tooltip/hint window is shown for the current file.

path Current path. In case of contstr_showhint, this is the path to the file, otherwise to the current directory.
contst_showhint didn't have a r (contentplug.h -> #define contst_showhint 4)
User avatar
ghisler(Author)
Site Admin
Site Admin
Posts: 48083
Joined: 2003-02-04, 09:46 UTC
Location: Switzerland
Contact:

Post by *ghisler(Author) »

I will correct it, thanks!
Author of Total Commander
https://www.ghisler.com
Lufti
Junior Member
Junior Member
Posts: 3
Joined: 2006-02-13, 13:09 UTC
Contact:

Post by *Lufti »

Hello,
I'm just going through the Content plugin documentation. At first, possibility to change field values is a very nice addition!

Here's a quote from the ContentGetSupportedFieldFlags page:
ContentGetSupportedFieldFlags wrote:Description of parameters:

FieldIndex The index of the field for which the sort order should be returned.
Happened when copying & pasting from ContentGetDefaultSortOrder page, hmm?! :wink:

Anyway, thank you for publishing the docs that early. :)
User avatar
ghisler(Author)
Site Admin
Site Admin
Posts: 48083
Joined: 2003-02-04, 09:46 UTC
Location: Switzerland
Contact:

Post by *ghisler(Author) »

Yep, thanks for finding that error!
Author of Total Commander
https://www.ghisler.com
User avatar
tbeu
Power Member
Power Member
Posts: 1336
Joined: 2003-07-04, 07:52 UTC
Location: Germany
Contact:

Post by *tbeu »

It should read ListLoadNext instead of ListLoad in lister plugin help.
Declaration:

int __stdcall ListLoadNext(HWND ParentWin,HWND ListWin,char* FileToLoad,int ShowFlags);
TC plugins: Autodesk 3ds Max / Inventor / Revit Preview, FileInDir, ImageMetaData (JPG Comment/EXIF/IPTC/XMP), MATLAB MAT-file Viewer, Mover, SetFolderDate, Solid Edge Preview, Zip2Zero and more
User avatar
Lefteous
Power Member
Power Member
Posts: 9535
Joined: 2003-02-09, 01:18 UTC
Location: Germany
Contact:

Post by *Lefteous »

The new flags for Lister plug-ins are now documented (2006 11 24).
User avatar
ghisler(Author)
Site Admin
Site Admin
Posts: 48083
Joined: 2003-02-04, 09:46 UTC
Location: Switzerland
Contact:

Post by *ghisler(Author) »

ListLoadNext instead of ListLoad
You are right, sorry for the mistake! The help file has been updated now.
Author of Total Commander
https://www.ghisler.com
Post Reply