Android Tutorial [B4X] B4A, B4i, B4J and B4r API documentation - B4X Object Browser

Status
Not open for further replies.
API documentation - B4a, B4i, B4J and B4R (i.e. B4X) Object Browser (which also includes Code Snippet Management)

Hi everyone,

As you may or may not be aware, I have embarked on a project to bring better documentation to us all.

The first problem I have had is that the official and semi-official documentation tools aren't what I was hoping for. Not saying they aren't good, they just aren't what I need.

My first thankyou was called the B4a Object Browser. This version was for B4Android only. It is my own version of the XML file loader. I call it the B4a Object Browser.

The second thankyou is an updated version that supports B4A, B4I and B4J. This is called the B4X Object Browser.

If you know the Visual Studio Object Browser, you should have a good idea of what I am trying to emulate.

To run it you must have .NET Framework 3.5 SP1 installed, and you must install it from my setup.

I have only tested it on Windows, and not with Mono.
I am assuming that everyone that wants to use it, will be on Windows.

Here are some screenshots:

B4AObjectBrowser3.1.4.0.png


upload_2014-12-18_21-26-19.png


Download the appropriate zip, unzip it and run the setup. I suggest you scan it for viruses before you run it of course.

B4A Object Browser:
When it runs the first time, it will need to know where the B4a Library XML files are, so ensure you go into the Options and configure them.
If you are upgrading, you can Import your old settings, and in fact are prompted to do so if you have a blank configuration.

If you are asked to find the B4A Library XML files, browse to your B4a Library folder (usually C:\Program Files\Anywhere Software\Basic4android\Libraries, or if you are using 64 bit Windows, it is C:\Program Files (x86)\Anywhere Software\Basic4android\Libraries)

From this point, it will remember the path, so you will not have to enter it again.

B4X Object Browser:
The paths to your B4A, B4I and B4J installations (and the Libraries folders under them) will be determined automatically.

In the Options screen you can set multiple paths, with the ability to modify them.

It has multi-language support, and will detect your PC's language and apply the changes automatically. If you want to over-ride this, you may do so from the Options screen.

In B4A Object Browser, the following languages are supported:

Afrikaans
Arabic
Bulgarian
Chinese
Czech
Danish
Dutch
English
French
German
Hebrew
Indonesian
Italian
Japanese
Norwegian
Persian
Polish
Portuguese
Romanian
Russian
Spanish
Swedish
Thai
Ukrainian
Vietnamese

B4X Object Browser adds support for:
Catalan
Greek


I suggest everyone that uses this tool subscribe to the thread so you are informed of changes.

Have fun!

Dave

