Difference between revisions of "Libstatusbar"

From iPhone Development Wiki
Jump to: navigation, search
m
(How to use within a SpringBoard tweak: or, you know, instead of racing, just dlopen it)
Line 9: Line 9:
 
The readme explaining iOS 7.x support is viewable [https://github.com/phoenix3200/libstatusbar on the project page on Github].
 
The readme explaining iOS 7.x support is viewable [https://github.com/phoenix3200/libstatusbar on the project page on Github].
  
== How to use within a SpringBoard tweak ==
+
== How to use within a tweak ==
First download the [https://raw2.github.com/phoenix3200/libstatusbar/master/LSStatusBarItem.h LSStatusBarItem.h] header file. To compile it needs the following modification to the enum:
+
First download the [https://github.com/phoenix3200/libstatusbar/blob/master/LSStatusBarItem.h LSStatusBarItem.h] header file. To compile on modern toolchains, the first line must be edited to instead be the following:
  
typedef NS_ENUM(NSInteger, StatusBarAlignment)
+
<source lang="objc">
 +
typedef NS_ENUM(NSInteger, StatusBarAlignment)
 +
</source>
  
Create a singleton class in your tweak. In your tweak initializer, you need to call the shared singleton. Then, in its init method, perform a delayed init method by using:
+
Create a constructor function in your tweak. You need to first ensure libstatusbar is loaded, otherwise the following code most likely won’t work (depending on whether your tweak is loaded after libstatusbar by Substrate, and whether another tweak loaded before yours has already done this).
  
[self performSelector:@selector(delayedInit) withObject:nil afterDelay:0];
+
<source lang="objc">
 +
dlopen("/Library/MobileSubstrate/DynamicLibraries/libstatusbar.dylib", RTLD_LAZY);
 +
</source>
  
The reason for this is when your tweak is initialized into the SpringBoard, chances are libstatusbar.dylib, which contains the LSStatusBarItem, hasn't been loaded in yet, hence it would be null in the init method. So by delaying a run loop event, it will be loaded and the instance can be successfully created.
+
Use of dlopen() will require you to also <code>#include <dlfcn.h></code>.
  
-(void)delayedInit{
+
After this, you can proceed to create a status bar item. Here is an example:
  self.statusBarItem = [[NSClassFromString(@"LSStatusBarItem") alloc] initWithIdentifier: @"com.malcolmhall.InsomniaPro" alignment: StatusBarAlignmentRight];
+
 
  _statusBarItem.imageName = @"InsomniaPro";
+
<source lang="logos">
}
+
statusBarItem = [[%c(LSStatusBarItem) alloc] initWithIdentifier:@"com.malcolmhall.InsomniaPro" alignment:StatusBarAlignmentRight];
 +
statusBarItem.imageName = @"InsomniaPro";
 +
</source>
  
 
The imageName defines what image to look for. See below for naming conventions.
 
The imageName defines what image to look for. See below for naming conventions.
  
Then when you want to make the status bar item appear, do this:
+
The item will be visible by default. You can control this by setting the <code>visible</code> property:
self.statusBarItem.visible = YES;
+
 
 +
<source lang="objc">
 +
statusBarItem.visible = NO;
 +
</source>
 +
 
 +
The last thing you need to do is add a dependency on libstatusbar in your package’s control file. Obviously none of this will work if it’s not installed. That might look something like:
 +
 
 +
<source lang="text">
 +
Depends: mobilesubstrate, libstatusbar
 +
</source>
  
I would usually check a setting inside the delayedInit and show it the first time if necessary. The last thing you need to do is add a dependency on libstatusbar in your control file so that when your deb is installed it also installs the dependency so that the NSClassFromString can successfully find the LSStatusBarItem class.
+
It’s also worth noting that the libstatusbar API is usable from pretty much any process that has permission to do inter-process communication. This includes apps, daemons, and command line tools.
  
 
== Icon sizes ==
 
== Icon sizes ==

Revision as of 08:17, 29 April 2016

Libstatusbar
Cydia Package
Developer phoenix3200
Package ID libstatusbar
Latest Version 0.9.8-1


libstatusbar is a library supporting status bar modifications.

The readme explaining iOS 7.x support is viewable on the project page on Github.

How to use within a tweak

First download the LSStatusBarItem.h header file. To compile on modern toolchains, the first line must be edited to instead be the following:

typedef NS_ENUM(NSInteger, StatusBarAlignment)

Create a constructor function in your tweak. You need to first ensure libstatusbar is loaded, otherwise the following code most likely won’t work (depending on whether your tweak is loaded after libstatusbar by Substrate, and whether another tweak loaded before yours has already done this).

dlopen("/Library/MobileSubstrate/DynamicLibraries/libstatusbar.dylib", RTLD_LAZY);

Use of dlopen() will require you to also #include <dlfcn.h>.

After this, you can proceed to create a status bar item. Here is an example:

statusBarItem = [[%c(LSStatusBarItem) alloc] initWithIdentifier:@"com.malcolmhall.InsomniaPro" alignment:StatusBarAlignmentRight];
statusBarItem.imageName = @"InsomniaPro";

The imageName defines what image to look for. See below for naming conventions.

The item will be visible by default. You can control this by setting the visible property:

statusBarItem.visible = NO;

The last thing you need to do is add a dependency on libstatusbar in your package’s control file. Obviously none of this will work if it’s not installed. That might look something like:

Depends: mobilesubstrate, libstatusbar

It’s also worth noting that the libstatusbar API is usable from pretty much any process that has permission to do inter-process communication. This includes apps, daemons, and command line tools.

Icon sizes

You must provide 2x images, it will not fallback to 1x images on devices with retina screens.

My iOS 6 icon sizes were 12x20 for 1x and 20x40 for 2x

iOS 7 uses a height of 20 normal and 24 on the lock screen. Some example sizes from the built-in icons are:

Black_Airplane~iphone.png 12x20
Black_Airplane~iphone@2x.png 26x40
LockScreen_Airplane~iphone.png 14x24
LockScreen_Airplane~iphone@2x.png 28x48

Black_Alarm~iphone.png 9x20
Black_Alarm~iphone@2x.png 19x40
LockScreen_Alarm~iphone.png 11x24
LockScreen_Alarm~iphone@2x.png 27x48

Icon Locations and Naming

Check out https://github.com/phoenix3200/libstatusbar for info on where to put images for different devices, and how to name them.

Video Tutorials

To see a full tutorial on how to use this library in your tweak, check out this video by Sassoty