Permalink
Browse files

Added an english translation of the README.md file

  • Loading branch information...
1 parent 49b4d74 commit 4bc12661e781c5e1a5a568f72e2cf439ddb3a7ad @sendoa committed Jul 3, 2012
Showing with 65 additions and 16 deletions.
  1. +49 −0 LEEME.md
  2. +16 −16 README.md
View
@@ -0,0 +1,49 @@
+# QBKOverlaMenuView
+
+Se trata de un objeto `UIView` que trata de imitar el funcionamiento del control flotante que utiliza la aplicación [http://sparrowmailapp.com/iphone.php](Sparrow para iOS). El control aparece flotando en la parte inferior derecha de la pantalla y al ser pulsado despliega un menú de iconos hacia la izquierda.
+
+![El control en funcionamieto aunque sin la animación :-)](https://github.com/sendoa/QBKOverlayMenuView/raw/master/Docs/ejemplo.png)
+
+He programado este control **como un mero ejercicio**, así que no pretendía que fuese muy personalizable ni excesivamente flexible. Actualmente está diseñado para funcionar en posición *portrait* y se puede colocar tanto en la parte inferior derecha como en la parte superior de una vista —normalmente la vista principal. Además acepta un *offset* para permitir que no se solape con un posible `UITabBar`, `UINavigationBar` o similares.
+
+Su funcionamiento es muy sencillo. Tan solo hay que incluir el archivo *.h* donde nos interese utilizar el control y posteriormente instanciar e inicializarlo de la siguiente forma —suponiendo que estemos en un *view controller*:
+
+ QBKOverlayMenuView *qbkOverlayMenu = [[QBKOverlayMenuView alloc] initWithDelegate:self position:kQBKOverlayMenuViewPositionBottom];
+ [qbkOverlayMenu setParentView:[self view]];
+
+ [qbkOverlayMenu addButtonWithImage:[UIImage imageNamed:@"boton1.png"] index:0];
+ [qbkOverlayMenu addButtonWithImage:[UIImage imageNamed:@"boton2.png"] index:1];
+ [qbkOverlayMenu addButtonWithImage:[UIImage imageNamed:@"boton3.png"] index:2];
+ [qbkOverlayMenu addButtonWithImage:[UIImage imageNamed:@"boton4.png"] index:3];
+
+El método `setParentView:` indica cuál será el `UIView` en el que se alojará QBKOverlayMenuView. Lo normal es que sea la vista principal del view controller.
+
+## Posicionamiento
+
+Hay disponible dos constantes para indicar el posicionamiento del control:
+
+* `kQBKOverlayMenuViewPositionBottom`: el control se sitúa abajo a la derecha.
+* `kQBKOverlayMenuViewPositionTop`: el control se sitúa arriba a la derecha.
+
+## Desplazamiento / Offset
+
+Si necesitamos que el control aparezca desplazado con respecto a los límites —bounds— de la vista contenedora podemos hacer lo siguiente:
+
+ QBKOverlayMenuViewOffset offset;
+ offset.bottomOffset = 44;
+ offset.topOffset = 44;
+
+ QBKOverlayMenuView *qbkOverlayMenu = [[QBKOverlayMenuView alloc] initWithDelegate:self position:kQBKOverlayMenuViewPositionBottom offset:offset];
+
+## Agregar botones
+
+Tan solo tenemos que utilizar el método `addButtonWithImage:index:`. Posteriormente, cuando el botón sea pulsado, se mandará el mensaje `overlayMenuView:didActivateAdditionalButtonWithIndex:` con el `index` del botón pulsado al delegado indicado en el inicializador:
+
+ - (void)overlayMenuView:(QBKOverlayMenuView *)overlayMenuView didActivateAdditionalButtonWithIndex:(NSInteger)index
+ {
+ NSLog(@"Botón pulsado con índice: %d", index);
+ }
+
+## Gráficos
+
+Adjunto los gráficos que he creado tratando de imitar el aspecto de los utilizados por Sparrow, aunque en mi caso sólo he creado un icono de botón adicional en lugar del juego completo de iconos que ofrece Sparrow.
View
@@ -1,12 +1,12 @@
# QBKOverlaMenuView
-Se trata de un objeto `UIView` que trata de imitar el funcionamiento del control flotante que utiliza la aplicación [http://sparrowmailapp.com/iphone.php](Sparrow para iOS). El control aparece flotando en la parte inferior derecha de la pantalla y al ser pulsado despliega un menú de iconos hacia la izquierda.
+It's basically an `UIView` object that tries to mimic the behavior of the floating control used by [http://sparrowmailapp.com/iphone.php](Sparrow for iOS). The control appears at the bottom right corner of the screen and it unfolds a menu whenever it's touched.
-![El control en funcionamieto aunque sin la animación :-)](https://github.com/sendoa/QBKOverlayMenuView/raw/master/Docs/ejemplo.png)
+![Here you have the control working without the animation :-)](https://github.com/sendoa/QBKOverlayMenuView/raw/master/Docs/ejemplo.png)
-He programado este control **como un mero ejercicio**, así que no pretendía que fuese muy personalizable ni excesivamente flexible. Actualmente está diseñado para funcionar en posición *portrait* y se puede colocar tanto en la parte inferior derecha como en la parte superior de una vista —normalmente la vista principal. Además acepta un *offset* para permitir que no se solape con un posible `UITabBar`, `UINavigationBar` o similares.
+**Please, take in consideration that I've coded this control as a mrere excercise so the options are not too customizable nor the code is intended to be *final***. It's currently designed to work in *portrait* orientation and it can be positioned either at the bottom or at the top of the screen. You can add an *offset* to avoid overlapping with `UITabBar`, `UINavigationBar` or similar controls.
-Su funcionamiento es muy sencillo. Tan solo hay que incluir el archivo *.h* donde nos interese utilizar el control y posteriormente instanciar e inicializarlo de la siguiente forma —suponiendo que estemos en un *view controller*:
+To make it work, you only need to include the *.h* file wherever you intend to use the control and instantiate it this way —usually, from a *view controller*:
QBKOverlayMenuView *qbkOverlayMenu = [[QBKOverlayMenuView alloc] initWithDelegate:self position:kQBKOverlayMenuViewPositionBottom];
[qbkOverlayMenu setParentView:[self view]];
@@ -16,34 +16,34 @@ Su funcionamiento es muy sencillo. Tan solo hay que incluir el archivo *.h* dond
[qbkOverlayMenu addButtonWithImage:[UIImage imageNamed:@"boton3.png"] index:2];
[qbkOverlayMenu addButtonWithImage:[UIImage imageNamed:@"boton4.png"] index:3];
-El método `setParentView:` indica cuál será el `UIView` en el que se alojará QBKOverlayMenuView. Lo normal es que sea la vista principal del view controller.
+The `setParentView:` method indicates the view where QBKOverlayMenuView will be positioned —usually, the main view of the view controller.
-## Posicionamiento
+## Positioning
-Hay disponible dos constantes para indicar el posicionamiento del control:
+There are two constants available to indicate the positioning of the control:
-* `kQBKOverlayMenuViewPositionBottom`: el control se sitúa abajo a la derecha.
-* `kQBKOverlayMenuViewPositionTop`: el control se sitúa arriba a la derecha.
+* `kQBKOverlayMenuViewPositionBottom`: the control positions itself at bottom-right corner of the screen.
+* `kQBKOverlayMenuViewPositionTop`: the control positions itself at top-right corner of the screen.
-## Desplazamiento / Offset
+## Offset
-Si necesitamos que el control aparezca desplazado con respecto a los límites —bounds— de la vista contenedora podemos hacer lo siguiente:
+If you need the control to appear displaced from the bounds of the container view —usually not to overlap some kind of `UITabBar`, `UINavigationBar`…— you can do this:
QBKOverlayMenuViewOffset offset;
offset.bottomOffset = 44;
offset.topOffset = 44;
QBKOverlayMenuView *qbkOverlayMenu = [[QBKOverlayMenuView alloc] initWithDelegate:self position:kQBKOverlayMenuViewPositionBottom offset:offset];
-## Agregar botones
+## Adding buttons
-Tan solo tenemos que utilizar el método `addButtonWithImage:index:`. Posteriormente, cuando el botón sea pulsado, se mandará el mensaje `overlayMenuView:didActivateAdditionalButtonWithIndex:` con el `index` del botón pulsado al delegado indicado en el inicializador:
+You just have to make use of the `addButtonWithImage:index:` method. Then, when the button is touched, the message `overlayMenuView:didActivateAdditionalButtonWithIndex:` will be sent with the `index` of the touched button to the delegate specified in the *init* method.
- (void)overlayMenuView:(QBKOverlayMenuView *)overlayMenuView didActivateAdditionalButtonWithIndex:(NSInteger)index
{
- NSLog(@"Botón pulsado con índice: %d", index);
+ NSLog(@"Button touched with index: %d", index);
}
-## Gráficos
+## Graphics
-Adjunto los gráficos que he creado tratando de imitar el aspecto de los utilizados por Sparrow, aunque en mi caso sólo he creado un icono de botón adicional en lugar del juego completo de iconos que ofrece Sparrow.
+I've attached the graphics I created trying to mimic the aspect of those used by Sparrow. I've only created one additional icon instead of the whole set that Sparrow offers.

0 comments on commit 4bc1266

Please sign in to comment.