Change history:
B4A Object Browser
2.0.0.0 - First public release.
2.0.1.0 - Minor GUI update, remove the need to click Reload button during initial setup.
2.1.0.0 - See post #8
2.2.0.0 - See post #23
2.3.0.0 - see post #31
2.3.0.0 - see post #35
2.4.0.0 - see post #60
2.5.0.0 - see post #63
2.6.0.0 - see post #70
2.6.1.0 - see post #75
2.7.0.0 - see post #79
3.0.0.0 - (Pre-release)
3.0.1.0 - Major GUI updates
3.0.1.1 - Minor fixes to correct some "Copy" functionality that had been removed
3.1.0.0 - All known bugs fixed, plus multiple language support added. Separate link provided below. See post 112 for full info.
3.1.1.0 - Additional languages, ability to override GUI language, Chinese language fixed. See post 122 for more info.
3.1.2.0 - Fixes to French, German and Italian language translations. 15 languages now provided. Search history added.
3.1.3.0 - Portuguese language added, making this language number 16
3.1.4.0 - Updated ru and ja translations, Moved Options to View menu, Added support for DesignerName attribute. See post 128 for full details.
3.1.5.0 - Corrected some logic problems around Version Number and DependsOn. Fixed URL Links. See post 147 for full details.
3.1.6.0 - Increased search options, fixed some search bugs, added Hebrew. Full details in post 156.
3.2.0.0 - AutoUpdate, new language, a couple of minor bugfixes. Full details in post 157.
3.2.1.0 - New languages, a few bugfixes. Full details in post 164.
3.2.2.0 - Updated Thai translation.
3.2.3.0 - Fixed further Thai translation strings, arabic and Thai language settings, memory corruption error when switching from R-L and L-R languages and more
3.2.4.0 - Added the ability to override language settings.* See "How to override language setting.txt" in the installation directory.
3.2.4.1 - Fixed bug when overriding language settings.
3.2.4.2 - Fixed bug when selecting the following languages: Arabic, Bulgarian, Hebrew, Thai
3.2.4.3 - Fixed bug when showing empty parentheses, Search and Clear Search buttons, bug where Clear Search button forced library reload even if no search text was entered
3.2.4.4 - Fixed bug where installer did not remove previous version
3.2.5.0 - Added ability to select viewing of Class_Globals and Property Get / Property Set
3.2.5.1 - Added ability to select viewing of DesignerCreateView
3.2.5.2 - Added Romanian language
3.2.5.3 - Fixed problem when selecting Romanian
3.2.5.4 - Fixed 2nd problem when selecting Romanian
3.2.5.5 - Added Vietnamese language
3.2.5.6 - Added preliminary support for B4a 3.0 (Beta)
3.2.5.7 - Added ability to show duplicate Library Short Names
3.2.5.8 - Forced GUI to always show Full type name when showing Class and Library annotations
3.2.5.9 - Fixed a bug when reloading libraries after performing a search. Also added Donate form.
3.2.5.10 - Set XML Reader to null after closing the file, plus set properties to remove flickering when displaying file data.
3.2.5.11 - Corrected an issue where a blank History would cause an application error
3.2.5.12 - Added Czech, Danish and Persian languages
3.2.5.13 - Persian language updated
3.2.5.14 - Added "Always on top" setting (under "Always on top" menu setting) and modified each Form to follow this setting
----------- Note: No further updates will be performed to B4a Object Browser

Full list of changes here (before 3.2.5.1): http://www.b4x.com/android/forum/th...n-b4a-object-browser.25682/page-9#post-172076

B4X Object Browser
1.0.0.0 - First public release
4.0.0.1 - Minor changes - mainly updating graphics to reflect Anywhere Software changes.
4.0.0.2 - Bug fixes, Desktop icon.
4.1.0.0 - Code Snippet Management added.
4.1.1.1 - Spanish language updates
4.1.1.2 - Modified the Method / Property / Field Copy function appropriately to copy either the selected text or all text
4.1.1.3 - Performed multiple bug-fixes to correct issues with right-click commands
4.1.1.4 - Performed another bug-fix to the right-click menu (for Events list)
4.1.1.5 - Performed another bug-fix to the right-click menu (for copying Fullname)
4.1.2.0 - Added support for B4R
4.1.3.0 - Changed auto-update download to .msi (instead of .exe)

I have put together a pdf to understand how to use it. It is included in the setup, but you can get it separately here (559 Kb).
Grab the setup and unzip and install it. This must be done this way because of the file size being too big for the forum. (>2 MB)...

B4a Object Browser
Version 3.2.0.0 (NOT AutoUpdate) is available here.
Version 3.2.1.0 (AutoUpdate enabled) is available here.
All newer versions (from Version 3.2.2.0 onwards) are available through AutoUpdate, and will not be provided here (other than the link below).
The latest version is always available from here.

B4X Object Browser
The latest B4x Version is available from here. AutoUpdate will take over from that point.
 

Attachments

  • upload_2014-12-11_22-32-46.png
    upload_2014-12-11_22-32-46.png
    106.1 KB · Views: 2,584
Last edited:

Victor Fung

Member
Licensed User
Hello, I am a new user. When trying to install de object browser, my Panda Free Antivirus says the file Setup.exe is infected. Could you please take a look. Thx.

Victor.
 

Vader

Well-Known Member
Licensed User
Longtime User
Sorry that you are getting this message, but I do not believe there is any issue.
 

rbirago

Active Member
Licensed User
Longtime User
Hi,
I've downloaded OB last version (4.1.1.5) and I noticed some misses. I was browsing RSVideoRecord library and noticed that OB doesn't expose some methods (i.e. setOutputFile). If I search for setOutputFile OB finds it, but if I browse the library it doesn't expose it. Perhaps because the method name starts with "set"?
best regards
Roberto
 

rbirago

Active Member
Licensed User
Longtime User
Find it! In OB there is an option to view/notview the set/get methods. Don't you think that should be better to expose always the get/set methods that don't belong to a property?
Roberto
 

Vader

Well-Known Member
Licensed User
Longtime User
Find it! In OB there is an option to view/notview the set/get methods. Don't you think that should be better to expose always the get/set methods that don't belong to a property?
Roberto
Well, it's up to you. You are the first person to raise this, and the option already exists.
 

inakigarm

Well-Known Member
Licensed User
Longtime User
Hi @Vader, are you considering to implement B4R as an option in B4X object Browser ?

(it would be a great addition..)
 

ardhuru

Member
Licensed User
Longtime User
Vader, I have been using B4A for the past 3 years, and I have to confess its been an uphill task. Whatever projects I completed, were thanks only to the immense help I received from some of the members on this forum.

Till I discovered the B4A Object Browser; I cant tell you how useful I have found it, its a gem, and thank you very much for making it available!

Best regards to you!!
 

inakigarm

Well-Known Member
Licensed User
Longtime User
@Vader , have you modified the B4X Object Browser to support B4R?
If I choose at first Post:

B4X Object Browser
B4x Version 4.0.0.0 is available from here. AutoUpdate will take over from that point.

the program version installed doesn't include B4R (and in the About windows it states version 1.0.0.0)

upload_2016-5-25_14-52-31.png


Thanks !
 

Attachments

  • upload_2016-5-25_14-51-48.png
    upload_2016-5-25_14-51-48.png
    232.3 KB · Views: 404

Vader

Well-Known Member
Licensed User
Longtime User
Apologies. I have updated the URL to point to the correct version.

I have also updated to support B4R
 

Vader

Well-Known Member
Licensed User
Longtime User
Vader, I have been using B4A for the past 3 years, and I have to confess its been an uphill task. Whatever projects I completed, were thanks only to the immense help I received from some of the members on this forum.

Till I discovered the B4A Object Browser; I cant tell you how useful I have found it, its a gem, and thank you very much for making it available!

Best regards to you!!
You are welcome. I hope you are using B4X Browser though. It is much more recent than B4A Browser.
 

ardhuru

Member
Licensed User
Longtime User
Wow, even better! Thanks for pointing it out, I was using the earlier B4A-only Browser.

My current interest was in UDP, and in the earlier B4A Browser I found an example snippet under Classes, Network, UDPSocket that got me going.

Unfortunately, I did not see that in the new version. Are such code examples deleted from other classes as well?

Anyway, for the time I'll keep both the versions.
 

Vader

Well-Known Member
Licensed User
Longtime User
Wow, even better! Thanks for pointing it out, I was using the earlier B4A-only Browser.

My current interest was in UDP, and in the earlier B4A Browser I found an example snippet under Classes, Network, UDPSocket that got me going.

Unfortunately, I did not see that in the new version. Are such code examples deleted from other classes as well?

Anyway, for the time I'll keep both the versions.

I don't discard any classes, methods, fields or properties.

upload_2016-5-26_19-54-47.png
 

Vader

Well-Known Member
Licensed User
Longtime User
When there is an existing snippet, this is shown by the big green arrow.
upload_2016-5-26_21-19-17.png


Select the snippet to view it.
upload_2016-5-26_21-23-0.png



upload_2016-5-26_21-23-36.png


You add a snippet with the green plus button
upload_2016-5-26_21-20-23.png


You delete a snippet with the red negative button

If you enable snippet drag and drop, and optionally set B4x Browser stay on top, you can drag text onto the add snippet button to add a snippet for the currently selected method / property or field.

upload_2016-5-26_21-30-29.png


I agree that this isn't a snippet manager, but I think it is still pretty good.
 
Status
Not open for further replies.
Top